言語 API

ユニウェブの言語を操作できます。
API で利用している言語コードは、言語コードについてを参照ください。

備考

サイト翻訳機能をご契約の場合、翻訳言語はユニウェブの言語と同期されます。

uniweb.language.getLanguages()

ユニウェブウィジェットで利用可能な言語一覧を取得します。

レスポンス (getLanguages)

言語情報オブジェクトの配列を返します。

const languages = uniweb.language.getLanguages();

// レスポンスの例:
[
  {
    lang_code: 'es', // ISO 639-1 言語コードまたは BCP 47 言語タグ
    japanese_text: 'スペイン語', // 日本語での言語名
    english_text: 'Spanish', // 英語での言語名
    native_text: 'Español', // 現地語名
  },
  {
    lang_code: 'en',
    japanese_text: '英語',
    english_text: 'English',
    native_text: 'English',
  },
  // ...
];

uniweb.language.getCurrentLanguage()

ユニウェブウィジェットで選択中の言語を取得します。

レスポンス (getCurrentLanguage)

言語情報オブジェクトを返します。
利用可能でない言語が選択されている場合は、undefinedが返ります。

const currentLang = uniweb.language.getCurrentLanguage();
// レスポンスの例：
{
  lang_code: "es",            // ISO 639-1 言語コードまたは BCP 47 言語タグ
  japanese_text: "スペイン語",  // 日本語名
  english_text: "Spanish",    // 英語名
  native_text: "Español"      // 現地語名
}

uniweb.language.changeLanguage(lang_code)

ユニウェブウィジェットの言語を変更します。

changeLanguage(lang_code: string): void;

uniweb.language.resetLanguage()

ユニウェブウィジェットの言語をブラウザ設定言語にリセットします。

resetLanguage(): void;