-
Notifications
You must be signed in to change notification settings - Fork 2
qchat.channel.QChatChannelModule
qchat/channel.QChatChannelModule
-
EventEmitter
<QChatChannelEvents
>↳
QChatChannelModule
- eventNames
- listeners
- listenerCount
- emit
- on
- addListener
- once
- removeListener
- off
- removeAllListeners
- initEventHandlers
- createChannel
- deleteChannel
- updateChannel
- updateCategoryInfo
- subscribe
- subscribeAsVisitor
- queryUnreadInfo
- getChannels
- getChannelsByPage
- getMembersByPage
- updateWhiteBlackRole
- updateWhiteBlackMembers
- getWhiteBlackRolesPage
- getWhiteBlackMembersPage
- getExistingWhiteBlackRoles
- getExistingWhiteBlackMembers
- channelSearchByPage
- channelMemberSearch
- updateRTCInfo
- getRTCInfo
- getRTCOnlineMembers
▸ eventNames(): "unread"
[]
Return an array listing the events for which the emitter has registered listeners.
"unread"
[]
EventEmitter.eventNames
node_modules/eventemitter3/index.d.ts:15
▸ listeners<T
>(event
): (...args
: ArgumentMap
<QChatChannelEvents
>[Extract
<T
, "unread"
>]) => void
[]
Return the listeners registered for a given event.
Name | Type |
---|---|
T |
extends "unread"
|
Name | Type |
---|---|
event |
T |
(...args
: ArgumentMap
<QChatChannelEvents
>[Extract
<T
, "unread"
>]) => 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 |
"unread" |
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 "unread"
|
Name | Type |
---|---|
event |
T |
...args |
ArgumentMap <QChatChannelEvents >[Extract <T , "unread" >] |
boolean
EventEmitter.emit
node_modules/eventemitter3/index.d.ts:32
▸ on<T
>(event
, fn
, context?
): QChatChannelModule
Add a listener for a given event.
Name | Type |
---|---|
T |
extends "unread"
|
Name | Type |
---|---|
event |
T |
fn |
(...args : ArgumentMap <QChatChannelEvents >[Extract <T , "unread" >]) => void
|
context? |
any |
EventEmitter.on
node_modules/eventemitter3/index.d.ts:40
▸ addListener<T
>(event
, fn
, context?
): QChatChannelModule
Name | Type |
---|---|
T |
extends "unread"
|
Name | Type |
---|---|
event |
T |
fn |
(...args : ArgumentMap <QChatChannelEvents >[Extract <T , "unread" >]) => void
|
context? |
any |
EventEmitter.addListener
node_modules/eventemitter3/index.d.ts:45
▸ once<T
>(event
, fn
, context?
): QChatChannelModule
Add a one-time listener for a given event.
Name | Type |
---|---|
T |
extends "unread"
|
Name | Type |
---|---|
event |
T |
fn |
(...args : ArgumentMap <QChatChannelEvents >[Extract <T , "unread" >]) => void
|
context? |
any |
EventEmitter.once
node_modules/eventemitter3/index.d.ts:54
▸ removeListener<T
>(event
, fn?
, context?
, once?
): QChatChannelModule
Remove the listeners of a given event.
Name | Type |
---|---|
T |
extends "unread"
|
Name | Type |
---|---|
event |
T |
fn? |
(...args : ArgumentMap <QChatChannelEvents >[Extract <T , "unread" >]) => void
|
context? |
any |
once? |
boolean |
EventEmitter.removeListener
node_modules/eventemitter3/index.d.ts:63
▸ off<T
>(event
, fn?
, context?
, once?
): QChatChannelModule
Name | Type |
---|---|
T |
extends "unread"
|
Name | Type |
---|---|
event |
T |
fn? |
(...args : ArgumentMap <QChatChannelEvents >[Extract <T , "unread" >]) => void
|
context? |
any |
once? |
boolean |
EventEmitter.off
node_modules/eventemitter3/index.d.ts:69
▸ removeAllListeners(event?
): QChatChannelModule
Remove all listeners, or those of the specified event.
Name | Type |
---|---|
event? |
"unread" |
EventEmitter.removeAllListeners
node_modules/eventemitter3/index.d.ts:79
▸ initEventHandlers(): void
注册全局回调
void
ts/qchat/channel.ts:61
▸ createChannel(param
): Promise
<QChatChannelCreateResp
>
Fn
createChannel(param: QChatChannelCreateParam) 创建频道 @param[in] param 接口参数
Name | Type |
---|---|
param |
QChatChannelCreateParam |
Promise
<QChatChannelCreateResp
>
void
ts/qchat/channel.ts:69
▸ deleteChannel(param
): Promise
<QChatBaseResp
>
Fn
deleteChannel(param: QChatChannelDeleteParam) 删除频道 @param[in] param 接口参数
Name | Type |
---|---|
param |
QChatChannelDeleteParam |
Promise
<QChatBaseResp
>
void
ts/qchat/channel.ts:84
▸ updateChannel(param
): Promise
<QChatChannelCreateResp
>
Fn
updateChannel(param: QChatChannelUpdateParam) 更新频道 @param[in] param 接口参数
Name | Type |
---|---|
param |
QChatChannelUpdateParam |
Promise
<QChatChannelCreateResp
>
void
ts/qchat/channel.ts:99
▸ updateCategoryInfo(param
): Promise
<QChatChannelCreateResp
>
Fn
updateCategoryInfo(param: QChatChannelUpdateCategoryInfoParam) 更新频道的分组信息 @param[in] param 接口参数
Name | Type |
---|---|
param |
QChatChannelUpdateCategoryInfoParam |
Promise
<QChatChannelCreateResp
>
void
ts/qchat/channel.ts:114
▸ subscribe(param
): Promise
<QChatChannelSubscribeResp
>
Fn
subscribe(param: QChatChannelSubscribeParam) 订阅频道未读状态、未读数或未读消息、事件 @param[in] param 接口参数
Name | Type |
---|---|
param |
QChatChannelSubscribeParam |
Promise
<QChatChannelSubscribeResp
>
void
ts/qchat/channel.ts:129
▸ subscribeAsVisitor(param
): Promise
<QChatChannelSubscribeAsVisitorResp
>
Fn
subscribeAsVisitor(param: QChatChannelSubscribeAsVisitorParam) 以游客模式订阅频道未读状态、未读数或未读消息、事件 @param[in] param 接口参数
Name | Type |
---|---|
param |
QChatChannelSubscribeAsVisitorParam |
Promise
<QChatChannelSubscribeAsVisitorResp
>
void
ts/qchat/channel.ts:144
▸ queryUnreadInfo(param
): Promise
<QChatChannelQueryUnreadInfoResp
>
Fn
queryUnreadInfo(param: QChatChannelQueryUnreadInfoParam) 查询消息未读数 @param[in] param 接口参数
Name | Type |
---|---|
param |
QChatChannelQueryUnreadInfoParam |
Promise
<QChatChannelQueryUnreadInfoResp
>
void
ts/qchat/channel.ts:159
▸ getChannels(param
): Promise
<QChatChannelGetChannelsResp
>
Fn
getChannels(param: QChatChannelGetChannelsParam) 查询频道列表 @param[in] param 接口参数
Name | Type |
---|---|
param |
QChatChannelGetChannelsParam |
Promise
<QChatChannelGetChannelsResp
>
void
ts/qchat/channel.ts:174
▸ getChannelsByPage(param
): Promise
<QChatChannelGetChannelsPageResp
>
Fn
getChannelsByPage(param: QChatChannelGetChannelsPageParam) 查询频道列表(分页) @param[in] param 接口参数
Name | Type |
---|---|
param |
QChatChannelGetChannelsPageParam |
Promise
<QChatChannelGetChannelsPageResp
>
void
ts/qchat/channel.ts:189
▸ getMembersByPage(param
): Promise
<QChatServerGetMembersPageResp
>
Fn
getMembersByPage(param: QChatChannelGetMembersPageParam) 查询频道用户列表(分页),与查询服务器成员不同,查询频道成员指可以查看该频道的成员信息,取决于频道的白/黑名单设置 私有频道设置的白名单用户为该频道下的成员,公共频道除了黑名单中的成员均可以访问该频道 @param[in] param 接口参数
Name | Type |
---|---|
param |
QChatChannelGetMembersPageParam |
Promise
<QChatServerGetMembersPageResp
>
void
ts/qchat/channel.ts:205
▸ updateWhiteBlackRole(param
): Promise
<QChatBaseResp
>
Fn
updateWhiteBlackRole(param: QChatChannelUpdateWhiteBlackRoleParam) 更新频道白/黑名单身份组,公开频道:黑名单,私有频道:白名单 @param[in] param 接口参数
Name | Type |
---|---|
param |
QChatChannelUpdateWhiteBlackRoleParam |
Promise
<QChatBaseResp
>
void
ts/qchat/channel.ts:220
▸ updateWhiteBlackMembers(param
): Promise
<QChatBaseResp
>
Fn
updateWhiteBlackMembers(param: QChatChannelUpdateWhiteBlackMembersParam) 更新频道白/黑名单成员,公开频道:黑名单,私有频道:白名单 @param[in] param 接口参数
Name | Type |
---|---|
param |
QChatChannelUpdateWhiteBlackMembersParam |
Promise
<QChatBaseResp
>
void
ts/qchat/channel.ts:235
▸ getWhiteBlackRolesPage(param
): Promise
<QChatChannelGetWhiteBlackRolesPageResp
>
Fn
getWhiteBlackRolesPage(param: QChatChannelGetWhiteBlackRolesPageParam) 查询频道白/黑名单身份组列表(分页) @param[in] param 接口参数
Name | Type |
---|---|
param |
QChatChannelGetWhiteBlackRolesPageParam |
Promise
<QChatChannelGetWhiteBlackRolesPageResp
>
void
ts/qchat/channel.ts:250
▸ getWhiteBlackMembersPage(param
): Promise
<QChatChannelGetWhiteBlackMembersPageResp
>
Fn
getWhiteBlackMembersPage(param: QChatChannelGetWhiteBlackMembersPageParam) 查询频道白/黑名单成员列表(分页) @param[in] param 接口参数
Name | Type |
---|---|
param |
QChatChannelGetWhiteBlackMembersPageParam |
Promise
<QChatChannelGetWhiteBlackMembersPageResp
>
void
ts/qchat/channel.ts:265
▸ getExistingWhiteBlackRoles(param
): Promise
<QChatChannelGetExistingWhiteBlackRolesResp
>
Fn
getExistingWhiteBlackRoles(param: QChatChannelGetExistingWhiteBlackRolesParam) 根据身份组ID查询已存在的白/黑名单身份组 @param[in] param 接口参数
Name | Type |
---|---|
param |
QChatChannelGetExistingWhiteBlackRolesParam |
Promise
<QChatChannelGetExistingWhiteBlackRolesResp
>
void
ts/qchat/channel.ts:280
▸ getExistingWhiteBlackMembers(param
): Promise
<QChatChannelGetExistingWhiteBlackMembersResp
>
Fn
getExistingWhiteBlackMembers(param: QChatChannelGetExistingWhiteBlackMembersParam) 根据成员ID查询已存在的白/黑名单成员 @param[in] param 接口参数
Name | Type |
---|---|
param |
QChatChannelGetExistingWhiteBlackMembersParam |
Promise
<QChatChannelGetExistingWhiteBlackMembersResp
>
void
ts/qchat/channel.ts:295
▸ channelSearchByPage(param
): Promise
<QChatChannelGetChannelsPageResp
>
Fn
channelSearchByPage(param: QChatChannelSearchByPageParam) 根据关键字搜索频道列表(分页) @param[in] param 接口参数
Name | Type |
---|---|
param |
QChatChannelSearchPageParam |
Promise
<QChatChannelGetChannelsPageResp
>
void
ts/qchat/channel.ts:310
▸ channelMemberSearch(param
): Promise
<QChatServerGetMembersResp
>
Fn
channelMemberSearch(param: QChatChannelMemberSearchParam) 根据关键字搜索频道成员列表 @param[in] param 接口参数
Name | Type |
---|---|
param |
QChatChannelMemberSearchParam |
Promise
<QChatServerGetMembersResp
>
void
ts/qchat/channel.ts:325
▸ updateRTCInfo(param
): Promise
<QChatBaseResp
>
Fn
updateRTCInfo(param: QChatChannelUpdateRTCInfoParam) 更新频道RTC信息 @param[in] param 接口参数
Name | Type |
---|---|
param |
QChatChannelUpdateRTCInfoParam |
Promise
<QChatBaseResp
>
void
ts/qchat/channel.ts:340
▸ getRTCInfo(param
): Promise
<QChatChannelGetRTCInfoResp
>
Fn
getRTCInfo(param: QChatChannelGetRTCInfoParam) 查询频道RTC信息 @param[in] param 接口参数
Name | Type |
---|---|
param |
QChatChannelGetRTCInfoParam |
Promise
<QChatChannelGetRTCInfoResp
>
void
ts/qchat/channel.ts:355
▸ getRTCOnlineMembers(param
): Promise
<QChatChannelGetRTCOnlineMembersResp
>
Fn
getRTCOnlineMembers(param: QChatChannelGetRTCOnlineMembersParam) 查询频道RTC在线成员列表 @param[in] param 接口参数
Name | Type |
---|---|
param |
QChatChannelGetRTCOnlineMembersParam |
Promise
<QChatChannelGetRTCOnlineMembersResp
>
void
ts/qchat/channel.ts:370
• instance: any
ts/qchat/channel.ts:55
• new QChatChannelModule()
EventEmitter<QChatChannelEvents>.constructor
ts/qchat/channel.ts:56
- 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