-
Notifications
You must be signed in to change notification settings - Fork 2
nim.talkex.NIMTalkEx
nim/talkex.NIMTalkEx
-
EventEmitter<NIMTalkExEvents>↳
NIMTalkEx
- eventNames
- listeners
- listenerCount
- emit
- on
- addListener
- once
- removeListener
- off
- removeAllListeners
- initEventHandlers
- addCollect
- removeCollects
- updateCollectExt
- queryCollectList
- addQuickComment
- removeQuickComment
- queryQuickCommentList
- addPinMessage
- unPinMessage
- updatePinMessage
- queryAllPinMessage
▸ eventNames(): keyof NIMTalkExEvents[]
Return an array listing the events for which the emitter has registered listeners.
keyof NIMTalkExEvents[]
EventEmitter.eventNames
node_modules/eventemitter3/index.d.ts:15
▸ listeners<T>(event): (...args: ArgumentMap<NIMTalkExEvents>[Extract<T, keyof NIMTalkExEvents>]) => void[]
Return the listeners registered for a given event.
| Name | Type |
|---|---|
T |
extends keyof NIMTalkExEvents
|
| Name | Type |
|---|---|
event |
T |
(...args: ArgumentMap<NIMTalkExEvents>[Extract<T, keyof NIMTalkExEvents>]) => void[]
EventEmitter.listeners
node_modules/eventemitter3/index.d.ts:20
▸ listenerCount(event): number
Return the number of listeners listening to a given event.
| Name | Type |
|---|---|
event |
keyof NIMTalkExEvents
|
number
EventEmitter.listenerCount
node_modules/eventemitter3/index.d.ts:27
▸ emit<T>(event, ...args): boolean
Calls each of the listeners registered for a given event.
| Name | Type |
|---|---|
T |
extends keyof NIMTalkExEvents
|
| Name | Type |
|---|---|
event |
T |
...args |
ArgumentMap<NIMTalkExEvents>[Extract<T, keyof NIMTalkExEvents>] |
boolean
EventEmitter.emit
node_modules/eventemitter3/index.d.ts:32
▸ on<T>(event, fn, context?): NIMTalkEx
Add a listener for a given event.
| Name | Type |
|---|---|
T |
extends keyof NIMTalkExEvents
|
| Name | Type |
|---|---|
event |
T |
fn |
(...args: ArgumentMap<NIMTalkExEvents>[Extract<T, keyof NIMTalkExEvents>]) => void
|
context? |
any |
EventEmitter.on
node_modules/eventemitter3/index.d.ts:40
▸ addListener<T>(event, fn, context?): NIMTalkEx
| Name | Type |
|---|---|
T |
extends keyof NIMTalkExEvents
|
| Name | Type |
|---|---|
event |
T |
fn |
(...args: ArgumentMap<NIMTalkExEvents>[Extract<T, keyof NIMTalkExEvents>]) => void
|
context? |
any |
EventEmitter.addListener
node_modules/eventemitter3/index.d.ts:45
▸ once<T>(event, fn, context?): NIMTalkEx
Add a one-time listener for a given event.
| Name | Type |
|---|---|
T |
extends keyof NIMTalkExEvents
|
| Name | Type |
|---|---|
event |
T |
fn |
(...args: ArgumentMap<NIMTalkExEvents>[Extract<T, keyof NIMTalkExEvents>]) => void
|
context? |
any |
EventEmitter.once
node_modules/eventemitter3/index.d.ts:54
▸ removeListener<T>(event, fn?, context?, once?): NIMTalkEx
Remove the listeners of a given event.
| Name | Type |
|---|---|
T |
extends keyof NIMTalkExEvents
|
| Name | Type |
|---|---|
event |
T |
fn? |
(...args: ArgumentMap<NIMTalkExEvents>[Extract<T, keyof NIMTalkExEvents>]) => void
|
context? |
any |
once? |
boolean |
EventEmitter.removeListener
node_modules/eventemitter3/index.d.ts:63
▸ off<T>(event, fn?, context?, once?): NIMTalkEx
| Name | Type |
|---|---|
T |
extends keyof NIMTalkExEvents
|
| Name | Type |
|---|---|
event |
T |
fn? |
(...args: ArgumentMap<NIMTalkExEvents>[Extract<T, keyof NIMTalkExEvents>]) => void
|
context? |
any |
once? |
boolean |
EventEmitter.off
node_modules/eventemitter3/index.d.ts:69
▸ removeAllListeners(event?): NIMTalkEx
Remove all listeners, or those of the specified event.
| Name | Type |
|---|---|
event? |
keyof NIMTalkExEvents
|
EventEmitter.removeAllListeners
node_modules/eventemitter3/index.d.ts:79
▸ initEventHandlers(): void
注册全局回调
void
ts/nim/talkex.ts:53
▸ addCollect(collect_info, cb): Promise<[NIMResCode, CollectInfo]>
添加收藏
| Name | Type | Description |
|---|---|---|
collect_info |
CollectInfo |
收藏内容 |
cb |
null | AddCollectCallback
|
执行结果回调函数 |
Promise<[NIMResCode, CollectInfo]>
void 无返回值
ts/nim/talkex.ts:63
▸ removeCollects(collect_list, cb): Promise<[NIMResCode, number]>
批量删除收藏
| Name | Type | Description |
|---|---|---|
collect_list |
RemoveCollectsParm |
要删除的收藏列表 |
cb |
null | RemoveCollectsCallback
|
执行结果回调函数 |
Promise<[NIMResCode, number]>
void 无返回值
ts/nim/talkex.ts:79
▸ updateCollectExt(collect_match_param, ext, cb): Promise<[NIMResCode, CollectInfo]>
更新收藏扩展字段
| Name | Type | Description |
|---|---|---|
collect_match_param |
MatchCollectParm |
根据收藏的id 与 create time去匹配收藏内容 |
ext |
string |
收藏的扩展字段内容 |
cb |
null | UpdateCollectCallback
|
执行结果回调函数 |
Promise<[NIMResCode, CollectInfo]>
void 无返回值
ts/nim/talkex.ts:96
▸ queryCollectList(query_collect_list_param, cb): Promise<[NIMResCode, number, CollectInfoList]>
分页查询收藏列表
| Name | Type | Description |
|---|---|---|
query_collect_list_param |
QueryCollectsParm |
查询参数 |
cb |
null | QueryCollectsCallback
|
执行结果回调函数 |
Promise<[NIMResCode, number, CollectInfoList]>
void 无返回值
ts/nim/talkex.ts:112
▸ addQuickComment(msg, info, cb): Promise<[NIMResCode, QuickCommentInfo]>
添加快捷回复
| Name | Type | Description |
|---|---|---|
msg |
IMMessage |
被回复的消息 |
info |
QuickCommentInfo |
回复的内容及设置 |
cb |
null | AddQuickCommentCallback
|
执行结果回调函数 |
Promise<[NIMResCode, QuickCommentInfo]>
void 无返回值
ts/nim/talkex.ts:129
▸ removeQuickComment(msg, param, cb): Promise<[NIMResCode, string]>
删除快捷回复
| Name | Type | Description |
|---|---|---|
msg |
IMMessage |
被删除的消息 |
param |
RemoveQuickCommentParam |
删除设置 |
cb |
null | RemoveQuickCommentCallback
|
执行结果回调函数 |
Promise<[NIMResCode, string]>
void 无返回值
ts/nim/talkex.ts:146
▸ queryQuickCommentList(query_param, cb): Promise<[NIMResCode, QueryQuickCommentsResponse]>
查询快捷回复
| Name | Type | Description |
|---|---|---|
query_param |
QueryQuickCommentsParam |
查询参数，一次最多只能查询20条消息的快捷回复 |
cb |
null | QueryQuickCommentCallback
|
执行结果回调函数 |
Promise<[NIMResCode, QueryQuickCommentsResponse]>
void 无返回值
ts/nim/talkex.ts:162
▸ addPinMessage(msg, info, cb): Promise<[NIMResCode, string, number, PinMessageInfo]>
Pin某条消息
| Name | Type | Description |
|---|---|---|
msg |
IMMessage |
要Pin的消息 |
info |
PinMessageInfo |
- |
cb |
null | PinMessageCallback
|
执行结果回调函数 |
Promise<[NIMResCode, string, number, PinMessageInfo]>
void 无返回值
ts/nim/talkex.ts:180
▸ unPinMessage(modify_param, cb): Promise<[NIMResCode, string, number, string]>
取消Pin某条消息
| Name | Type | Description |
|---|---|---|
modify_param |
ModifyPinMessageParam |
UnPin Message 参数 |
cb |
null | UnPinMessageCallback
|
执行结果回调函数 |
Promise<[NIMResCode, string, number, string]>
void 无返回值
ts/nim/talkex.ts:196
▸ updatePinMessage(modify_param, cb): Promise<[NIMResCode, string, number, PinMessageInfo]>
更新 Pin Message ext字段
| Name | Type | Description |
|---|---|---|
modify_param |
ModifyPinMessageParam |
更新 Pin Message 参数 |
cb |
null | UpdatePinMessageCallback
|
执行结果回调函数 |
Promise<[NIMResCode, string, number, PinMessageInfo]>
void 无返回值
ts/nim/talkex.ts:212
▸ queryAllPinMessage(session, to_type, cb): Promise<[NIMResCode, string, number, QueryAllPinMessageResponse]>
查询会话的所有 Pin Message
| Name | Type | Description |
|---|---|---|
session |
string |
会话ID |
to_type |
number |
会话类型 |
cb |
null | QueryPinMessageCallback
|
执行结果回调函数 |
Promise<[NIMResCode, string, number, QueryAllPinMessageResponse]>
void 无返回值
ts/nim/talkex.ts:229
• talkex: NIMTalkExAPI
ts/nim/talkex.ts:46
• new NIMTalkEx()
EventEmitter<NIMTalkExEvents>.constructor
ts/nim/talkex.ts:47
- chatroom/chatroom
- chatroom_def/chatroom_def
- nim/client
- nim/data_sync
- nim/friend
- nim/global
- nim/msglog
- nim/nos
- nim/online_session
- nim/pass_through_proxy
- nim/plugin
- nim/session
- nim/subscribe_event
- nim/super_team
- nim/sysmsg
- nim/talk
- nim/talkex
- nim/team
- nim/tool
- nim/user
- nim_def/client_def
- nim_def/data_sync_def
- nim_def/doc_trans_def
- nim_def/friend_def
- nim_def/global_def
- nim_def/msglog_def
- nim_def/nos_def
- nim_def/online_session_def
- nim_def/pass_through_proxy_def
- nim_def/plugin_def
- nim_def/session_def
- nim_def/subscribe_event_def
- nim_def/super_team_def
- nim_def/sysmsg_def
- nim_def/talk_def
- nim_def/talkex_def
- nim_def/team_def
- nim_def/tool_def
- nim_def/user_def
- node-nim
- qchat/attachment
- qchat/channel
- qchat/channel_category
- qchat/instance
- qchat/message
- qchat/role
- qchat/server
- qchat/system_notification
- qchat_def/attachment_def
- qchat_def/channel_def
- qchat_def/instance_def
- qchat_def/message_def
- qchat_def/public_def
- qchat_def/role_def
- qchat_def/server_def
- qchat_def/system_notification_def