i18n.js

  1. /**
  2.  * @namespace ZoomMtg.i18n
  3.  * @version WebSDK2.7.0
  4.  */
  6. /**
  7.  * @memberof ZoomMtg.i18n
  8.  * @instance
  9.  * @param {Object} params
  10.  */
  13. /**
  14.  * Load translations.
  15.  * @method load
  16.  * @memberof ZoomMtg.i18n
  17.  * @instance
  18.  * @param {string} url - translation json file url LanguageResource
  19.  * @param {languages} lang - language name, could be office supported or assigned by customer
  20.  * @example
  22.   // load zoom support language  ['de-DE', 'es-ES', 'en-US', 'fr-FR', 'jp-JP', 'pt-PT','ru-RU', 'zh-CN', 'zh-TW', 'ko-KO', 'it-IT', 'vi-VN']
  23.   ZoomMtg.i18n.load('en-US');
  24.   ZoomMtg.i18n.load('jp-JP');
  25.   ZoomMtg.i18n.load('zh-CN');
  27.   // load you self language
  28.   ZoomMtg.i18n.load('you json path', "yourlang");
  30.  *
  31.  */
  34. /**
  35.  * Change translations resource. Set a supported language when Joining a meeting.
  36.  * @method reload
  37.  * @memberof ZoomMtg.i18n
  38.  * @instance
  39.  * @param {languages} lang - change to targeted lang. first you need to use load func load translation resource
  40.  * @example
  41.  * ZoomMtg.i18n.reload("jp-JP");
  42.  * ZoomMtg.i18n.reload("yourlang");
  43.  */
  46. /**
  47.  * Looks the given string up in the dictionary and returns the translation if
  48.  * one exists. If a translation is not found, returns the original word.
  49.  * @memberof ZoomMtg.i18n
  50.  * @method get
  51.  * @instance
  52.  * @param {language-key-value} str - The key to translate, it's also get customer's key which loaded.
  53.  * @param {string} [args] - the string formate arguments. this args will pass to printf
  54.  * @return {string} Translated word.
  55.  * @example
  56.  * ZoomMtg.i18n.get('apac.toolbar_leave')
  57.  */
  62. /**
  63.  * get current language resource result
  64.  * @method getAll
  65.  * @memberof ZoomMtg.i18n
  66.  * @instance
  67.  * @param {languages} lang language key
  68.  * @return {Object} language resource result
  69.  * @example
  70.  *
  71.   //get english language translation resource object
  72.  * ZoomMtg.i18n.getAll("en-US");
  73.  *
  74. //get japeniese language translation resource object
  75.  * ZoomMtg.i18n.getAll("jp-JP");
  76.  */
  79.  /**
  80.  * get current language resource result
  81.  * @method getCurrentLang
  82.  * @memberof ZoomMtg.i18n
  83.  * @instance
  84.  * @return {string} get current language
  85.  */
  87.  /**
  88.  * get support language array<string>
  89.  * @method getSupportLanguage
  90.  * @memberof ZoomMtg.i18n
  91.  * @instance
  92.  * @return {Array} default ['de-DE', 'es-ES', 'en-US', 'fr-FR', 'jp-JP', 'pt-PT', 'ru-RU', 'zh-CN', 'zh-TW', 'ko-KO', 'vi-VN', 'it-IT']
  93.  */
  95. /**
  96.  * get current language resource result
  97.  * @method setSupportLanguage
  98.  * @memberof ZoomMtg.i18n
  99.  * @param {Array} langArray  you want support languages array, will replace default ['de-DE', 'es-ES', 'en-US', 'fr-FR', 'jp-JP', 'pt-PT', 'ru-RU', 'zh-CN', 'zh-TW', 'ko-KO', 'vi-VN', 'it-IT']
  100.  * @instance
  101.  * @example
  102.  *  ZoomMtg.setZoomJSLib('you_path', '/av');
  103.  *  ZoomMtg.i18n.setSupportLanguage(['zh-CN', 'zh-TW', 'en-US']); // only use specific languages.
  104.  *  ZoomMtg.i18n.load('zh-CN'); // load from https://you_path/lang/zh-CN.json
  105.  *  ZoomMtg.i18n.getSupportLanguage(); // get ['zh-CN', 'zh-TW', 'en-US']
  106.  */