node-nim 9.16.10 → 9.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +58 -44
- package/dist/chatroom/chatroom.js +219 -0
- package/dist/chatroom/chatroom.js.map +1 -1
- package/dist/chatroom_def/chatroom_def.js +146 -73
- package/dist/chatroom_def/chatroom_def.js.map +1 -1
- package/dist/loader.js +1 -1
- package/dist/loader.js.map +1 -1
- package/dist/nim/client.js +1 -1
- package/dist/nim/client.js.map +1 -1
- package/dist/nim/data_sync.js.map +1 -1
- package/dist/nim/friend.js +9 -9
- package/dist/nim/friend.js.map +1 -1
- package/dist/nim/global.js.map +1 -1
- package/dist/nim/msglog.js +1 -1
- package/dist/nim/msglog.js.map +1 -1
- package/dist/nim/nos.js.map +1 -1
- package/dist/nim/online_session.js.map +1 -1
- package/dist/nim/pass_through_proxy.js +7 -7
- package/dist/nim/pass_through_proxy.js.map +1 -1
- package/dist/nim/plugin.js +3 -3
- package/dist/nim/plugin.js.map +1 -1
- package/dist/nim/session.js +49 -49
- package/dist/nim/session.js.map +1 -1
- package/dist/nim/subscribe_event.js +15 -15
- package/dist/nim/subscribe_event.js.map +1 -1
- package/dist/nim/super_team.js +63 -63
- package/dist/nim/super_team.js.map +1 -1
- package/dist/nim/sysmsg.js +14 -14
- package/dist/nim/sysmsg.js.map +1 -1
- package/dist/nim/talk.js +10 -10
- package/dist/nim/talk.js.map +1 -1
- package/dist/nim/talkex.js +27 -27
- package/dist/nim/talkex.js.map +1 -1
- package/dist/nim/team.js +86 -86
- package/dist/nim/team.js.map +1 -1
- package/dist/nim/tool.js.map +1 -1
- package/dist/nim/user.js +2 -2
- package/dist/nim/user.js.map +1 -1
- package/dist/nim_def/client_def.js +145 -118
- package/dist/nim_def/client_def.js.map +1 -1
- package/dist/nim_def/data_sync_def.js +18 -9
- package/dist/nim_def/data_sync_def.js.map +1 -1
- package/dist/nim_def/doc_trans_def.js +10 -5
- package/dist/nim_def/doc_trans_def.js.map +1 -1
- package/dist/nim_def/friend_def.js +28 -14
- package/dist/nim_def/friend_def.js.map +1 -1
- package/dist/nim_def/global_def.js +32 -16
- package/dist/nim_def/global_def.js.map +1 -1
- package/dist/nim_def/msglog_def.js +192 -116
- package/dist/nim_def/msglog_def.js.map +1 -1
- package/dist/nim_def/nos_def.js +12 -6
- package/dist/nim_def/nos_def.js.map +1 -1
- package/dist/nim_def/pass_through_proxy_def.js +5 -0
- package/dist/nim_def/pass_through_proxy_def.js.map +1 -1
- package/dist/nim_def/session_def.js +30 -15
- package/dist/nim_def/session_def.js.map +1 -1
- package/dist/nim_def/subscribe_event_def.js +32 -15
- package/dist/nim_def/subscribe_event_def.js.map +1 -1
- package/dist/nim_def/super_team_def.js +52 -27
- package/dist/nim_def/super_team_def.js.map +1 -1
- package/dist/nim_def/sysmsg_def.js +32 -17
- package/dist/nim_def/sysmsg_def.js.map +1 -1
- package/dist/nim_def/team_def.js +56 -29
- package/dist/nim_def/team_def.js.map +1 -1
- package/dist/nim_def/tool_def.js +8 -4
- package/dist/nim_def/tool_def.js.map +1 -1
- package/dist/nim_def/user_def.js +16 -8
- package/dist/nim_def/user_def.js.map +1 -1
- package/dist/node-nim.js +19 -0
- package/dist/node-nim.js.map +1 -1
- package/dist/qchat/attachment.js.map +1 -1
- package/dist/qchat/channel.js.map +1 -1
- package/dist/qchat/channel_category.js.map +1 -1
- package/dist/qchat/instance.js.map +1 -1
- package/dist/qchat/message.js.map +1 -1
- package/dist/qchat/role.js.map +1 -1
- package/dist/qchat/server.js.map +1 -1
- package/dist/qchat/system_notification.js.map +1 -1
- package/dist/qchat_def/public_def.js +8 -1
- package/dist/qchat_def/public_def.js.map +1 -1
- package/package.json +9 -6
- package/types/chatroom/chatroom.d.ts +219 -0
- package/types/chatroom_def/chatroom_def.d.ts +150 -74
- package/types/nim/client.d.ts +1 -1
- package/types/nim/friend.d.ts +9 -9
- package/types/nim/msglog.d.ts +1 -1
- package/types/nim/pass_through_proxy.d.ts +7 -7
- package/types/nim/plugin.d.ts +3 -3
- package/types/nim/session.d.ts +49 -49
- package/types/nim/subscribe_event.d.ts +15 -15
- package/types/nim/super_team.d.ts +63 -63
- package/types/nim/sysmsg.d.ts +14 -14
- package/types/nim/talk.d.ts +10 -10
- package/types/nim/talkex.d.ts +27 -27
- package/types/nim/team.d.ts +86 -86
- package/types/nim/user.d.ts +2 -2
- package/types/nim_def/client_def.d.ts +321 -126
- package/types/nim_def/data_sync_def.d.ts +18 -9
- package/types/nim_def/doc_trans_def.d.ts +10 -5
- package/types/nim_def/friend_def.d.ts +52 -26
- package/types/nim_def/global_def.d.ts +32 -16
- package/types/nim_def/msglog_def.d.ts +448 -218
- package/types/nim_def/nos_def.d.ts +62 -31
- package/types/nim_def/online_session_def.d.ts +21 -9
- package/types/nim_def/pass_through_proxy_def.d.ts +5 -0
- package/types/nim_def/session_def.d.ts +92 -46
- package/types/nim_def/subscribe_event_def.d.ts +75 -35
- package/types/nim_def/super_team_def.d.ts +74 -36
- package/types/nim_def/sysmsg_def.d.ts +78 -40
- package/types/nim_def/talk_def.d.ts +77 -20
- package/types/nim_def/talkex_def.d.ts +92 -46
- package/types/nim_def/team_def.d.ts +93 -39
- package/types/nim_def/tool_def.d.ts +16 -8
- package/types/nim_def/user_def.d.ts +52 -26
- package/types/node-nim.d.ts +19 -0
- package/types/qchat_def/public_def.d.ts +6 -0
- package/types/qchat_def/role_def.d.ts +3 -1
package/types/nim/client.d.ts
CHANGED
|
@@ -118,6 +118,6 @@ export declare class NIMClient extends EventEmitter<NIMClientEvents> {
|
|
|
118
118
|
getServerCurrentTime(cb: GetCurrentServerTimeCallback | null, calcLocal: boolean): Promise<[number, boolean, number]>;
|
|
119
119
|
/** 获取当前登录的用户账号(accid)
|
|
120
120
|
* @return string 当前登录的用户账号(accid)
|
|
121
|
-
* @note 没有登录时将返回空字符串
|
|
121
|
+
* @note 没有登录时将返回空字符串 */
|
|
122
122
|
getCurrentUserAccount(): string;
|
|
123
123
|
}
|
package/types/nim/friend.d.ts
CHANGED
|
@@ -11,10 +11,10 @@ export declare class NIMFriend extends EventEmitter<NIMFriendEvents> {
|
|
|
11
11
|
/** 注册全局回调 */
|
|
12
12
|
initEventHandlers(): void;
|
|
13
13
|
/** 添加、验证好友
|
|
14
|
-
* @param accid
|
|
14
|
+
* @param accid 对方帐号
|
|
15
15
|
* @param verify_type 好友验证类型
|
|
16
16
|
* @param msg 接口扩展字段
|
|
17
|
-
* @param cb
|
|
17
|
+
* @param cb 好友请求回调函数
|
|
18
18
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
19
19
|
* @return boolean 检查参数如果不符合要求则返回失败
|
|
20
20
|
* @note
|
|
@@ -26,9 +26,9 @@ export declare class NIMFriend extends EventEmitter<NIMFriendEvents> {
|
|
|
26
26
|
*/
|
|
27
27
|
request(accid: string, verify_type: NIMVerifyType, msg: string, cb: FriendOptCallback | null, jsonExtension: string): Promise<[NIMResCode] | null>;
|
|
28
28
|
/** 删除好友
|
|
29
|
-
* @param accid
|
|
29
|
+
* @param accid 对方帐号
|
|
30
30
|
* @param option 删除好友选项,目前仅有是否删除备注信息选项
|
|
31
|
-
* @param cb
|
|
31
|
+
* @param cb 删除好友回调函数
|
|
32
32
|
* @return boolean 检查参数如果不符合要求则返回失败
|
|
33
33
|
* @note
|
|
34
34
|
* <pre>
|
|
@@ -40,7 +40,7 @@ export declare class NIMFriend extends EventEmitter<NIMFriendEvents> {
|
|
|
40
40
|
delete(accid: string, option: DeleteFriendOption, cb: FriendOptCallback | null): Promise<[NIMResCode] | null>;
|
|
41
41
|
/** 更新好友资料
|
|
42
42
|
* @param profile 好友资料
|
|
43
|
-
* @param cb
|
|
43
|
+
* @param cb 更新好友资料回调函数
|
|
44
44
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
45
45
|
* @return boolean 检查参数如果不符合要求则返回失败
|
|
46
46
|
* @note
|
|
@@ -52,7 +52,7 @@ export declare class NIMFriend extends EventEmitter<NIMFriendEvents> {
|
|
|
52
52
|
*/
|
|
53
53
|
update(profile: FriendProfile, cb: FriendOptCallback | null, jsonExtension: string): Promise<[NIMResCode] | null>;
|
|
54
54
|
/** 增量获取好友列表
|
|
55
|
-
* @param cb
|
|
55
|
+
* @param cb 获取好友列表回调函数
|
|
56
56
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
57
57
|
* @return void 无返回值
|
|
58
58
|
* @note
|
|
@@ -62,15 +62,15 @@ export declare class NIMFriend extends EventEmitter<NIMFriendEvents> {
|
|
|
62
62
|
*/
|
|
63
63
|
getList(cb: GetFriendsListCallback | null, jsonExtension: string): Promise<[NIMResCode, Array<FriendProfile>]>;
|
|
64
64
|
/** 获取好友信息
|
|
65
|
-
* @param accid
|
|
66
|
-
* @param cb
|
|
65
|
+
* @param accid 对方帐号
|
|
66
|
+
* @param cb 获取好友信息回调函数
|
|
67
67
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
68
68
|
* @return void 无返回值
|
|
69
69
|
*/
|
|
70
70
|
getFriendProfile(accid: string, cb: GetFriendProfileCallback | null, jsonExtension: string): Promise<[string, FriendProfile]>;
|
|
71
71
|
/** 增量获取好友列表
|
|
72
72
|
* @param keyword 要查询的关键字
|
|
73
|
-
* @param cb
|
|
73
|
+
* @param cb 获取好友列表回调函数
|
|
74
74
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
75
75
|
* @return boolean 返回 true 表示发送查询请求成功,返回 false 表示关键字为空
|
|
76
76
|
* @note
|
package/types/nim/msglog.d.ts
CHANGED
|
@@ -411,7 +411,7 @@ export declare class NIMMsgLog extends EventEmitter<NIMMsgLogEvents> {
|
|
|
411
411
|
* <pre>
|
|
412
412
|
* 200:成功
|
|
413
413
|
* 414:参数错误
|
|
414
|
-
|
|
414
|
+
* </pre>
|
|
415
415
|
*/
|
|
416
416
|
queryMessagesByKeywordAsync(param: QueryMsgByKeywordParam, cb: QueryMsgCallback | null): Promise<[NIMResCode, string, NIMSessionType, QueryMsglogResult]>;
|
|
417
417
|
/**
|
|
@@ -11,13 +11,13 @@ export declare class NIMPassThroughProxy extends EventEmitter<NIMPassThroughProx
|
|
|
11
11
|
/** 注册全局回调 */
|
|
12
12
|
initEventHandlers(): void;
|
|
13
13
|
/** 发送一个透传 HTTP 请求
|
|
14
|
-
* @param host
|
|
15
|
-
* @param path
|
|
16
|
-
* @param method
|
|
17
|
-
* @param header
|
|
18
|
-
* @param body
|
|
19
|
-
* @param jsonExtension
|
|
20
|
-
* @param cb
|
|
14
|
+
* @param host 要发送的 HTTP 请求 Host 地址
|
|
15
|
+
* @param path URL 中除了 Host 的 Path
|
|
16
|
+
* @param method 要发送的 HTTP 请求方式
|
|
17
|
+
* @param header 要发送的 HTTP 请求 Header 内容
|
|
18
|
+
* @param body 要发送的 HTTP 请求 Body 内容
|
|
19
|
+
* @param jsonExtension 拓展字段,暂时无用
|
|
20
|
+
* @param cb 发送请求后的数据回调函数
|
|
21
21
|
* @return void 无返回值
|
|
22
22
|
*/
|
|
23
23
|
sendHttpRequest(host: string, path: string, method: NIMSendHttpRequestMethods, headers: string, body: string, jsonExtension: string, cb: SendHttpRequestCallback | null): Promise<[NIMResCode, string, string, string]>;
|
package/types/nim/plugin.d.ts
CHANGED
|
@@ -9,9 +9,9 @@ export declare class NIMPlugin extends EventEmitter<NIMPluginEvents> {
|
|
|
9
9
|
/** 注册全局回调 */
|
|
10
10
|
initEventHandlers(): void;
|
|
11
11
|
/** 异步获取聊天室登录信息
|
|
12
|
-
* @param roomId
|
|
13
|
-
* @param cb
|
|
14
|
-
* @param ext
|
|
12
|
+
* @param roomId 聊天室ID
|
|
13
|
+
* @param cb 回调函数
|
|
14
|
+
* @param ext json扩展参数(备用,目前不需要)
|
|
15
15
|
* @return void 无返回值
|
|
16
16
|
* @note
|
|
17
17
|
* <pre>
|
package/types/nim/session.d.ts
CHANGED
|
@@ -18,7 +18,7 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
|
|
|
18
18
|
/** 注册全局回调 */
|
|
19
19
|
initEventHandlers(): void;
|
|
20
20
|
/** 查询置顶会话列表
|
|
21
|
-
* @param cb
|
|
21
|
+
* @param cb 置顶会话列表查询结果的回调函数
|
|
22
22
|
* @return void 无返回值
|
|
23
23
|
* @note
|
|
24
24
|
* <pre>
|
|
@@ -27,10 +27,10 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
|
|
|
27
27
|
*/
|
|
28
28
|
queryStickTopSessionList(cb: QueryStickTopSessionListCallback | null): Promise<[NIMResCode, string]>;
|
|
29
29
|
/** 设置置顶会话
|
|
30
|
-
* @param session_id
|
|
31
|
-
* @param to_type
|
|
32
|
-
* @param ext
|
|
33
|
-
* @param cb
|
|
30
|
+
* @param session_id 会话id
|
|
31
|
+
* @param to_type 会话类型
|
|
32
|
+
* @param ext 扩展字段
|
|
33
|
+
* @param cb 置顶会话设置结果的回调函数
|
|
34
34
|
* @return void 无返回值
|
|
35
35
|
* @note
|
|
36
36
|
* <pre>
|
|
@@ -39,10 +39,10 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
|
|
|
39
39
|
*/
|
|
40
40
|
setToStickTopSession(session_id: string, to_type: number, ext: string, cb: SetToStickTopSessionCallback | null): Promise<[NIMResCode, string]>;
|
|
41
41
|
/** 更新置顶会话列表
|
|
42
|
-
* @param session_id
|
|
43
|
-
* @param to_type
|
|
44
|
-
* @param ext
|
|
45
|
-
* @param cb
|
|
42
|
+
* @param session_id 会话id
|
|
43
|
+
* @param to_type 会话类型
|
|
44
|
+
* @param ext 扩展字段
|
|
45
|
+
* @param cb 更新置顶会话设置结果的回调函数
|
|
46
46
|
* @return void 无返回值
|
|
47
47
|
* @note
|
|
48
48
|
* <pre>
|
|
@@ -51,9 +51,9 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
|
|
|
51
51
|
*/
|
|
52
52
|
updateToStickTopSession(session_id: string, to_type: number, ext: string, cb: UpdateStickTopSessionCallback | null): Promise<[NIMResCode, string]>;
|
|
53
53
|
/** 取消置顶会话列表
|
|
54
|
-
* @param session_id
|
|
55
|
-
* @param to_type
|
|
56
|
-
* @param cb
|
|
54
|
+
* @param session_id 会话id
|
|
55
|
+
* @param to_type 会话类型
|
|
56
|
+
* @param cb 取消置顶会话设置结果的回调函数
|
|
57
57
|
* @return void 无返回值
|
|
58
58
|
* @note
|
|
59
59
|
* <pre>
|
|
@@ -62,24 +62,24 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
|
|
|
62
62
|
*/
|
|
63
63
|
cancelToStickTopSession(session_id: string, to_type: number, cb: CancelToStickTopSessionCallback | null): Promise<[NIMResCode, string, NIMSessionType]>;
|
|
64
64
|
/** 查询指定数量的最后会话数据
|
|
65
|
-
* @param limit
|
|
66
|
-
* @param cb
|
|
65
|
+
* @param limit 要返回的最大数量
|
|
66
|
+
* @param cb 查询会话列表的回调函数
|
|
67
67
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
68
68
|
* @return void 无返回值
|
|
69
69
|
*/
|
|
70
70
|
queryLastFewSessionAsync(limit: number, cb: QuerySessionListCallback | null, jsonExtension: string): Promise<[NIMResCode, SessionDataList]>;
|
|
71
71
|
/** 查询会话列表,可指定最后一条会话消息要排除掉的类型(列表)
|
|
72
72
|
* @param msg_excluded_type_list 最后一条会话消息要排除掉的类型(列表),如果不排除任何消息,传入空列表
|
|
73
|
-
* @param cb
|
|
73
|
+
* @param cb 查询会话列表的回调函数
|
|
74
74
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
75
75
|
* @return void 无返回值
|
|
76
76
|
*/
|
|
77
77
|
queryAllRecentSessionAsync(msg_excluded_type_list: Array<NIMMessageType>, cb: QuerySessionListCallback | null, jsonExtension: string): Promise<[NIMResCode, SessionDataList]>;
|
|
78
78
|
/** 删除最近联系人
|
|
79
|
-
* @param to_type
|
|
80
|
-
* @param id
|
|
79
|
+
* @param to_type 会话类型,双人0,群组1 (nim_msglog_def.h)
|
|
80
|
+
* @param id 对方的account id或者群组tid。
|
|
81
81
|
* @param delete_roaming 是否同时删除漫游消息
|
|
82
|
-
* @param cb
|
|
82
|
+
* @param cb 最近会话列表项变更的回调函数
|
|
83
83
|
* @return boolean 检查参数如果不符合要求则返回失败
|
|
84
84
|
* @note
|
|
85
85
|
* <pre>
|
|
@@ -89,7 +89,7 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
|
|
|
89
89
|
deleteRecentSession(type: NIMSessionType, id: string, cb: SessionChangeCallback | null, delete_roaming: boolean): Promise<[NIMResCode, SessionData, number]>;
|
|
90
90
|
/** 删除全部最近联系人
|
|
91
91
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
92
|
-
* @param cb
|
|
92
|
+
* @param cb 最近会话列表项变更的回调函数
|
|
93
93
|
* @return void 无返回值
|
|
94
94
|
* @note
|
|
95
95
|
* <pre>
|
|
@@ -98,10 +98,10 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
|
|
|
98
98
|
*/
|
|
99
99
|
deleteAllRecentSession(cb: SessionChangeCallback | null, jsonExtension: string): Promise<[NIMResCode, SessionData, number]>;
|
|
100
100
|
/** 删除某会话的漫游消息
|
|
101
|
-
* @param to_type
|
|
102
|
-
* @param id
|
|
101
|
+
* @param to_type 会话类型,双人0,群组1 (nim_msglog_def.h)
|
|
102
|
+
* @param id 对方的account id或者群组tid。
|
|
103
103
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
104
|
-
* @param cb
|
|
104
|
+
* @param cb 删除结果 回调回调函数
|
|
105
105
|
* @return boolean 检查参数如果不符合要求则返回失败
|
|
106
106
|
* @note
|
|
107
107
|
* <pre>
|
|
@@ -110,10 +110,10 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
|
|
|
110
110
|
*/
|
|
111
111
|
deleteSessionRoamingMessage(to_type: number, session_id: string, cb: DeleteSessionRoamingMessageCallback | null, ext: string): Promise<[NIMResCode, number, string]>;
|
|
112
112
|
/** 最近联系人项未读数清零
|
|
113
|
-
* @param to_type
|
|
114
|
-
* @param id
|
|
113
|
+
* @param to_type 会话类型,双人0,群组1 (nim_msglog_def.h)
|
|
114
|
+
* @param id 对方的account id或者群组tid。
|
|
115
115
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
116
|
-
* @param cb
|
|
116
|
+
* @param cb 最近会话列表项变更的回调函数
|
|
117
117
|
* @return boolean 检查参数如果不符合要求则返回失败
|
|
118
118
|
* @note
|
|
119
119
|
* <pre>
|
|
@@ -122,9 +122,9 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
|
|
|
122
122
|
*/
|
|
123
123
|
setUnreadCountZeroAsync(type: NIMSessionType, id: string, cb: SessionChangeCallback | null, jsonExtension: string): Promise<[NIMResCode, SessionData, number] | null>;
|
|
124
124
|
/** 最近联系人项未读数清零
|
|
125
|
-
* @param is_super_team
|
|
126
|
-
* @param zero_list
|
|
127
|
-
* @param cb
|
|
125
|
+
* @param is_super_team 会话列表中的会话是否是超大群会话
|
|
126
|
+
* @param zero_list 清零的会话信息列表。
|
|
127
|
+
* @param cb 最近会话列表项变更的回调函数
|
|
128
128
|
* @return boolean 检查参数如果不符合要求则返回失败
|
|
129
129
|
* @note
|
|
130
130
|
* <pre>
|
|
@@ -133,10 +133,10 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
|
|
|
133
133
|
*/
|
|
134
134
|
setMultiUnreadCountZeroAsync(is_super_team: boolean, zero_list: Array<MultiUnreadCountZeroInfo>, cb: SetMultiUnreadCountZeroAsyncCallback | null): Promise<[NIMResCode, Array<SessionData>, number] | null>;
|
|
135
135
|
/** 设置会话项是否置顶(置顶属性只保存在本地)
|
|
136
|
-
* @param to_type
|
|
137
|
-
* @param id
|
|
138
|
-
* @param top
|
|
139
|
-
* @param cb
|
|
136
|
+
* @param to_type 会话类型
|
|
137
|
+
* @param id 对方的account id或者群组tid。
|
|
138
|
+
* @param top true - 置顶 false - 取消置顶
|
|
139
|
+
* @param cb 回调函数
|
|
140
140
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
141
141
|
* @return boolean 检查参数如果不符合要求则返回失败
|
|
142
142
|
* @note
|
|
@@ -146,10 +146,10 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
|
|
|
146
146
|
*/
|
|
147
147
|
setSessionTop(type: NIMSessionType, id: string, top: boolean, cb: SessionChangeCallback | null, jsonExtension: string): Promise<[NIMResCode, SessionData, number] | null>;
|
|
148
148
|
/** 设置会话项扩展数据(扩展数据只保存在本地)
|
|
149
|
-
* @param to_type
|
|
150
|
-
* @param id
|
|
151
|
-
* @param data
|
|
152
|
-
* @param cb
|
|
149
|
+
* @param to_type 会话类型
|
|
150
|
+
* @param id 对方的account id或者群组tid。
|
|
151
|
+
* @param data 扩展数据,建议使用灵活可扩展的数据结构,例如Json
|
|
152
|
+
* @param cb 回调函数
|
|
153
153
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
154
154
|
* @return boolean 检查参数如果不符合要求则返回失败
|
|
155
155
|
* @note
|
|
@@ -160,7 +160,7 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
|
|
|
160
160
|
setSessionExtendData(type: NIMSessionType, id: string, data: string, cb: SessionChangeCallback | null, jsonExtension: string): Promise<[NIMResCode, SessionData, number] | null>;
|
|
161
161
|
/** 最近联系人项全部未读数清零
|
|
162
162
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
163
|
-
* @param cb
|
|
163
|
+
* @param cb 最近会话列表项变更的回调函数
|
|
164
164
|
* @return boolean 检查参数如果不符合要求则返回失败
|
|
165
165
|
* @note
|
|
166
166
|
* <pre>
|
|
@@ -169,9 +169,9 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
|
|
|
169
169
|
*/
|
|
170
170
|
setAllUnreadCountZeroAsync(cb: SessionChangeCallback | null, jsonExtension: string): Promise<[NIMResCode, SessionData, number] | null>;
|
|
171
171
|
/** 根据给定的id查询相应会话的信息
|
|
172
|
-
* @param to_type
|
|
173
|
-
* @param id
|
|
174
|
-
* @param cb
|
|
172
|
+
* @param to_type 会话类型
|
|
173
|
+
* @param id 对方的account id或者群组tid。
|
|
174
|
+
* @param cb 会话信息查询结果的回调函数
|
|
175
175
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
176
176
|
* @return void 无返回值
|
|
177
177
|
* @note
|
|
@@ -181,9 +181,9 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
|
|
|
181
181
|
*/
|
|
182
182
|
querySessionDataById(type: NIMSessionType, id: string, cb: QuerySessionDataCallback | null, jsonExtension: string): Promise<[NIMResCode, SessionData]>;
|
|
183
183
|
/** 查询会话是漫游消息未拉取信息
|
|
184
|
-
* @param session_id
|
|
185
|
-
* @param to_type
|
|
186
|
-
* @param cb
|
|
184
|
+
* @param session_id 会话id
|
|
185
|
+
* @param to_type 会话类型
|
|
186
|
+
* @param cb 查询会话是漫游消息未拉取信息回调函数
|
|
187
187
|
* @return void 无返回值
|
|
188
188
|
* @note
|
|
189
189
|
* <pre>
|
|
@@ -192,20 +192,20 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
|
|
|
192
192
|
*/
|
|
193
193
|
queryHasmoreRoammsg(session_id: string, to_type: number, cb: QueryHasmoreRoammsgCallback | null): Promise<[NIMResCode, SessionRoamMsgHasMoreTagInfo]>;
|
|
194
194
|
/** 查询所有漫游消息未拉取完全的会话
|
|
195
|
-
* @param cb
|
|
195
|
+
* @param cb 结果回调
|
|
196
196
|
* @return void 无返回值
|
|
197
197
|
*/
|
|
198
198
|
queryAllHasmoreRoammsg(cb: QueryAllHasmoreRoammsgCallback | null): Promise<[NIMResCode, Array<SessionRoamMsgHasMoreTagInfo>]>;
|
|
199
199
|
/** 更新会话是漫游消息未拉取信息
|
|
200
|
-
* @param msg
|
|
201
|
-
* @param cb
|
|
200
|
+
* @param msg 对应的消息内容
|
|
201
|
+
* @param cb 结果回调
|
|
202
202
|
* @return void 无返回值
|
|
203
203
|
*/
|
|
204
204
|
updateHasmoreRoammsg(msg: IMMessage, cb: UpdateHasmoreRoammsgCallback | null): Promise<[NIMResCode]>;
|
|
205
205
|
/** 删除会话是漫游消息未拉取信息
|
|
206
|
-
* @param session_id
|
|
207
|
-
* @param to_type
|
|
208
|
-
* @param cb
|
|
206
|
+
* @param session_id 会话id
|
|
207
|
+
* @param to_type 会话类型
|
|
208
|
+
* @param cb 结果回调
|
|
209
209
|
* @return void 无返回值
|
|
210
210
|
*/
|
|
211
211
|
deleteHasmoreRoammsg(session_id: string, to_type: NIMSessionType, cb: DeleteHasmoreRoammsgCallback | null): Promise<[NIMResCode]>;
|
|
@@ -13,8 +13,8 @@ export declare class NIMSubscribeEvent extends EventEmitter<NIMSubscribeEventEve
|
|
|
13
13
|
/** 注册全局回调 */
|
|
14
14
|
initEventHandlers(): void;
|
|
15
15
|
/** 发布事件
|
|
16
|
-
* @param event_data
|
|
17
|
-
* @param cb
|
|
16
|
+
* @param event_data 事件
|
|
17
|
+
* @param cb 发布事件回调函数
|
|
18
18
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
19
19
|
* @return boolean 检查参数如果不符合要求则返回失败
|
|
20
20
|
* @note
|
|
@@ -28,11 +28,11 @@ export declare class NIMSubscribeEvent extends EventEmitter<NIMSubscribeEventEve
|
|
|
28
28
|
*/
|
|
29
29
|
publish(data: EventData, cb: PublishEventCallback | null, jsonExtension: string): Promise<[NIMResCode, number, EventData] | null>;
|
|
30
30
|
/** 订阅事件
|
|
31
|
-
* @param event_type
|
|
32
|
-
* @param ttl
|
|
33
|
-
* @param sync_type
|
|
34
|
-
* @param accid_list
|
|
35
|
-
* @param cb
|
|
31
|
+
* @param event_type 事件类型
|
|
32
|
+
* @param ttl 订阅有效期,单位:秒,范围:60s到30天
|
|
33
|
+
* @param sync_type 订阅后是否立即同步最新事件
|
|
34
|
+
* @param accid_list 要订阅的用户列表
|
|
35
|
+
* @param cb 订阅事件回调函数
|
|
36
36
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
37
37
|
* @return boolean 检查参数如果不符合要求则返回失败
|
|
38
38
|
* @note
|
|
@@ -44,9 +44,9 @@ export declare class NIMSubscribeEvent extends EventEmitter<NIMSubscribeEventEve
|
|
|
44
44
|
*/
|
|
45
45
|
subscribe(eventType: NIMEventType, ttl: number, syncType: NIMEventSubscribeSyncEventType, accids: Array<string>, cb: SubscribeEventCallback | null, jsonExtension: string): Promise<[NIMResCode, number, Array<string>] | null>;
|
|
46
46
|
/** 按账号取消指定事件的订阅关系
|
|
47
|
-
* @param event_type
|
|
48
|
-
* @param accid_list
|
|
49
|
-
* @param cb
|
|
47
|
+
* @param event_type 事件类型
|
|
48
|
+
* @param accid_list 要取消订阅的用户列表
|
|
49
|
+
* @param cb 取消订阅事件回调函数
|
|
50
50
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
51
51
|
* @return boolean 检查参数如果不符合要求则返回失败
|
|
52
52
|
* @note
|
|
@@ -58,8 +58,8 @@ export declare class NIMSubscribeEvent extends EventEmitter<NIMSubscribeEventEve
|
|
|
58
58
|
*/
|
|
59
59
|
unSubscribe(eventType: NIMEventType, accids: Array<string>, cb: UnSubscribeEventCallback | null, jsonExtension: string): Promise<[NIMResCode, number, Array<string>] | null>;
|
|
60
60
|
/** 取消指定事件的全部订阅关系
|
|
61
|
-
* @param event_type
|
|
62
|
-
* @param cb
|
|
61
|
+
* @param event_type 事件类型
|
|
62
|
+
* @param cb 取消订阅事件回调函数
|
|
63
63
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
64
64
|
* @return boolean 检查参数如果不符合要求则返回失败
|
|
65
65
|
* @note
|
|
@@ -71,9 +71,9 @@ export declare class NIMSubscribeEvent extends EventEmitter<NIMSubscribeEventEve
|
|
|
71
71
|
*/
|
|
72
72
|
batchUnSubscribe(eventType: NIMEventType, cb: BatchUnSubscribeEventCallback | null, jsonExtension: string): Promise<[NIMResCode, number] | null>;
|
|
73
73
|
/** 按账号查询指定事件订阅关系
|
|
74
|
-
* @param event_type
|
|
75
|
-
* @param accid_list
|
|
76
|
-
* @param cb
|
|
74
|
+
* @param event_type 事件类型
|
|
75
|
+
* @param accid_list 要查询订阅关系的用户列表
|
|
76
|
+
* @param cb 查询订阅关系回调函数
|
|
77
77
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
78
78
|
* @return boolean 检查参数如果不符合要求则返回失败
|
|
79
79
|
* @note
|