node-nim 9.2.8-rc.1 → 9.3.0-rc.2
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 +74 -39
- package/dist/chatroom/chatroom.js +253 -0
- package/dist/chatroom/chatroom.js.map +1 -0
- package/dist/chatroom_def/chatroom_def.js +120 -0
- package/dist/chatroom_def/chatroom_def.js.map +1 -0
- package/{js → dist}/loader.js +0 -0
- package/{js → dist}/loader.js.map +0 -0
- package/{js/api → dist/nim}/client.js +46 -8
- package/dist/nim/client.js.map +1 -0
- package/{js/api → dist/nim}/data_sync.js +2 -2
- package/dist/nim/data_sync.js.map +1 -0
- package/{js/api → dist/nim}/friend.js +62 -12
- package/dist/nim/friend.js.map +1 -0
- package/{js/api → dist/nim}/global.js +50 -8
- package/dist/nim/global.js.map +1 -0
- package/{js/api → dist/nim}/msglog.js +271 -52
- package/dist/nim/msglog.js.map +1 -0
- package/{js/api → dist/nim}/nos.js +54 -13
- package/dist/nim/nos.js.map +1 -0
- package/{js/api → dist/nim}/online_session.js +34 -6
- package/dist/nim/online_session.js.map +1 -0
- package/{js/api → dist/nim}/pass_through_proxy.js +10 -3
- package/dist/nim/pass_through_proxy.js.map +1 -0
- package/{js/api → dist/nim}/plugin.js +18 -4
- package/dist/nim/plugin.js.map +1 -0
- package/{js/api → dist/nim}/session.js +171 -28
- package/dist/nim/session.js.map +1 -0
- package/{js/api → dist/nim}/subscribe_event.js +53 -12
- package/dist/nim/subscribe_event.js.map +1 -0
- package/{js/api → dist/nim}/super_team.js +253 -47
- package/dist/nim/super_team.js.map +1 -0
- package/{js/api → dist/nim}/sysmsg.js +80 -12
- package/dist/nim/sysmsg.js.map +1 -0
- package/{js/api → dist/nim}/talk.js +10 -3
- package/dist/nim/talk.js.map +1 -0
- package/dist/nim/talkex.js +192 -0
- package/dist/nim/talkex.js.map +1 -0
- package/{js/api → dist/nim}/team.js +363 -87
- package/dist/nim/team.js.map +1 -0
- package/{js/api → dist/nim}/tool.js +21 -5
- package/dist/nim/tool.js.map +1 -0
- package/{js/api → dist/nim}/user.js +84 -16
- package/dist/nim/user.js.map +1 -0
- package/{js/def → dist/nim_def}/client_def.js +0 -0
- package/dist/nim_def/client_def.js.map +1 -0
- package/{js/def → dist/nim_def}/data_sync_def.js +0 -0
- package/dist/nim_def/data_sync_def.js.map +1 -0
- package/{js/def → dist/nim_def}/doc_trans_def.js +0 -0
- package/dist/nim_def/doc_trans_def.js.map +1 -0
- package/{js/def → dist/nim_def}/friend_def.js +0 -0
- package/dist/nim_def/friend_def.js.map +1 -0
- package/{js/def → dist/nim_def}/global_def.js +0 -0
- package/dist/nim_def/global_def.js.map +1 -0
- package/{js/def → dist/nim_def}/msglog_def.js +1 -1
- package/dist/nim_def/msglog_def.js.map +1 -0
- package/{js/def → dist/nim_def}/nos_def.js +0 -0
- package/dist/nim_def/nos_def.js.map +1 -0
- package/{js/def → dist/nim_def}/online_session_def.js +0 -0
- package/dist/nim_def/online_session_def.js.map +1 -0
- package/{js/def → dist/nim_def}/pass_through_proxy_def.js +0 -0
- package/dist/nim_def/pass_through_proxy_def.js.map +1 -0
- package/{js/def → dist/nim_def}/plugin_def.js +0 -0
- package/{js/def → dist/nim_def}/plugin_def.js.map +1 -1
- package/{js/def → dist/nim_def}/session_def.js +0 -0
- package/dist/nim_def/session_def.js.map +1 -0
- package/{js/def → dist/nim_def}/subscribe_event_def.js +0 -0
- package/dist/nim_def/subscribe_event_def.js.map +1 -0
- package/{js/def → dist/nim_def}/super_team_def.js +0 -0
- package/dist/nim_def/super_team_def.js.map +1 -0
- package/{js/def → dist/nim_def}/sysmsg_def.js +0 -0
- package/dist/nim_def/sysmsg_def.js.map +1 -0
- package/{js/def → dist/nim_def}/talk_def.js +0 -0
- package/{js/def → dist/nim_def}/talk_def.js.map +1 -1
- package/{js/def → dist/nim_def}/talkex_def.js +0 -0
- package/{js/def → dist/nim_def}/talkex_def.js.map +1 -1
- package/{js/def → dist/nim_def}/team_def.js +0 -0
- package/dist/nim_def/team_def.js.map +1 -0
- package/{js/def → dist/nim_def}/tool_def.js +0 -0
- package/dist/nim_def/tool_def.js.map +1 -0
- package/{js/def → dist/nim_def}/user_def.js +0 -0
- package/dist/nim_def/user_def.js.map +1 -0
- package/dist/node-nim.js +98 -0
- package/dist/node-nim.js.map +1 -0
- package/dist/qchat/attachment.js +75 -0
- package/dist/qchat/attachment.js.map +1 -0
- package/dist/qchat/channel.js +402 -0
- package/dist/qchat/channel.js.map +1 -0
- package/dist/qchat/channel_category.js +249 -0
- package/dist/qchat/channel_category.js.map +1 -0
- package/dist/qchat/instance.js +94 -0
- package/dist/qchat/instance.js.map +1 -0
- package/dist/qchat/message.js +325 -0
- package/dist/qchat/message.js.map +1 -0
- package/dist/qchat/role.js +562 -0
- package/dist/qchat/role.js.map +1 -0
- package/dist/qchat/server.js +515 -0
- package/dist/qchat/server.js.map +1 -0
- package/dist/qchat/system_notification.js +96 -0
- package/dist/qchat/system_notification.js.map +1 -0
- package/dist/qchat_def/attachment_def.js +3 -0
- package/dist/qchat_def/attachment_def.js.map +1 -0
- package/dist/qchat_def/channel_def.js +3 -0
- package/dist/qchat_def/channel_def.js.map +1 -0
- package/dist/qchat_def/instance_def.js +3 -0
- package/dist/qchat_def/instance_def.js.map +1 -0
- package/dist/qchat_def/message_def.js +3 -0
- package/dist/qchat_def/message_def.js.map +1 -0
- package/dist/qchat_def/public_def.js +584 -0
- package/dist/qchat_def/public_def.js.map +1 -0
- package/dist/qchat_def/role_def.js +3 -0
- package/dist/qchat_def/role_def.js.map +1 -0
- package/dist/qchat_def/server_def.js +3 -0
- package/dist/qchat_def/server_def.js.map +1 -0
- package/dist/qchat_def/system_notification_def.js +3 -0
- package/dist/qchat_def/system_notification_def.js.map +1 -0
- package/package.json +7 -6
- package/script/download-sdk.mjs +17 -16
- package/types/chatroom/chatroom.d.ts +54 -0
- package/types/chatroom_def/chatroom_def.d.ts +419 -0
- package/types/{api → nim}/client.d.ts +22 -23
- package/types/nim/data_sync.d.ts +12 -0
- package/types/{api → nim}/friend.d.ts +17 -17
- package/types/{api → nim}/global.d.ts +13 -13
- package/types/{api → nim}/msglog.d.ts +62 -62
- package/types/{api → nim}/nos.d.ts +21 -21
- package/types/{api → nim}/online_session.d.ts +12 -12
- package/types/{api → nim}/pass_through_proxy.d.ts +8 -8
- package/types/{api → nim}/plugin.d.ts +8 -6
- package/types/{api → nim}/session.d.ts +40 -40
- package/types/{api → nim}/subscribe_event.d.ts +19 -19
- package/types/{api → nim}/super_team.d.ts +51 -52
- package/types/{api → nim}/sysmsg.d.ts +20 -20
- package/types/{api → nim}/talk.d.ts +19 -19
- package/types/{api → nim}/talkex.d.ts +29 -27
- package/types/{api → nim}/team.d.ts +89 -88
- package/types/{api → nim}/tool.d.ts +9 -7
- package/types/{api → nim}/user.d.ts +23 -23
- package/types/{def → nim_def}/client_def.d.ts +86 -86
- package/types/{def → nim_def}/data_sync_def.d.ts +0 -0
- package/types/{def → nim_def}/doc_trans_def.d.ts +0 -0
- package/types/{def → nim_def}/friend_def.d.ts +17 -16
- package/types/{def → nim_def}/global_def.d.ts +14 -13
- package/types/{def → nim_def}/msglog_def.d.ts +152 -141
- package/types/nim_def/nos_def.d.ts +72 -0
- package/types/{def → nim_def}/online_session_def.d.ts +15 -15
- package/types/{def → nim_def}/pass_through_proxy_def.d.ts +2 -1
- package/types/{def → nim_def}/plugin_def.d.ts +3 -2
- package/types/{def → nim_def}/session_def.d.ts +49 -48
- package/types/nim_def/subscribe_event_def.d.ts +83 -0
- package/types/{def → nim_def}/super_team_def.d.ts +34 -34
- package/types/{def → nim_def}/sysmsg_def.d.ts +25 -25
- package/types/{def → nim_def}/talk_def.d.ts +24 -24
- package/types/nim_def/talkex_def.d.ts +112 -0
- package/types/{def → nim_def}/team_def.d.ts +37 -37
- package/types/{def → nim_def}/tool_def.d.ts +7 -6
- package/types/{def → nim_def}/user_def.d.ts +22 -21
- package/types/node-nim.d.ts +53 -0
- package/types/qchat/attachment.d.ts +40 -0
- package/types/qchat/channel.d.ts +133 -0
- package/types/qchat/channel_category.d.ts +82 -0
- package/types/qchat/instance.d.ts +46 -0
- package/types/qchat/message.d.ts +110 -0
- package/types/qchat/role.d.ts +161 -0
- package/types/qchat/server.d.ts +168 -0
- package/types/qchat/system_notification.d.ts +39 -0
- package/types/qchat_def/attachment_def.d.ts +71 -0
- package/types/qchat_def/channel_def.d.ts +624 -0
- package/types/qchat_def/instance_def.d.ts +212 -0
- package/types/qchat_def/message_def.d.ts +477 -0
- package/types/qchat_def/public_def.d.ts +774 -0
- package/types/qchat_def/role_def.d.ts +430 -0
- package/types/qchat_def/server_def.d.ts +451 -0
- package/types/qchat_def/system_notification_def.d.ts +170 -0
- package/js/api/client.js.map +0 -1
- package/js/api/data_sync.js.map +0 -1
- package/js/api/friend.js.map +0 -1
- package/js/api/global.js.map +0 -1
- package/js/api/msglog.js.map +0 -1
- package/js/api/nos.js.map +0 -1
- package/js/api/online_session.js.map +0 -1
- package/js/api/pass_through_proxy.js.map +0 -1
- package/js/api/plugin.js.map +0 -1
- package/js/api/session.js.map +0 -1
- package/js/api/subscribe_event.js.map +0 -1
- package/js/api/super_team.js.map +0 -1
- package/js/api/sysmsg.js.map +0 -1
- package/js/api/talk.js.map +0 -1
- package/js/api/talkex.js +0 -115
- package/js/api/talkex.js.map +0 -1
- package/js/api/team.js.map +0 -1
- package/js/api/tool.js.map +0 -1
- package/js/api/user.js.map +0 -1
- package/js/def/client_def.js.map +0 -1
- package/js/def/data_sync_def.js.map +0 -1
- package/js/def/doc_trans_def.js.map +0 -1
- package/js/def/friend_def.js.map +0 -1
- package/js/def/global_def.js.map +0 -1
- package/js/def/msglog_def.js.map +0 -1
- package/js/def/nos_def.js.map +0 -1
- package/js/def/online_session_def.js.map +0 -1
- package/js/def/pass_through_proxy_def.js.map +0 -1
- package/js/def/session_def.js.map +0 -1
- package/js/def/subscribe_event_def.js.map +0 -1
- package/js/def/super_team_def.js.map +0 -1
- package/js/def/sysmsg_def.js.map +0 -1
- package/js/def/team_def.js.map +0 -1
- package/js/def/tool_def.js.map +0 -1
- package/js/def/user_def.js.map +0 -1
- package/js/nim.js +0 -72
- package/js/nim.js.map +0 -1
- package/types/api/data_sync.d.ts +0 -13
- package/types/def/nos_def.d.ts +0 -71
- package/types/def/subscribe_event_def.d.ts +0 -82
- package/types/def/talkex_def.d.ts +0 -111
- package/types/nim.d.ts +0 -36
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
|
|
2
|
-
import
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
5
|
-
export declare interface
|
|
6
|
-
|
|
7
|
-
|
|
1
|
+
import { EventEmitter } from 'eventemitter3';
|
|
2
|
+
import { IMMessage } from '../nim_def/msglog_def';
|
|
3
|
+
import { NIMTeamAPI, TeamInfo, TeamEventCallback, QueryAllMyTeamsCallback, QueryAllMyTeamsInfoCallback, QueryTeamMyAllMemberInfosCallback, QueryTeamMembersCallback, QueryTeamMemberCallback, QueryTeamInfoCallback, QueryTeamMembersOnlineCallback, TeamMsgAckReadCallback, QueryTeamMembersInvitorCallback, QueryTeamsInfoCallback, UpdateTInfoLocalCallback, GetTeamInfoBatchSFTransCallback, GetTeamInfoListCallback, TeamMemberProperty, TeamEvent } from '../nim_def/team_def';
|
|
4
|
+
import { NIMResCode } from 'ts/nim_def/client_def';
|
|
5
|
+
export declare interface NIMTeamEvents {
|
|
6
|
+
/** 群事件 */
|
|
7
|
+
teamEvent: [TeamEvent];
|
|
8
8
|
}
|
|
9
|
-
export declare class NIMTeam extends
|
|
9
|
+
export declare class NIMTeam extends EventEmitter<NIMTeamEvents> {
|
|
10
10
|
team: NIMTeamAPI;
|
|
11
11
|
constructor();
|
|
12
12
|
/** 注册全局回调 */
|
|
@@ -17,7 +17,7 @@ export declare class NIMTeam extends ev.EventEmitter {
|
|
|
17
17
|
* @param invitation_postscript 邀请附言
|
|
18
18
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
19
19
|
* @param cb 群通知的回调函数
|
|
20
|
-
* @return
|
|
20
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
21
21
|
* @note
|
|
22
22
|
* <pre>
|
|
23
23
|
* 200:成功
|
|
@@ -27,7 +27,20 @@ export declare class NIMTeam extends ev.EventEmitter {
|
|
|
27
27
|
* 404:成员中有非法用户
|
|
28
28
|
* </pre>
|
|
29
29
|
*/
|
|
30
|
-
createTeamAsync(info: TeamInfo, ids: Array<string>, invitationPostscript: string, cb: TeamEventCallback, jsonExtension: string):
|
|
30
|
+
createTeamAsync(info: TeamInfo, ids: Array<string>, invitationPostscript: string, cb: TeamEventCallback, jsonExtension: string): Promise<[TeamEvent] | null>;
|
|
31
|
+
/** 解散群
|
|
32
|
+
* @param tid 群组id
|
|
33
|
+
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
34
|
+
* @param cb 解散群的回调函数
|
|
35
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
36
|
+
* @note
|
|
37
|
+
* <pre>
|
|
38
|
+
* 200:成功
|
|
39
|
+
* 802:没有权限
|
|
40
|
+
* 803:群不存在
|
|
41
|
+
* </pre>
|
|
42
|
+
*/
|
|
43
|
+
dismissAsync(tid: string, cb: TeamEventCallback, jsonExtension: string): Promise<[TeamEvent] | null>;
|
|
31
44
|
/** 邀请
|
|
32
45
|
* @param tid 群组id
|
|
33
46
|
* @param ids 邀请对象id
|
|
@@ -35,7 +48,7 @@ export declare class NIMTeam extends ev.EventEmitter {
|
|
|
35
48
|
* @param invitation_attachment 用户可自定义的补充邀请信息
|
|
36
49
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
37
50
|
* @param cb 邀请的回调函数
|
|
38
|
-
* @return
|
|
51
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
39
52
|
* @note
|
|
40
53
|
* <pre>
|
|
41
54
|
* 200:成功
|
|
@@ -46,13 +59,13 @@ export declare class NIMTeam extends ev.EventEmitter {
|
|
|
46
59
|
* 803:群不存在
|
|
47
60
|
* </pre>
|
|
48
61
|
*/
|
|
49
|
-
inviteAsync(tid: string, ids: Array<string>, invitationPostscript: string, invitationAttachment: string, cb: TeamEventCallback, jsonExtension: string):
|
|
62
|
+
inviteAsync(tid: string, ids: Array<string>, invitationPostscript: string, invitationAttachment: string, cb: TeamEventCallback, jsonExtension: string): Promise<[TeamEvent] | null>;
|
|
50
63
|
/** 踢人
|
|
51
64
|
* @param tid 群组id
|
|
52
65
|
* @param ids 被踢对象id
|
|
53
66
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
54
67
|
* @param cb 踢人的回调函数
|
|
55
|
-
* @return
|
|
68
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
56
69
|
* @note
|
|
57
70
|
* <pre>
|
|
58
71
|
* 200:成功
|
|
@@ -63,12 +76,12 @@ export declare class NIMTeam extends ev.EventEmitter {
|
|
|
63
76
|
* 804:用户不在群里面
|
|
64
77
|
* </pre>
|
|
65
78
|
*/
|
|
66
|
-
kickAsync(tid: string, ids: Array<string>, cb: TeamEventCallback, jsonExtension: string):
|
|
79
|
+
kickAsync(tid: string, ids: Array<string>, cb: TeamEventCallback, jsonExtension: string): Promise<[TeamEvent] | null>;
|
|
67
80
|
/** 离开群
|
|
68
81
|
* @param tid 群组id
|
|
69
82
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
70
83
|
* @param cb 离开群的回调函数
|
|
71
|
-
* @return
|
|
84
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
72
85
|
* @note
|
|
73
86
|
* <pre>
|
|
74
87
|
* 200:成功
|
|
@@ -78,40 +91,27 @@ export declare class NIMTeam extends ev.EventEmitter {
|
|
|
78
91
|
* 804:用户不在群里
|
|
79
92
|
* </pre>
|
|
80
93
|
*/
|
|
81
|
-
leaveAsync(tid: string, cb: TeamEventCallback, jsonExtension: string):
|
|
82
|
-
/** 解散群
|
|
83
|
-
* @param tid 群组id
|
|
84
|
-
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
85
|
-
* @param cb 解散群的回调函数
|
|
86
|
-
* @return bool 检查参数如果不符合要求则返回失败
|
|
87
|
-
* @note
|
|
88
|
-
* <pre>
|
|
89
|
-
* 200:成功
|
|
90
|
-
* 802:没有权限
|
|
91
|
-
* 803:群不存在
|
|
92
|
-
* </pre>
|
|
93
|
-
*/
|
|
94
|
-
dismissAsync(tid: string, cb: TeamEventCallback, jsonExtension: string): boolean;
|
|
94
|
+
leaveAsync(tid: string, cb: TeamEventCallback, jsonExtension: string): Promise<[TeamEvent] | null>;
|
|
95
95
|
/** 更新群信息
|
|
96
96
|
* @param tid 群组id
|
|
97
97
|
* @param team_info 群组信息
|
|
98
98
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
99
99
|
* @param cb 更新群信息的回调函数
|
|
100
|
-
* @return
|
|
100
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
101
101
|
* @note
|
|
102
102
|
* <pre>
|
|
103
103
|
* 200:成功
|
|
104
|
-
* 802
|
|
104
|
+
* 802:没有群权限、群主不能退群
|
|
105
105
|
* 803:群不存在
|
|
106
106
|
* </pre>
|
|
107
107
|
*/
|
|
108
|
-
updateTeamInfoAsync(tid: string, info: TeamInfo, cb: TeamEventCallback, jsonExtension: string):
|
|
108
|
+
updateTeamInfoAsync(tid: string, info: TeamInfo, cb: TeamEventCallback, jsonExtension: string): Promise<[TeamEvent] | null>;
|
|
109
109
|
/** 申请入群
|
|
110
110
|
* @param tid 群组id
|
|
111
111
|
* @param reason 附言
|
|
112
112
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
113
113
|
* @param cb 申请入群的回调函数
|
|
114
|
-
* @return
|
|
114
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
115
115
|
* @note
|
|
116
116
|
* <pre>
|
|
117
117
|
* 200:成功
|
|
@@ -123,13 +123,13 @@ export declare class NIMTeam extends ev.EventEmitter {
|
|
|
123
123
|
* 805:群类型不对
|
|
124
124
|
* </pre>
|
|
125
125
|
*/
|
|
126
|
-
applyJoinAsync(tid: string, reason: string, cb: TeamEventCallback, jsonExtension: string):
|
|
126
|
+
applyJoinAsync(tid: string, reason: string, cb: TeamEventCallback, jsonExtension: string): Promise<[TeamEvent] | null>;
|
|
127
127
|
/** 同意入群申请
|
|
128
128
|
* @param tid 群组id
|
|
129
129
|
* @param applicant_id 申请者id
|
|
130
130
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
131
131
|
* @param cb 同意入群申请的回调函数
|
|
132
|
-
* @return
|
|
132
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
133
133
|
* @note
|
|
134
134
|
* <pre>
|
|
135
135
|
* 200:成功
|
|
@@ -141,14 +141,14 @@ export declare class NIMTeam extends ev.EventEmitter {
|
|
|
141
141
|
* 805:群类型不对
|
|
142
142
|
* </pre>
|
|
143
143
|
*/
|
|
144
|
-
passJoinApplyAsync(tid: string, applicantId: string, cb: TeamEventCallback, jsonExtension: string):
|
|
144
|
+
passJoinApplyAsync(tid: string, applicantId: string, cb: TeamEventCallback, jsonExtension: string): Promise<[TeamEvent] | null>;
|
|
145
145
|
/** 拒绝入群申请
|
|
146
146
|
* @param tid 群组id
|
|
147
147
|
* @param applicant_id 申请者id
|
|
148
148
|
* @param reason 附言
|
|
149
149
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
150
150
|
* @param cb 拒绝入群申请的回调函数
|
|
151
|
-
* @return
|
|
151
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
152
152
|
* @note
|
|
153
153
|
* <pre>
|
|
154
154
|
* 200:成功,如果用户处于申请状态则会通知申请用户被拒绝
|
|
@@ -158,13 +158,13 @@ export declare class NIMTeam extends ev.EventEmitter {
|
|
|
158
158
|
* 805:群类型不对
|
|
159
159
|
* </pre>
|
|
160
160
|
*/
|
|
161
|
-
rejectJoinApplyAsync(tid: string, applicantId: string, reason: string, cb: TeamEventCallback, jsonExtension: string):
|
|
161
|
+
rejectJoinApplyAsync(tid: string, applicantId: string, reason: string, cb: TeamEventCallback, jsonExtension: string): Promise<[TeamEvent] | null>;
|
|
162
162
|
/** 添加管理员
|
|
163
163
|
* @param tid 群组id
|
|
164
164
|
* @param ids 管理员id
|
|
165
165
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
166
166
|
* @param cb 添加管理员的回调函数
|
|
167
|
-
* @return
|
|
167
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
168
168
|
* @note
|
|
169
169
|
* <pre>
|
|
170
170
|
* 200:成功
|
|
@@ -173,13 +173,13 @@ export declare class NIMTeam extends ev.EventEmitter {
|
|
|
173
173
|
* 805:群类型不对
|
|
174
174
|
* </pre>
|
|
175
175
|
*/
|
|
176
|
-
addManagersAsync(tid: string, ids: Array<string>, cb: TeamEventCallback, jsonExtension: string):
|
|
176
|
+
addManagersAsync(tid: string, ids: Array<string>, cb: TeamEventCallback, jsonExtension: string): Promise<[TeamEvent] | null>;
|
|
177
177
|
/** 删除管理员
|
|
178
178
|
* @param tid 群组id
|
|
179
179
|
* @param ids 管理员id
|
|
180
180
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
181
181
|
* @param cb 删除管理员的回调函数
|
|
182
|
-
* @return
|
|
182
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
183
183
|
* @note
|
|
184
184
|
* <pre>
|
|
185
185
|
* 200:成功
|
|
@@ -188,14 +188,14 @@ export declare class NIMTeam extends ev.EventEmitter {
|
|
|
188
188
|
* 805:群类型不对
|
|
189
189
|
* </pre>
|
|
190
190
|
*/
|
|
191
|
-
removeManagersAsync(tid: string, ids: Array<string>, cb: TeamEventCallback, jsonExtension: string):
|
|
191
|
+
removeManagersAsync(tid: string, ids: Array<string>, cb: TeamEventCallback, jsonExtension: string): Promise<[TeamEvent] | null>;
|
|
192
192
|
/** 移交群主
|
|
193
193
|
* @param tid 群组id
|
|
194
194
|
* @param new_owner_id 移交对象id
|
|
195
195
|
* @param is_leave 是否同时退出群
|
|
196
196
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
197
197
|
* @param cb 移交群主的回调函数
|
|
198
|
-
* @return
|
|
198
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
199
199
|
* @note
|
|
200
200
|
* <pre>
|
|
201
201
|
* 200:成功
|
|
@@ -205,12 +205,12 @@ export declare class NIMTeam extends ev.EventEmitter {
|
|
|
205
205
|
* 806:群数量上限
|
|
206
206
|
* </pre>
|
|
207
207
|
*/
|
|
208
|
-
transferTeamAsync(tid: string, newOwnerId: string, isLeave: boolean, cb: TeamEventCallback, jsonExtension: string):
|
|
208
|
+
transferTeamAsync(tid: string, newOwnerId: string, isLeave: boolean, cb: TeamEventCallback, jsonExtension: string): Promise<[TeamEvent] | null>;
|
|
209
209
|
/** 更新自己的群属性
|
|
210
210
|
* @param prop 群成员属性
|
|
211
211
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
212
212
|
* @param cb 更新自己的群属性的回调函数
|
|
213
|
-
* @return
|
|
213
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
214
214
|
* @note
|
|
215
215
|
* <pre>
|
|
216
216
|
* 200:成功
|
|
@@ -219,27 +219,28 @@ export declare class NIMTeam extends ev.EventEmitter {
|
|
|
219
219
|
* 805:群类型不对
|
|
220
220
|
* </pre>
|
|
221
221
|
*/
|
|
222
|
-
updateMyPropertyAsync(prop: TeamMemberProperty, cb: TeamEventCallback, jsonExtension: string):
|
|
222
|
+
updateMyPropertyAsync(prop: TeamMemberProperty, cb: TeamEventCallback, jsonExtension: string): Promise<[TeamEvent] | null>;
|
|
223
223
|
/** 修改别人的群昵称
|
|
224
224
|
* @param prop 群成员属性
|
|
225
225
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
226
226
|
* @param cb 修改别人的群昵称的回调函数
|
|
227
|
-
* @return
|
|
227
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
228
228
|
* @note
|
|
229
229
|
* <pre>
|
|
230
230
|
* 200:成功
|
|
231
|
+
* 802:没有权限
|
|
231
232
|
* 803:群不存在
|
|
232
233
|
* 804:不在群里
|
|
233
234
|
* 805:群类型不对
|
|
234
235
|
* </pre>
|
|
235
236
|
*/
|
|
236
|
-
updateOtherNickAsync(prop: TeamMemberProperty, cb: TeamEventCallback, jsonExtension: string):
|
|
237
|
+
updateOtherNickAsync(prop: TeamMemberProperty, cb: TeamEventCallback, jsonExtension: string): Promise<[TeamEvent] | null>;
|
|
237
238
|
/** 接受邀请
|
|
238
239
|
* @param tid 群组id
|
|
239
240
|
* @param invitor_id 邀请者id
|
|
240
241
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
241
242
|
* @param cb 接受邀请的回调函数
|
|
242
|
-
* @return
|
|
243
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
243
244
|
* @note
|
|
244
245
|
* <pre>
|
|
245
246
|
* 200:成功
|
|
@@ -248,14 +249,14 @@ export declare class NIMTeam extends ev.EventEmitter {
|
|
|
248
249
|
* 805:群类型不对
|
|
249
250
|
* </pre>
|
|
250
251
|
*/
|
|
251
|
-
acceptInvitationAsync(tid: string, inviterId: string, cb: TeamEventCallback, jsonExtension: string):
|
|
252
|
+
acceptInvitationAsync(tid: string, inviterId: string, cb: TeamEventCallback, jsonExtension: string): Promise<[TeamEvent] | null>;
|
|
252
253
|
/** 拒绝邀请
|
|
253
254
|
* @param tid 群组id
|
|
254
255
|
* @param invitor_id 邀请者id
|
|
255
256
|
* @param reason 附言
|
|
256
257
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
257
258
|
* @param cb 拒绝邀请的回调函数
|
|
258
|
-
* @return
|
|
259
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
259
260
|
* @note
|
|
260
261
|
* <pre>
|
|
261
262
|
* 200:成功
|
|
@@ -264,30 +265,30 @@ export declare class NIMTeam extends ev.EventEmitter {
|
|
|
264
265
|
* 805:群类型不对
|
|
265
266
|
* </pre>
|
|
266
267
|
*/
|
|
267
|
-
rejectInvitationAsync(tid: string, inviterId: string, reason: string, cb: TeamEventCallback, jsonExtension: string):
|
|
268
|
+
rejectInvitationAsync(tid: string, inviterId: string, reason: string, cb: TeamEventCallback, jsonExtension: string): Promise<[TeamEvent] | null>;
|
|
268
269
|
/** 查询所有群
|
|
269
270
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
270
271
|
* @param cb 查询所有群的回调函数
|
|
271
272
|
* @return void 无返回值
|
|
272
273
|
*/
|
|
273
|
-
queryAllMyTeamsAsync(cb: QueryAllMyTeamsCallback, jsonExtension: string):
|
|
274
|
+
queryAllMyTeamsAsync(cb: QueryAllMyTeamsCallback, jsonExtension: string): Promise<[number, Array<string>]>;
|
|
274
275
|
/** 查询所有群信息
|
|
275
276
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
276
277
|
* @param cb 查询所有群信息的回调函数
|
|
277
278
|
* @return void 无返回值
|
|
278
279
|
*/
|
|
279
|
-
queryAllMyTeamsInfoAsync(cb: QueryAllMyTeamsInfoCallback, jsonExtension: string):
|
|
280
|
+
queryAllMyTeamsInfoAsync(cb: QueryAllMyTeamsInfoCallback, jsonExtension: string): Promise<[number, Array<TeamInfo>]>;
|
|
280
281
|
/** 查询所有群里我的成员信息(使用场景:获取了所有群列表后,需要查询自己在每个群里自己的成员信息,使用成员信息里的bits字段,可以判断当某个群发来消息后,是否做消息通知)
|
|
281
282
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
282
283
|
* @param cb 查询所有群里我的成员信息的回调函数
|
|
283
284
|
* @return void 无返回值
|
|
284
285
|
*/
|
|
285
|
-
queryMyAllMemberInfosAsync(cb: QueryTeamMyAllMemberInfosCallback, jsonExtension: string):
|
|
286
|
+
queryMyAllMemberInfosAsync(cb: QueryTeamMyAllMemberInfosCallback, jsonExtension: string): Promise<[number, Array<TeamMemberProperty>]>;
|
|
286
287
|
/** 查询群成员
|
|
287
288
|
* @param tid 群组id
|
|
288
289
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
289
290
|
* @param cb 查询群成员的回调函数
|
|
290
|
-
* @return
|
|
291
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
291
292
|
* @note
|
|
292
293
|
* <pre>
|
|
293
294
|
* 200:成功
|
|
@@ -295,41 +296,41 @@ export declare class NIMTeam extends ev.EventEmitter {
|
|
|
295
296
|
* 802:没有权限
|
|
296
297
|
* </pre>
|
|
297
298
|
*/
|
|
298
|
-
queryTeamMembersAsync(tid: string, cb: QueryTeamMembersCallback, jsonExtension: string):
|
|
299
|
+
queryTeamMembersAsync(tid: string, cb: QueryTeamMembersCallback, jsonExtension: string): Promise<[string, number, Array<TeamMemberProperty>] | null>;
|
|
299
300
|
/** 查询(单个)群成员信息
|
|
300
301
|
* @param tid 群组id
|
|
301
302
|
* @param id 群成员id
|
|
302
303
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
303
304
|
* @param cb 查询群成员的回调函数
|
|
304
|
-
* @return
|
|
305
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
305
306
|
*/
|
|
306
|
-
queryTeamMemberAsync(tid: string, id: string, cb: QueryTeamMemberCallback, jsonExtension: string):
|
|
307
|
+
queryTeamMemberAsync(tid: string, id: string, cb: QueryTeamMemberCallback, jsonExtension: string): Promise<[TeamMemberProperty]>;
|
|
307
308
|
/** 查询群信息
|
|
308
309
|
* @param tid 群组id
|
|
309
310
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
310
311
|
* @param cb 查询群信息的回调函数
|
|
311
|
-
* @return
|
|
312
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
312
313
|
*/
|
|
313
|
-
queryTeamInfoAsync(tid: string, cb: QueryTeamInfoCallback, jsonExtension: string):
|
|
314
|
+
queryTeamInfoAsync(tid: string, cb: QueryTeamInfoCallback, jsonExtension: string): Promise<[string, TeamInfo] | null>;
|
|
314
315
|
/** 获取群信息(从服务器获取)
|
|
315
316
|
* @param tid 群组id
|
|
316
317
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
317
318
|
* @param cb 获取群信息的回调函数
|
|
318
|
-
* @return
|
|
319
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
319
320
|
* @note
|
|
320
321
|
* <pre>
|
|
321
322
|
* 200:成功
|
|
322
323
|
* 803:群不存在
|
|
323
324
|
* </pre>
|
|
324
325
|
*/
|
|
325
|
-
queryTeamInfoOnlineAsync(tid: string, cb: TeamEventCallback, jsonExtension: string):
|
|
326
|
-
/**
|
|
326
|
+
queryTeamInfoOnlineAsync(tid: string, cb: TeamEventCallback, jsonExtension: string): Promise<[TeamEvent] | null>;
|
|
327
|
+
/** 禁言/解除禁言
|
|
327
328
|
* @param tid 群组id
|
|
328
329
|
* @param member_id 操作对象id
|
|
329
330
|
* @param set_mute 禁言/解除禁言
|
|
330
331
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
331
332
|
* @param cb 踢人的回调函数
|
|
332
|
-
* @return
|
|
333
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
333
334
|
* @note
|
|
334
335
|
* <pre>
|
|
335
336
|
* 200:成功
|
|
@@ -339,33 +340,33 @@ export declare class NIMTeam extends ev.EventEmitter {
|
|
|
339
340
|
* 802:没有权限
|
|
340
341
|
* </pre>
|
|
341
342
|
*/
|
|
342
|
-
muteMemberAsync(tid: string, member_id: string, set_mute: boolean, cb: TeamEventCallback, jsonExtension: string):
|
|
343
|
-
/**
|
|
344
|
-
* @param tid
|
|
345
|
-
* @param
|
|
343
|
+
muteMemberAsync(tid: string, member_id: string, set_mute: boolean, cb: TeamEventCallback, jsonExtension: string): Promise<[TeamEvent] | null>;
|
|
344
|
+
/** 群禁言/解除群禁言
|
|
345
|
+
* @param tid 群组id
|
|
346
|
+
* @param set_mute 禁言/解除禁言
|
|
346
347
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
347
|
-
* @
|
|
348
|
+
* @param cb 踢人的回调函数
|
|
349
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
348
350
|
* @note
|
|
349
351
|
* <pre>
|
|
350
352
|
* 200:成功
|
|
351
|
-
*
|
|
352
|
-
* 803:群不存在
|
|
353
|
+
* 414:参数错误
|
|
353
354
|
* </pre>
|
|
354
355
|
*/
|
|
355
|
-
|
|
356
|
-
/**
|
|
357
|
-
* @param tid
|
|
358
|
-
* @param
|
|
356
|
+
muteAsync(tid: string, set_mute: boolean, cb: TeamEventCallback, jsonExtension: string): Promise<[TeamEvent] | null>;
|
|
357
|
+
/** 获取群禁言成员列表
|
|
358
|
+
* @param tid 群组id
|
|
359
|
+
* @param cb 回调函数
|
|
359
360
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
360
|
-
* @
|
|
361
|
-
* @return bool 检查参数如果不符合要求则返回失败.
|
|
361
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
362
362
|
* @note
|
|
363
363
|
* <pre>
|
|
364
364
|
* 200:成功
|
|
365
|
-
*
|
|
365
|
+
* 802:没有权限
|
|
366
|
+
* 803:群不存在
|
|
366
367
|
* </pre>
|
|
367
368
|
*/
|
|
368
|
-
|
|
369
|
+
queryMuteListOnlineAsync(tid: string, cb: QueryTeamMembersOnlineCallback, jsonExtension: string): Promise<[NIMResCode, number, Array<TeamMemberProperty>] | null>;
|
|
369
370
|
/** 群消息回执
|
|
370
371
|
* @param tid 群组id
|
|
371
372
|
* @param msgs 需要发送消息回执的群消息
|
|
@@ -378,7 +379,7 @@ export declare class NIMTeam extends ev.EventEmitter {
|
|
|
378
379
|
* 414:参数错误
|
|
379
380
|
* </pre>
|
|
380
381
|
*/
|
|
381
|
-
teamMsgAckRead(tid: string, msgs: Array<IMMessage>, cb: TeamMsgAckReadCallback, jsonExtension: string):
|
|
382
|
+
teamMsgAckRead(tid: string, msgs: Array<IMMessage>, cb: TeamMsgAckReadCallback, jsonExtension: string): Promise<[string, Array<string>, Array<string>, Array<string>]>;
|
|
382
383
|
/** 根据指定 ID 获取群组消息已读未读情况
|
|
383
384
|
* @param[in] tid 群组id
|
|
384
385
|
* @param[in] msg 群消息
|
|
@@ -392,7 +393,7 @@ export declare class NIMTeam extends ev.EventEmitter {
|
|
|
392
393
|
* 414:参数错误
|
|
393
394
|
* </pre>
|
|
394
395
|
*/
|
|
395
|
-
teamMsgQueryUnreadList(tid: string, msg: IMMessage, accids: Array<string>, cb: TeamEventCallback, jsonExtension: string):
|
|
396
|
+
teamMsgQueryUnreadList(tid: string, msg: IMMessage, accids: Array<string>, cb: TeamEventCallback, jsonExtension: string): Promise<[TeamEvent]>;
|
|
396
397
|
/** 查询群成员的邀请人 accid 由接口 原 TeamQueryTeamMembersInvitor方法
|
|
397
398
|
* @param tid 群组id
|
|
398
399
|
* @param members 要查询 的群成员accid列表
|
|
@@ -403,14 +404,14 @@ export declare class NIMTeam extends ev.EventEmitter {
|
|
|
403
404
|
* 200:成功
|
|
404
405
|
* </pre>
|
|
405
406
|
*/
|
|
406
|
-
queryTeamMembersInvitor(tid: string, members: Array<string>, cb: QueryTeamMembersInvitorCallback):
|
|
407
|
+
queryTeamMembersInvitor(tid: string, members: Array<string>, cb: QueryTeamMembersInvitorCallback): Promise<[NIMResCode, number, Map<string, string>]>;
|
|
407
408
|
/** 查询群信息
|
|
408
409
|
* @param keyword 要查询的关键字
|
|
409
410
|
* @param cb 查询群信息的回调函数
|
|
410
411
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
411
|
-
* @return
|
|
412
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
412
413
|
*/
|
|
413
|
-
queryTeamInfoByKeywordAsync(keyword: string, cb: QueryTeamsInfoCallback, jsonExtension: string):
|
|
414
|
+
queryTeamInfoByKeywordAsync(keyword: string, cb: QueryTeamsInfoCallback, jsonExtension: string): Promise<[number, Array<TeamInfo>]>;
|
|
414
415
|
/** 更新群信息
|
|
415
416
|
* @param tid 群组id
|
|
416
417
|
* @param team_infos 群组信息
|
|
@@ -419,14 +420,14 @@ export declare class NIMTeam extends ev.EventEmitter {
|
|
|
419
420
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
420
421
|
* @return void
|
|
421
422
|
*/
|
|
422
|
-
updateTInfoLocal(infos: Array<TeamInfo>, cb: UpdateTInfoLocalCallback, jsonExtension: string):
|
|
423
|
+
updateTInfoLocal(infos: Array<TeamInfo>, cb: UpdateTInfoLocalCallback, jsonExtension: string): Promise<[Array<string>, Array<string>]>;
|
|
423
424
|
/** 查询所有群
|
|
424
425
|
* @param cb 查询所有群的回调函数
|
|
425
426
|
* @param time_tag 时间戳,没有特殊需求此参数赋0
|
|
426
427
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
427
428
|
* @return void 无返回值
|
|
428
429
|
*/
|
|
429
|
-
getTeamInfoBatchTrans(cb: GetTeamInfoBatchSFTransCallback, time_tag: number, jsonExtension: string):
|
|
430
|
+
getTeamInfoBatchTrans(cb: GetTeamInfoBatchSFTransCallback, time_tag: number, jsonExtension: string): Promise<[number, Array<TeamInfo>]>;
|
|
430
431
|
/** 查询给定的一组群ID详细信息
|
|
431
432
|
* @param tid_list 群组id列表,最多10个
|
|
432
433
|
* @param cb 查询给定的一组群ID详细信息的回调模板
|
|
@@ -438,5 +439,5 @@ export declare class NIMTeam extends ev.EventEmitter {
|
|
|
438
439
|
* 816:部分成功
|
|
439
440
|
* </pre>
|
|
440
441
|
*/
|
|
441
|
-
getTeaminfoList(tids: Array<string>, cb: GetTeamInfoListCallback):
|
|
442
|
+
getTeaminfoList(tids: Array<string>, cb: GetTeamInfoListCallback): Promise<[NIMResCode, Array<TeamInfo>, Array<string>]>;
|
|
442
443
|
}
|
|
@@ -1,7 +1,9 @@
|
|
|
1
|
-
|
|
2
|
-
import
|
|
3
|
-
import {
|
|
4
|
-
export declare
|
|
1
|
+
import { EventEmitter } from 'eventemitter3';
|
|
2
|
+
import { NIMToolAPI, NIMAppDataType, AudioInfo, GetAudioTextCallback, FilterClientAntispamCallback } from '../nim_def/tool_def';
|
|
3
|
+
import { NIMResCode } from 'ts/nim_def/client_def';
|
|
4
|
+
export declare interface NIMToolEvents {
|
|
5
|
+
}
|
|
6
|
+
export declare class NIMTool extends EventEmitter<NIMToolEvents> {
|
|
5
7
|
tool: NIMToolAPI;
|
|
6
8
|
constructor();
|
|
7
9
|
/** 注册全局回调 */
|
|
@@ -43,7 +45,7 @@ export declare class NIMTool extends ev.EventEmitter {
|
|
|
43
45
|
* @param audio_info 语音信息
|
|
44
46
|
* @param cb 语音转文字回调
|
|
45
47
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
46
|
-
* @return
|
|
48
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
47
49
|
* @note
|
|
48
50
|
* <pre>
|
|
49
51
|
* 200:成功
|
|
@@ -56,7 +58,7 @@ export declare class NIMTool extends ev.EventEmitter {
|
|
|
56
58
|
* 6104:audioUrl不合法
|
|
57
59
|
* </pre>
|
|
58
60
|
*/
|
|
59
|
-
getAudioTextAsync(audioInfo: AudioInfo, cb: GetAudioTextCallback, jsonExtension: string):
|
|
61
|
+
getAudioTextAsync(audioInfo: AudioInfo, cb: GetAudioTextCallback, jsonExtension: string): Promise<[NIMResCode, string] | null>;
|
|
60
62
|
/** 客户端本地反垃圾
|
|
61
63
|
* @param text 文本内容,UTF-8
|
|
62
64
|
* @param replace_str 进行替换的字符串,UTF-8
|
|
@@ -71,5 +73,5 @@ export declare class NIMTool extends ev.EventEmitter {
|
|
|
71
73
|
* 3:需要将内容设置在消息结构的反垃圾字段里,由服务器过滤
|
|
72
74
|
* </pre>
|
|
73
75
|
*/
|
|
74
|
-
filterClientAntispam(text: string, replaceString: string, libName: string, cb: FilterClientAntispamCallback):
|
|
76
|
+
filterClientAntispam(text: string, replaceString: string, libName: string, cb: FilterClientAntispamCallback): Promise<[boolean, NIMResCode, string]>;
|
|
75
77
|
}
|
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
|
|
2
|
-
import
|
|
3
|
-
import {
|
|
4
|
-
export declare interface
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
1
|
+
import { EventEmitter } from 'eventemitter3';
|
|
2
|
+
import { NIMUserAPI, SetRelationCallback, GetSpecialListCallback, GetUserNameCardCallback, UpdateMyUserNameCardCallback, NINPushType, UserNameCard, SpecialRelationshipChangeEvent, BlackMuteListInfo } from '../nim_def/user_def';
|
|
3
|
+
import { NIMResCode } from 'ts/nim_def/client_def';
|
|
4
|
+
export declare interface NIMUserEvents {
|
|
5
|
+
/** 用户属性变更 */
|
|
6
|
+
specialRelationChange: [SpecialRelationshipChangeEvent];
|
|
7
|
+
/** 用户名片变更 */
|
|
8
|
+
userNameCardChange: [Array<UserNameCard>];
|
|
9
9
|
}
|
|
10
|
-
export declare class NIMUser extends
|
|
10
|
+
export declare class NIMUser extends EventEmitter<NIMUserEvents> {
|
|
11
11
|
user: NIMUserAPI;
|
|
12
12
|
constructor();
|
|
13
13
|
/** 注册全局回调 */
|
|
@@ -17,43 +17,43 @@ export declare class NIMUser extends ev.EventEmitter {
|
|
|
17
17
|
* @param set_black 取消或设置
|
|
18
18
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
19
19
|
* @param cb
|
|
20
|
-
* @return
|
|
20
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
21
21
|
* @note
|
|
22
22
|
* <pre>
|
|
23
23
|
* 200:成功
|
|
24
24
|
* 419:黑名单数量超过上限
|
|
25
25
|
* </pre>
|
|
26
26
|
*/
|
|
27
|
-
setBlack(accid: string, setBlack: boolean, cb: SetRelationCallback, jsonExtension: string): boolean
|
|
27
|
+
setBlack(accid: string, setBlack: boolean, cb: SetRelationCallback, jsonExtension: string): Promise<[NIMResCode, string, boolean] | null>;
|
|
28
28
|
/** 设置、取消设置静音名单
|
|
29
29
|
* @param accid 好友id
|
|
30
30
|
* @param set_mute 取消或设置
|
|
31
31
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
32
32
|
* @param cb
|
|
33
|
-
* @return
|
|
33
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
34
34
|
* @note
|
|
35
35
|
* <pre>
|
|
36
36
|
* 200:成功
|
|
37
37
|
* 419:静音列表数量超过上限
|
|
38
38
|
* </pre>
|
|
39
39
|
*/
|
|
40
|
-
setMute(accid: string, set_mute: boolean, cb: SetRelationCallback, jsonExtension: string): boolean
|
|
40
|
+
setMute(accid: string, set_mute: boolean, cb: SetRelationCallback, jsonExtension: string): Promise<[NIMResCode, string, boolean] | null>;
|
|
41
41
|
/** 获得静音名单列表
|
|
42
42
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
43
43
|
* @param cb
|
|
44
|
-
* @return
|
|
44
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
45
45
|
* @note
|
|
46
46
|
* <pre>
|
|
47
47
|
* 200:成功
|
|
48
48
|
* </pre>
|
|
49
49
|
*/
|
|
50
|
-
getMutelist(cb: GetSpecialListCallback, jsonExtension: string):
|
|
50
|
+
getMutelist(cb: GetSpecialListCallback, jsonExtension: string): Promise<[NIMResCode, Array<BlackMuteListInfo>]>;
|
|
51
51
|
/** 获得黑名单名单
|
|
52
52
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
53
53
|
* @param cb
|
|
54
54
|
* @return void 无返回值
|
|
55
55
|
*/
|
|
56
|
-
getBlacklist(cb: GetSpecialListCallback, jsonExtension: string):
|
|
56
|
+
getBlacklist(cb: GetSpecialListCallback, jsonExtension: string): Promise<[NIMResCode, Array<BlackMuteListInfo>]>;
|
|
57
57
|
/** 获取本地的指定帐号的用户名片
|
|
58
58
|
* @param accids
|
|
59
59
|
* @param cb 操作结果回调
|
|
@@ -67,12 +67,12 @@ export declare class NIMUser extends ev.EventEmitter {
|
|
|
67
67
|
* 20001:还未登陆或登录未完成
|
|
68
68
|
* </pre>
|
|
69
69
|
*/
|
|
70
|
-
getUserNameCard(accids: Array<string>, cb: GetUserNameCardCallback, jsonExtension: string):
|
|
70
|
+
getUserNameCard(accids: Array<string>, cb: GetUserNameCardCallback, jsonExtension: string): Promise<[Array<UserNameCard>] | null>;
|
|
71
71
|
/** 在线查询指定帐号的用户名片
|
|
72
72
|
* @param accids
|
|
73
73
|
* @param cb 操作结果回调
|
|
74
74
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
75
|
-
* @return
|
|
75
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
76
76
|
* @note
|
|
77
77
|
* <pre>
|
|
78
78
|
* 200:成功
|
|
@@ -81,26 +81,26 @@ export declare class NIMUser extends ev.EventEmitter {
|
|
|
81
81
|
* 20001:还未登陆或登录未完成
|
|
82
82
|
* </pre>
|
|
83
83
|
*/
|
|
84
|
-
getUserNameCardOnline(accids: Array<string>, cb: GetUserNameCardCallback, jsonExtension: string):
|
|
84
|
+
getUserNameCardOnline(accids: Array<string>, cb: GetUserNameCardCallback, jsonExtension: string): Promise<[Array<UserNameCard>] | null>;
|
|
85
85
|
/** 更新自己的用户名片
|
|
86
86
|
* @param namecard 用户名片内容
|
|
87
87
|
* @param cb 操作结果回调
|
|
88
88
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
89
|
-
* @return
|
|
89
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
90
90
|
* @note
|
|
91
91
|
* <pre>
|
|
92
92
|
* 200:成功
|
|
93
93
|
* 400:非法参数
|
|
94
94
|
* </pre>
|
|
95
95
|
*/
|
|
96
|
-
updateMyUserNameCard(nameCard: UserNameCard, cb: UpdateMyUserNameCardCallback, jsonExtension: string):
|
|
96
|
+
updateMyUserNameCard(nameCard: UserNameCard, cb: UpdateMyUserNameCardCallback, jsonExtension: string): Promise<[NIMResCode] | null>;
|
|
97
97
|
/** 获取本地的指定帐号的用户名片
|
|
98
98
|
* @param keyword 要查询的关键字
|
|
99
99
|
* @param cb 操作结果回调
|
|
100
100
|
* @param jsonExtension json扩展参数(备用,目前不需要)
|
|
101
|
-
* @return
|
|
101
|
+
* @return boolean 检查参数如果不符合要求则返回失败
|
|
102
102
|
*/
|
|
103
|
-
queryUserListByKeyword(keyword: string, cb: GetUserNameCardCallback, jsonExtension: string):
|
|
103
|
+
queryUserListByKeyword(keyword: string, cb: GetUserNameCardCallback, jsonExtension: string): Promise<[Array<UserNameCard>] | null>;
|
|
104
104
|
/** 更新推送证书
|
|
105
105
|
* @param cer_name 云信后台配置的s推送证明名称
|
|
106
106
|
* @param token 设备token
|