-
Notifications
You must be signed in to change notification settings - Fork 2
qchat.system_notification.QChatSystemNotificationModule
qchat/system_notification.QChatSystemNotificationModule
-
EventEmitter<QChatSystemNotificationEvents>↳
QChatSystemNotificationModule
- eventNames
- listeners
- listenerCount
- emit
- on
- addListener
- once
- removeListener
- off
- removeAllListeners
- initEventHandlers
- send
- update
- markSystemNotificationsRead
- sendTypingEvent
▸ eventNames(): keyof QChatSystemNotificationEvents[]
Return an array listing the events for which the emitter has registered listeners.
keyof QChatSystemNotificationEvents[]
EventEmitter.eventNames
node_modules/eventemitter3/index.d.ts:15
▸ listeners<T>(event): (...args: ArgumentMap<QChatSystemNotificationEvents>[Extract<T, keyof QChatSystemNotificationEvents>]) => void[]
Return the listeners registered for a given event.
| Name | Type |
|---|---|
T |
extends keyof QChatSystemNotificationEvents
|
| Name | Type |
|---|---|
event |
T |
(...args: ArgumentMap<QChatSystemNotificationEvents>[Extract<T, keyof QChatSystemNotificationEvents>]) => 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 QChatSystemNotificationEvents
|
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 QChatSystemNotificationEvents
|
| Name | Type |
|---|---|
event |
T |
...args |
ArgumentMap<QChatSystemNotificationEvents>[Extract<T, keyof QChatSystemNotificationEvents>] |
boolean
EventEmitter.emit
node_modules/eventemitter3/index.d.ts:32
▸ on<T>(event, fn, context?): QChatSystemNotificationModule
Add a listener for a given event.
| Name | Type |
|---|---|
T |
extends keyof QChatSystemNotificationEvents
|
| Name | Type |
|---|---|
event |
T |
fn |
(...args: ArgumentMap<QChatSystemNotificationEvents>[Extract<T, keyof QChatSystemNotificationEvents>]) => void
|
context? |
any |
EventEmitter.on
node_modules/eventemitter3/index.d.ts:40
▸ addListener<T>(event, fn, context?): QChatSystemNotificationModule
| Name | Type |
|---|---|
T |
extends keyof QChatSystemNotificationEvents
|
| Name | Type |
|---|---|
event |
T |
fn |
(...args: ArgumentMap<QChatSystemNotificationEvents>[Extract<T, keyof QChatSystemNotificationEvents>]) => void
|
context? |
any |
EventEmitter.addListener
node_modules/eventemitter3/index.d.ts:45
▸ once<T>(event, fn, context?): QChatSystemNotificationModule
Add a one-time listener for a given event.
| Name | Type |
|---|---|
T |
extends keyof QChatSystemNotificationEvents
|
| Name | Type |
|---|---|
event |
T |
fn |
(...args: ArgumentMap<QChatSystemNotificationEvents>[Extract<T, keyof QChatSystemNotificationEvents>]) => void
|
context? |
any |
EventEmitter.once
node_modules/eventemitter3/index.d.ts:54
▸ removeListener<T>(event, fn?, context?, once?): QChatSystemNotificationModule
Remove the listeners of a given event.
| Name | Type |
|---|---|
T |
extends keyof QChatSystemNotificationEvents
|
| Name | Type |
|---|---|
event |
T |
fn? |
(...args: ArgumentMap<QChatSystemNotificationEvents>[Extract<T, keyof QChatSystemNotificationEvents>]) => void
|
context? |
any |
once? |
boolean |
EventEmitter.removeListener
node_modules/eventemitter3/index.d.ts:63
▸ off<T>(event, fn?, context?, once?): QChatSystemNotificationModule
| Name | Type |
|---|---|
T |
extends keyof QChatSystemNotificationEvents
|
| Name | Type |
|---|---|
event |
T |
fn? |
(...args: ArgumentMap<QChatSystemNotificationEvents>[Extract<T, keyof QChatSystemNotificationEvents>]) => void
|
context? |
any |
once? |
boolean |
EventEmitter.off
node_modules/eventemitter3/index.d.ts:69
▸ removeAllListeners(event?): QChatSystemNotificationModule
Remove all listeners, or those of the specified event.
| Name | Type |
|---|---|
event? |
keyof QChatSystemNotificationEvents
|
EventEmitter.removeAllListeners
node_modules/eventemitter3/index.d.ts:79
▸ initEventHandlers(): void
注册全局回调
void
ts/qchat/system_notification.ts:33
▸ send(param): Promise<QChatSendSystemNotificationResp>
Fn
send(param: QChatSendSystemNotificationParam) 发送系统消息 @param[in] param 接口参数
| Name | Type |
|---|---|
param |
QChatSendSystemNotificationParam |
Promise<QChatSendSystemNotificationResp>
void
ts/qchat/system_notification.ts:41
▸ update(param): Promise<QChatUpdateSystemNotificationResp>
Fn
update(param: QChatUpdateSystemNotificationParam)
Brief
更新系统消息 @param[in] param 接口参数
| Name | Type |
|---|---|
param |
QChatUpdateSystemNotificationParam |
Promise<QChatUpdateSystemNotificationResp>
ts/qchat/system_notification.ts:55
▸ markSystemNotificationsRead(param): Promise<QChatBaseResp>
Fn
markSystemNotificationsRead(param: QChatMarkSystemNotificationsReadParam)
Brief
标记系统通知消息已读
| Name | Type | Description |
|---|---|---|
param |
QChatMarkSystemNotificationsReadParam |
接口参数 |
Promise<QChatBaseResp>
void
ts/qchat/system_notification.ts:70
▸ sendTypingEvent(param): Promise<QChatSendTypingEventResp>
Fn
sendTypingEvent(param: QChatSendTypingEventParam)
Brief
发送正在输入事件
| Name | Type | Description |
|---|---|---|
param |
QChatSendTypingEventParam |
接口参数 |
Promise<QChatSendTypingEventResp>
void
ts/qchat/system_notification.ts:85
• instance: any
ts/qchat/system_notification.ts:27
• new QChatSystemNotificationModule()
EventEmitter<QChatSystemNotificationEvents>.constructor
ts/qchat/system_notification.ts:28
- 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