nim.talk.NIMTalk

Class: NIMTalk

nim/talk.NIMTalk

Hierarchy

• EventEmitter<NIMTalkEvents>

  ↳ NIMTalk

Table of contents

Methods

• eventNames
• listeners
• listenerCount
• emit
• on
• addListener
• once
• removeListener
• off
• removeAllListeners
• initEventHandlers
• sendMsg
• stopSendMsg
• recallMsg
• getAttachmentPathFromMsg
• replyMessage
• regMessageFilter
• regTeamNotificationFilter

Properties

• talk

Constructors

• constructor

Methods

eventNames

▸ eventNames(): keyof NIMTalkEvents[]

Return an array listing the events for which the emitter has registered listeners.

Returns

keyof NIMTalkEvents[]

Inherited from

EventEmitter.eventNames

Defined in

node_modules/eventemitter3/index.d.ts:15

---

listeners

▸ listeners<T>(event): (...args: ArgumentMap<NIMTalkEvents>[Extract<T, keyof NIMTalkEvents>]) => void[]

Return the listeners registered for a given event.

Type parameters

Name	Type
T	extends keyof NIMTalkEvents

Parameters

Name	Type
event	T

Returns

(...args: ArgumentMap<NIMTalkEvents>[Extract<T, keyof NIMTalkEvents>]) => void[]

Inherited from

EventEmitter.listeners

Defined in

node_modules/eventemitter3/index.d.ts:20

---

listenerCount

▸ listenerCount(event): number

Return the number of listeners listening to a given event.

Parameters

Name	Type
event	keyof NIMTalkEvents

Returns

number

Inherited from

EventEmitter.listenerCount

Defined in

node_modules/eventemitter3/index.d.ts:27

---

emit

▸ emit<T>(event, ...args): boolean

Calls each of the listeners registered for a given event.

Type parameters

Name	Type
T	extends keyof NIMTalkEvents

Parameters

Name	Type
event	T
...args	ArgumentMap<NIMTalkEvents>[Extract<T, keyof NIMTalkEvents>]

Returns

boolean

Inherited from

EventEmitter.emit

Defined in

node_modules/eventemitter3/index.d.ts:32

---

on

▸ on<T>(event, fn, context?): NIMTalk

Add a listener for a given event.

Type parameters

Name	Type
T	extends keyof NIMTalkEvents

Parameters

Name	Type
event	T
fn	(...args: ArgumentMap<NIMTalkEvents>[Extract<T, keyof NIMTalkEvents>]) => void
context?	any

Returns

NIMTalk

Inherited from

EventEmitter.on

Defined in

node_modules/eventemitter3/index.d.ts:40

---

addListener

▸ addListener<T>(event, fn, context?): NIMTalk

Type parameters

Name	Type
T	extends keyof NIMTalkEvents

Parameters

Name	Type
event	T
fn	(...args: ArgumentMap<NIMTalkEvents>[Extract<T, keyof NIMTalkEvents>]) => void
context?	any

Returns

NIMTalk

Inherited from

EventEmitter.addListener

Defined in

node_modules/eventemitter3/index.d.ts:45

---

once

▸ once<T>(event, fn, context?): NIMTalk

Add a one-time listener for a given event.

Type parameters

Name	Type
T	extends keyof NIMTalkEvents

Parameters

Name	Type
event	T
fn	(...args: ArgumentMap<NIMTalkEvents>[Extract<T, keyof NIMTalkEvents>]) => void
context?	any

Returns

NIMTalk

Inherited from

EventEmitter.once

Defined in

node_modules/eventemitter3/index.d.ts:54

---

removeListener

▸ removeListener<T>(event, fn?, context?, once?): NIMTalk

Remove the listeners of a given event.

Type parameters

Name	Type
T	extends keyof NIMTalkEvents

Parameters

Name	Type
event	T
fn?	(...args: ArgumentMap<NIMTalkEvents>[Extract<T, keyof NIMTalkEvents>]) => void
context?	any
once?	boolean

Returns

NIMTalk

Inherited from

EventEmitter.removeListener

Defined in

node_modules/eventemitter3/index.d.ts:63

---

off

▸ off<T>(event, fn?, context?, once?): NIMTalk

Type parameters

Name	Type
T	extends keyof NIMTalkEvents

Parameters

Name	Type
event	T
fn?	(...args: ArgumentMap<NIMTalkEvents>[Extract<T, keyof NIMTalkEvents>]) => void
context?	any
once?	boolean

Returns

NIMTalk

Inherited from

EventEmitter.off

Defined in

node_modules/eventemitter3/index.d.ts:69

---

removeAllListeners

▸ removeAllListeners(event?): NIMTalk

Remove all listeners, or those of the specified event.

Parameters

Name	Type
event?	keyof NIMTalkEvents

Returns

NIMTalk

Inherited from

EventEmitter.removeAllListeners

Defined in

node_modules/eventemitter3/index.d.ts:79

---

initEventHandlers

▸ initEventHandlers(): void

注册全局回调

Returns

void

Defined in

ts/nim/talk.ts:38

---

sendMsg

▸ sendMsg(msg, jsonExtension): void

发送消息

Parameters

Name	Type	Description
msg	IMMessage	-
jsonExtension	string	json扩展参数（备用,目前不需要）

Returns

void

void 无返回值

Defined in

ts/nim/talk.ts:48

---

stopSendMsg

▸ stopSendMsg(clientMsgId, type, jsonExtension): void

停止正在发送中的消息（目前只支持发送文件消息时的终止）

Parameters

Name	Type	Description
clientMsgId	string	-
type	NIMMessageType	停止发送的消息类型
jsonExtension	string	json扩展参数（备用,目前不需要）

Returns

void

void 无返回值

Defined in

ts/nim/talk.ts:58

---

recallMsg

▸ recallMsg(msg, notify_msg, cb, apnstext, pushpayloadconst, jsonExtension): Promise<[NIMResCode, RecallMsgNotify[]]>

撤回消息

Note

200:成功
414:参数错误
508:撤回时间超过配制有效期，默认是2分钟
10414:本地错误码，参数错误
10508:本地错误码,超过配置有效期或者所需参数不存在

Parameters

Name	Type	Description
msg	IMMessage	消息
notify_msg	string	自定义通知消息
cb	null | RecallMsgsCallback	回调
apnstext	string	-
pushpayloadconst	string	-
jsonExtension	string	-

Returns

Promise<[NIMResCode, RecallMsgNotify[]]>

Defined in

ts/nim/talk.ts:76

---

getAttachmentPathFromMsg

▸ getAttachmentPathFromMsg(msg): string

从消息体中获取附件（图片、语音、视频等）的本地路径

Parameters

Name	Type	Description
msg	IMMessage	消息

Returns

string

string 消息如果有附件，不管是否已下载，返回附件的本地路径；消息如果没有附件，返回空字符串。

Defined in

ts/nim/talk.ts:105

---

replyMessage

▸ replyMessage(msg, json_reply_msg): void

回复消息thread 聊天场景

Parameters

Name	Type	Description
msg	IMMessage	被回复消息的消息体
json_reply_msg	string	回复消息的消息体,可通过各种createxxxmessage接口创建

Returns

void

void 无返回值

Defined in

ts/nim/talk.ts:115

---

regMessageFilter

▸ regMessageFilter(cb, jsonExtension): void

(全局回调)注册消息过滤接口 （堵塞线程，谨慎使用，避免耗时行为） @param[in] filter 过滤接口 @param[in] json_extension json扩展参数（备用,目前不需要）

Parameters

Name	Type
cb	null | MessageFilterCallback
jsonExtension	string

Returns

void

void 无返回值

Defined in

ts/nim/talk.ts:124

---

regTeamNotificationFilter

▸ regTeamNotificationFilter(cb, jsonExtension): void

(全局回调)注册群通知过滤接口 （堵塞线程，谨慎使用，避免耗时行为） @param[in] json_extension json扩展参数（备用,目前不需要） @param[in] filter 过滤接口

Parameters

Name	Type
cb	null | TeamNotificationFilterCallback
jsonExtension	string

Returns

void

void 无返回值

Defined in

ts/nim/talk.ts:133

Properties

talk

• talk: NIMTalkAPI

Defined in

ts/nim/talk.ts:31

Constructors

constructor

• new NIMTalk()

Overrides

EventEmitter<NIMTalkEvents&gt;.constructor

Defined in

ts/nim/talk.ts:32