nim-web-sdk-ng 0.12.2 → 0.13.0

package/dist/CHATROOM_BROWSER_SDK/ChatroomInterface.d.ts

@@ -43,6 +43,9 @@ export interface ChatroomInterface {
      * @locale
      *
      * @locale en
+     * Update the parameters for initialization and apply them after initialization is complete
+     *
+     * Note that the parameters will take effect on the next call to connect or reconnect.
      * @locale
      */
     setOptions(options: ChatroomInitializeOptions): void;
@@ -77,7 +80,7 @@ export interface ChatroomInterface {
  * eg . new sdk ( { ... ChatroomInitializeOptions })
  * @locale
  */
-export declare type ChatroomInitializeOptions = {
+export interface ChatroomInitializeOptions {
     account: string;
     /**
      * @Multi_Lang_Tag
@@ -98,7 +101,7 @@ export declare type ChatroomInitializeOptions = {
      * @locale
      *
      * @locale en
-     * chatroom id
+     * chatroom ID
      * @locale
      */
     chatroomId: string;
@@ -207,7 +210,7 @@ export declare type ChatroomInitializeOptions = {
      * @locale
      *
      * @locale en
-     * Login customization field, used for submitting to the user's third-party callback service for login authentication.
+     * Login custom field, used for submitting to the user's third-party callback service for login authentication.
      * @locale
      */
     loginExt?: string;
@@ -224,6 +227,13 @@ export declare type ChatroomInitializeOptions = {
      * @locale
      *
      * @locale en
+     * Whether deviceId is fixed, the default value is false.
+     *
+     * true：SDK randomly generates a device identifier and stores into the LocalStorage cache, all SDK instances are considered to be common devices for a browser.
+     *
+     * false：When each SDK instance is connected, the random string is used as a device identifier and different devices are used in each instance.
+     *
+     * Note: This parameter will affect the strategy of multi-device forced logout. For configurations about multi-device forced logout strategies, see the server documentation.
      * @locale
      */
     isFixedDeviceId?: boolean;
@@ -236,11 +246,14 @@ export declare type ChatroomInitializeOptions = {
      * @locale
      *
      * @locale en
+     * Whether Abtest is enabled. The default value is true
+     *
+     * Note: If you turn on the switch, the SDK attempts to enable certain new features. You are recommended not turn on it.
      * @locale
      */
     isAbtestEnable?: boolean;
-};
-export declare type ChatroomOtherOptions = {
+}
+export interface ChatroomOtherOptions {
     /**
      * @Multi_Lang_Tag
      * @locale cn
@@ -252,7 +265,7 @@ export declare type ChatroomOtherOptions = {
      * @locale
      */
     cloudStorageConfig?: NIMEModuleParamCloudStorageConfig;
-};
+}
 /**
  * @Multi_Lang_Tag
  * @locale cn
@@ -371,6 +384,10 @@ export interface ChatroomEventInterface {
      * @locale cn
      * 当前用户标签变更
      * @locale
+     *
+     * @locale en
+     * Tags of members change
+     * @locale
      */
     tagsUpdate: [currentTags: string[]];
 }

package/dist/CHATROOM_BROWSER_SDK/ChatroomMemberServiceInterface.d.ts

@@ -276,7 +276,7 @@ export declare type QueryMembersByTagOptions = {
      * @locale
      *
      * @locale en
-     * For paging, default value: 100.
+     * For pagination, default value: 100.
      * @locale
      */
     limit?: number;
@@ -458,7 +458,7 @@ export declare type QueryMembersOptions = {
      * @locale
      *
      * @locale en
-     * For paging; the default value is 100.
+     * For pagination; the default value is 100.
      * @locale
      */
     limit?: number;

package/dist/CHATROOM_BROWSER_SDK/ChatroomMsgServiceInterface.d.ts

@@ -7,7 +7,7 @@ export interface ChatroomMsgServiceInterface {
      * @locale
      *
      * @locale en
-     * Send text messages
+     * Send a text message
      * @locale
      */
     sendTextMsg(options: ISendTextMsgOptions): Promise<ChatroomMessage>;
@@ -20,7 +20,7 @@ export interface ChatroomMsgServiceInterface {
      * @locale
      *
      * @locale en
-     * Send notification messages
+     * Send an alert
      *
      * Notification messages refer to status notifications in conversations, such as the welcome message when a person joins a conversation and the prompt messages about sensitive words detection.
      * @locale
@@ -33,7 +33,7 @@ export interface ChatroomMsgServiceInterface {
      * @locale
      *
      * @locale en
-     * Send location messages
+     * Send an location message
      * @locale
      */
     sendGeoLocationMsg(options: ISendGeoLocationMsgOptions): Promise<ChatroomMessage>;
@@ -44,7 +44,7 @@ export interface ChatroomMsgServiceInterface {
      * @locale
      *
      * @locale en
-     * Send custom messages
+     * Send a custom message
      * @locale
      */
     sendCustomMsg(options: ISendCustomMsgOptions): Promise<ChatroomMessage>;
@@ -55,7 +55,7 @@ export interface ChatroomMsgServiceInterface {
      * @locale
      *
      * @locale en
-     * Send picture messages (uploading picture files supported)
+     * Send an image messages (uploading images supported)
      * @locale
      */
     sendImageMsg(options: IBaseSendFileOptions): Promise<ChatroomMessage>;
@@ -66,7 +66,7 @@ export interface ChatroomMsgServiceInterface {
      * @locale
      *
      * @locale en
-     * Send audio messages (uploading audio files supported)
+     * Send an audio message (uploading audios supported)
      * @locale
      */
     sendAudioMsg(options: IBaseSendFileOptions): Promise<ChatroomMessage>;
@@ -77,7 +77,7 @@ export interface ChatroomMsgServiceInterface {
      * @locale
      *
      * @locale en
-     * Send video messages (uploading video files supported)
+     * Send a video message (uploading videos supported)
      * @locale
      */
     sendVideoMsg(options: IBaseSendFileOptions): Promise<ChatroomMessage>;
@@ -88,7 +88,7 @@ export interface ChatroomMsgServiceInterface {
      * @locale
      *
      * @locale en
-     * Send other file messages (uploading other files supported)
+     * Send a file messages (uploading files supported)
      * @locale
      */
     sendFileMsg(options: IBaseSendFileOptions): Promise<ChatroomMessage>;
@@ -99,7 +99,7 @@ export interface ChatroomMsgServiceInterface {
      * @locale
      *
      * @locale en
-     * Query historical messages
+     * Query the message history
      * @locale
      */
     queryMessageHistory(options: QueryMessageHistoryOptions): Promise<ChatroomMessage[]>;
@@ -110,7 +110,7 @@ export interface ChatroomMsgServiceInterface {
      * @locale
      *
      * @locale en
-     * Query historical messages by tags
+     * Query message history by tag
      * @locale
      */
     getHistoryMsgsByTags(options: GetHistoryMsgsByTagsOptions): Promise<ChatroomMessage[]>;
@@ -127,6 +127,10 @@ export declare type GetHistoryMsgsByTagsOptions = {
      * @locale cn
      * 标签
      * @locale
+     *
+     * @locale en
+     * Tag
+     * @locale
      */
     tags: string[];
     /**
@@ -134,6 +138,10 @@ export declare type GetHistoryMsgsByTagsOptions = {
      * @locale cn
      * 消息类型
      * @locale
+     *
+     * @locale en
+     * Message type
+     * @locale
      */
     types?: TMsgType[];
     /**
@@ -141,6 +149,10 @@ export declare type GetHistoryMsgsByTagsOptions = {
      * @locale cn
      * 开始时间 默认 0
      * @locale
+     *
+     * @locale en
+     * Start time, the default value is 0.
+     * @locale
      */
     fromTime?: number;
     /**
@@ -148,6 +160,10 @@ export declare type GetHistoryMsgsByTagsOptions = {
      * @locale cn
      * 结束时间 默认服务器当前时间
      * @locale
+     *
+     * @locale en
+     * The end time, the current time on the server is used by default
+     * @locale
      */
     toTime?: number;
     /**
@@ -155,6 +171,10 @@ export declare type GetHistoryMsgsByTagsOptions = {
      * @locale cn
      * 数量限制，默认 100
      * @locale
+     *
+     * @locale en
+     * The limit, a maximum of 100 messages are allowed.
+     * @locale
      */
     limit?: number;
     /**
@@ -162,6 +182,10 @@ export declare type GetHistoryMsgsByTagsOptions = {
      * @locale cn
      * 是否反向 0（默认）: 正向， 1: 反向
      * @locale
+     *
+     * @locale en
+     * Whether a reverse query is allowed. 0(default): direct, 1: reverse
+     * @locale
      */
     reverse?: 0 | 1;
 };

package/dist/CHATROOM_BROWSER_SDK/ChatroomQueueInterface.d.ts

@@ -1,30 +1,79 @@
 export interface ChatroomQueueInterface {
     /**
+     * @Multi_Lang_Tag
+     * @locale cn
      * 初始化聊天室队列
+     * @locale
+     *
+     * @locale en
+     * initialize the chat room queue
+     * @locale
      */
     init(options: QueueInitOptions): Promise<void>;
     /**
+     * @Multi_Lang_Tag
+     * @locale cn
      * 加入或者更新队列元素
+     * @locale
+     *
+     * @locale en
+     * add or update the queue
+     * @locale
      */
     update(options: QueueUpdateOptions): Promise<void>;
     /**
+     * @Multi_Lang_Tag
+     * @locale cn
      * 取出聊天室队列指定/第一个元素
+     * @locale
+     *
+     * @locale en
+     * Get the specified or first element of the queue
+     * @locale
      */
     poll(options: QueuePollOptions): Promise<ChatroomQueue>;
     /**
+     * @Multi_Lang_Tag
+     * @locale cn
      * 批量更新聊天室队列元素
+     * @locale
+     *
+     * @locale en
+     * Update multiple elements in the queue at a time
+     * @locale
      */
     batchUpdate(options: QueueBatchUpdateOptions): Promise<ChatroomQueue[]>;
     /**
+     * @Multi_Lang_Tag
+     * @locale cn
      * 排序列出所有元素
+     * @locale
+     *
+     * @locale en
+     * sort all elements in a queue
+     * @locale
      */
     fetch(): Promise<ChatroomQueue[]>;
     /**
+     * @Multi_Lang_Tag
+     * @locale cn
      * 查看聊天室队列中的第一个元素
+     * @locale
+     *
+     * @locale en
+     * View the first element of the queue
+     * @locale
      */
     pickHeader(): Promise<ChatroomQueue>;
     /**
+     * @Multi_Lang_Tag
+     * @locale cn
      * 清空队列
+     * @locale
+     *
+     * @locale en
+     * clear queues
+     * @locale
      */
     clear(): Promise<void>;
 }
@@ -36,7 +85,7 @@ export declare type QueueInitOptions = {
      * @locale
      *
      * @locale en
-     *
+     * The limit of a new queue (0 ~ 1000). You can perform this operation for an existing queue to modify the length of the queue. If the current queue has exceeded the new limit, you cannot add more elements will not be added, but the existing elements cannot be removed.
      * @locale
      */
     maxItemCount: number;

package/dist/CHATROOM_BROWSER_SDK/CloudStorageServiceInterface.d.ts

@@ -18,7 +18,7 @@ export interface CloudStorageServiceInterface {
      * @locale
      *
      * @locale en
-     *
+     * convert a short link to a long link
      * @locale
      */
     getOriginUrl(options: string): Promise<string>;
@@ -28,7 +28,7 @@ export interface CloudStorageServiceInterface {
      * 获取文件鉴权的token
      * @locale
      * @locale en
-     * Get the token for the authorization of file access.
+     * Get the token for the authorization for file access.
      * @locale
      */
     getFileToken(options: GetFileTokenOptions): Promise<GetFileTokenResult | void>;
@@ -41,7 +41,7 @@ export declare type GetFileTokenOptions = {
      * @locale
      *
      * @locale en
-     *
+     * authentication type, 2: token-based authentication with a validity period, 3: URL-based authentication for access files
      * @locale
      */
     type: 2 | 3;
@@ -52,7 +52,7 @@ export declare type GetFileTokenOptions = {
      * @locale
      *
      * @locale en
-     *
+     * If type=3, an array of URLs is required
      * @locale
      */
     urls?: string[] | string;
@@ -65,7 +65,7 @@ export declare type GetFileTokenResult = {
      * @locale
      *
      * @locale en
-     *
+     * authentication type, 2: token-based authentication with a validity period, 3: URL-based authentication for access files
      * @locale
      */
     type: 2 | 3;
@@ -76,7 +76,7 @@ export declare type GetFileTokenResult = {
      * @locale
      *
      * @locale en
-     *
+     * For type 3, tokens associated with the array of URLs are returned
      * @locale
      */
     tokens?: string[];
@@ -87,7 +87,7 @@ export declare type GetFileTokenResult = {
      * @locale
      *
      * @locale en
-     *
+     * token-based authentication
      * @locale
      */
     token?: string;
@@ -98,7 +98,7 @@ export declare type GetFileTokenResult = {
      * @locale
      *
      * @locale en
-     *
+     * the validity period of a token
      * @locale
      */
     ttl: number;
@@ -111,6 +111,7 @@ export declare type NIMEModuleParamCloudStorageConfig = {
      * @locale
      *
      * @locale en
+     * Upload address (direct)
      * @locale
      */
     commonUploadHost?: string;
@@ -121,6 +122,7 @@ export declare type NIMEModuleParamCloudStorageConfig = {
      * @locale
      *
      * @locale en
+     * NOS upload address (chunks)
      * @locale
      */
     chunkUploadHost?: string;
@@ -131,6 +133,7 @@ export declare type NIMEModuleParamCloudStorageConfig = {
      * @locale
      *
      * @locale en
+     * Wildcard address of the file URL in the file message, for example: 'https://{host}/{object}'.
      * @locale
      */
     uploadReplaceFormat?: string;
@@ -143,6 +146,9 @@ export declare type NIMEModuleParamCloudStorageConfig = {
      * @locale
      *
      * @locale en
+     * The template for the URL of the received file of a file message
+     * If a file messages is received, the URL of a file is replaced with a specified patten for a secured download URL
+     * Example: 'https://{bucket}-nosdn.netease.im/{object}'
      * @locale
      */
     downloadUrl?: string;
@@ -153,6 +159,7 @@ export declare type NIMEModuleParamCloudStorageConfig = {
      * @locale
      *
      * @locale en
+     * The received addresses to be replaced with downloadUrl, for example: nos.netease.com/{bucket}/{obj}.
      * @locale
      */
     downloadHostList?: string[];
@@ -163,6 +170,7 @@ export declare type NIMEModuleParamCloudStorageConfig = {
      * @locale
      *
      * @locale en
+     * If the domain name issued by the server exists and the object prefix matches, it will be forcibly replaced with `${protocol}${serverCdnDomain}/${decodePath.slice(prefixIndex)}`
      * @locale
      */
     nosCdnEnable?: boolean;

package/dist/CHATROOM_BROWSER_SDK/index.d.ts

@@ -7,15 +7,36 @@ import { EventEmitter } from 'eventemitter3';
 export default class Chatroom extends EventEmitter<ChatroomEventInterface> implements ChatroomInterface {
     static instance: Chatroom | null;
     /**
+     * @Multi_Lang_Tag
+     * @locale cn
      * 实例的状态
+     * @locale
+     *
+     * @locale en
+     * The state of an instance
+     * @locale
      */
     status: NIMEChatroomInstanceStatus;
     /**
+     * @Multi_Lang_Tag
+     * @locale cn
      * 账号
+     * @locale
+     *
+     * @locale en
+     * Account
+     * @locale
      */
     account: string;
     /**
+     * @Multi_Lang_Tag
+     * @locale cn
      * 连接参数
+     * @locale
+     *
+     * @locale en
+     * Connection parameters
+     * @locale
      */
     options: ChatroomInitializeOptions;
     chatroom: ChatroomServiceInterface;
@@ -28,12 +49,27 @@ export default class Chatroom extends EventEmitter<ChatroomEventInterface> imple
     disconnect(): Promise<void>;
     destroy(): Promise<void>;
     /**
+     * @Multi_Lang_Tag
+     * @locale cn
      * 单例模式获取实例
+     * @locale
+     *
+     * @locale en
+     * Get an instance in singleton mode
+     * @locale
      */
     static getInstance(_options?: ChatroomInitializeOptions, _otherOptions?: ChatroomOtherOptions): Chatroom;
     /**
+     * @Multi_Lang_Tag
+     * @locale cn
      * 设置适配器
      * @param _newAdapters 适配器
+     * @locale
+     *
+     * @locale en
+     * Set an adapter
+     * @param _newAdapters adapter
+     * @locale
      */
     static setAdapters(_newAdapters: any): void;
 }