qchat.channel.QChatChannelModule

Class: QChatChannelModule

qchat/channel.QChatChannelModule

Hierarchy

• EventEmitter<QChatChannelEvents>

  ↳ QChatChannelModule

Table of contents

Methods

• 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

Properties

• instance

Constructors

• constructor

Methods

eventNames

▸ eventNames(): "unread"[]

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

Returns

"unread"[]

Inherited from

EventEmitter.eventNames

Defined in

node_modules/eventemitter3/index.d.ts:15

---

listeners

▸ listeners<T>(event): (...args: ArgumentMap<QChatChannelEvents>[Extract<T, "unread">]) => void[]

Return the listeners registered for a given event.

Type parameters

Name	Type
T	extends "unread"

Parameters

Name	Type
event	T

Returns

(...args: ArgumentMap<QChatChannelEvents>[Extract<T, "unread">]) => 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	"unread"

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 "unread"

Parameters

Name	Type
event	T
...args	ArgumentMap<QChatChannelEvents>[Extract<T, "unread">]

Returns

boolean

Inherited from

EventEmitter.emit

Defined in

node_modules/eventemitter3/index.d.ts:32

---

on

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

Add a listener for a given event.

Type parameters

Name	Type
T	extends "unread"

Parameters

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

Returns

QChatChannelModule

Inherited from

EventEmitter.on

Defined in

node_modules/eventemitter3/index.d.ts:40

---

addListener

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

Type parameters

Name	Type
T	extends "unread"

Parameters

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

Returns

QChatChannelModule

Inherited from

EventEmitter.addListener

Defined in

node_modules/eventemitter3/index.d.ts:45

---

once

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

Add a one-time listener for a given event.

Type parameters

Name	Type
T	extends "unread"

Parameters

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

Returns

QChatChannelModule

Inherited from

EventEmitter.once

Defined in

node_modules/eventemitter3/index.d.ts:54

---

removeListener

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

Remove the listeners of a given event.

Type parameters

Name	Type
T	extends "unread"

Parameters

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

Returns

QChatChannelModule

Inherited from

EventEmitter.removeListener

Defined in

node_modules/eventemitter3/index.d.ts:63

---

off

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

Type parameters

Name	Type
T	extends "unread"

Parameters

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

Returns

QChatChannelModule

Inherited from

EventEmitter.off

Defined in

node_modules/eventemitter3/index.d.ts:69

---

removeAllListeners

▸ removeAllListeners(event?): QChatChannelModule

Remove all listeners, or those of the specified event.

Parameters

Name	Type
event?	"unread"

Returns

QChatChannelModule

Inherited from

EventEmitter.removeAllListeners

Defined in

node_modules/eventemitter3/index.d.ts:79

---

initEventHandlers

▸ initEventHandlers(): void

注册全局回调

Returns

void

Defined in

ts/qchat/channel.ts:61

---

createChannel

▸ createChannel(param): Promise<QChatChannelCreateResp>

Fn

createChannel(param: QChatChannelCreateParam) 创建频道 @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelCreateParam

Returns

Promise<QChatChannelCreateResp>

void

Defined in

ts/qchat/channel.ts:69

---

deleteChannel

▸ deleteChannel(param): Promise<QChatBaseResp>

Fn

deleteChannel(param: QChatChannelDeleteParam) 删除频道 @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelDeleteParam

Returns

Promise<QChatBaseResp>

void

Defined in

ts/qchat/channel.ts:84

---

updateChannel

▸ updateChannel(param): Promise<QChatChannelCreateResp>

Fn

updateChannel(param: QChatChannelUpdateParam) 更新频道 @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelUpdateParam

Returns

Promise<QChatChannelCreateResp>

void

Defined in

ts/qchat/channel.ts:99

---

updateCategoryInfo

▸ updateCategoryInfo(param): Promise<QChatChannelCreateResp>

Fn

updateCategoryInfo(param: QChatChannelUpdateCategoryInfoParam) 更新频道的分组信息 @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelUpdateCategoryInfoParam

Returns

Promise<QChatChannelCreateResp>

void

Defined in

ts/qchat/channel.ts:114

---

subscribe

▸ subscribe(param): Promise<QChatChannelSubscribeResp>

Fn

subscribe(param: QChatChannelSubscribeParam) 订阅频道未读状态、未读数或未读消息、事件 @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelSubscribeParam

Returns

Promise<QChatChannelSubscribeResp>

void

Defined in

ts/qchat/channel.ts:129

---

subscribeAsVisitor

▸ subscribeAsVisitor(param): Promise<QChatChannelSubscribeAsVisitorResp>

Fn

subscribeAsVisitor(param: QChatChannelSubscribeAsVisitorParam) 以游客模式订阅频道未读状态、未读数或未读消息、事件 @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelSubscribeAsVisitorParam

Returns

Promise<QChatChannelSubscribeAsVisitorResp>

void

Defined in

ts/qchat/channel.ts:144

---

queryUnreadInfo

▸ queryUnreadInfo(param): Promise<QChatChannelQueryUnreadInfoResp>

Fn

queryUnreadInfo(param: QChatChannelQueryUnreadInfoParam) 查询消息未读数 @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelQueryUnreadInfoParam

Returns

Promise<QChatChannelQueryUnreadInfoResp>

void

Defined in

ts/qchat/channel.ts:159

---

getChannels

▸ getChannels(param): Promise<QChatChannelGetChannelsResp>

Fn

getChannels(param: QChatChannelGetChannelsParam) 查询频道列表 @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelGetChannelsParam

Returns

Promise<QChatChannelGetChannelsResp>

void

Defined in

ts/qchat/channel.ts:174

---

getChannelsByPage

▸ getChannelsByPage(param): Promise<QChatChannelGetChannelsPageResp>

Fn

getChannelsByPage(param: QChatChannelGetChannelsPageParam) 查询频道列表(分页) @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelGetChannelsPageParam

Returns

Promise<QChatChannelGetChannelsPageResp>

void

Defined in

ts/qchat/channel.ts:189

---

getMembersByPage

▸ getMembersByPage(param): Promise<QChatServerGetMembersPageResp>

Fn

getMembersByPage(param: QChatChannelGetMembersPageParam) 查询频道用户列表(分页)，与查询服务器成员不同，查询频道成员指可以查看该频道的成员信息，取决于频道的白/黑名单设置 私有频道设置的白名单用户为该频道下的成员，公共频道除了黑名单中的成员均可以访问该频道 @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelGetMembersPageParam

Returns

Promise<QChatServerGetMembersPageResp>

void

Defined in

ts/qchat/channel.ts:205

---

updateWhiteBlackRole

▸ updateWhiteBlackRole(param): Promise<QChatBaseResp>

Fn

updateWhiteBlackRole(param: QChatChannelUpdateWhiteBlackRoleParam) 更新频道白/黑名单身份组，公开频道:黑名单，私有频道:白名单 @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelUpdateWhiteBlackRoleParam

Returns

Promise<QChatBaseResp>

void

Defined in

ts/qchat/channel.ts:220

---

updateWhiteBlackMembers

▸ updateWhiteBlackMembers(param): Promise<QChatBaseResp>

Fn

updateWhiteBlackMembers(param: QChatChannelUpdateWhiteBlackMembersParam) 更新频道白/黑名单成员，公开频道:黑名单，私有频道:白名单 @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelUpdateWhiteBlackMembersParam

Returns

Promise<QChatBaseResp>

void

Defined in

ts/qchat/channel.ts:235

---

getWhiteBlackRolesPage

▸ getWhiteBlackRolesPage(param): Promise<QChatChannelGetWhiteBlackRolesPageResp>

Fn

getWhiteBlackRolesPage(param: QChatChannelGetWhiteBlackRolesPageParam) 查询频道白/黑名单身份组列表(分页) @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelGetWhiteBlackRolesPageParam

Returns

Promise<QChatChannelGetWhiteBlackRolesPageResp>

void

Defined in

ts/qchat/channel.ts:250

---

getWhiteBlackMembersPage

▸ getWhiteBlackMembersPage(param): Promise<QChatChannelGetWhiteBlackMembersPageResp>

Fn

getWhiteBlackMembersPage(param: QChatChannelGetWhiteBlackMembersPageParam) 查询频道白/黑名单成员列表(分页) @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelGetWhiteBlackMembersPageParam

Returns

Promise<QChatChannelGetWhiteBlackMembersPageResp>

void

Defined in

ts/qchat/channel.ts:265

---

getExistingWhiteBlackRoles

▸ getExistingWhiteBlackRoles(param): Promise<QChatChannelGetExistingWhiteBlackRolesResp>

Fn

getExistingWhiteBlackRoles(param: QChatChannelGetExistingWhiteBlackRolesParam) 根据身份组ID查询已存在的白/黑名单身份组 @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelGetExistingWhiteBlackRolesParam

Returns

Promise<QChatChannelGetExistingWhiteBlackRolesResp>

void

Defined in

ts/qchat/channel.ts:280

---

getExistingWhiteBlackMembers

▸ getExistingWhiteBlackMembers(param): Promise<QChatChannelGetExistingWhiteBlackMembersResp>

Fn

getExistingWhiteBlackMembers(param: QChatChannelGetExistingWhiteBlackMembersParam) 根据成员ID查询已存在的白/黑名单成员 @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelGetExistingWhiteBlackMembersParam

Returns

Promise<QChatChannelGetExistingWhiteBlackMembersResp>

void

Defined in

ts/qchat/channel.ts:295

---

channelSearchByPage

▸ channelSearchByPage(param): Promise<QChatChannelGetChannelsPageResp>

Fn

channelSearchByPage(param: QChatChannelSearchByPageParam) 根据关键字搜索频道列表(分页) @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelSearchPageParam

Returns

Promise<QChatChannelGetChannelsPageResp>

void

Defined in

ts/qchat/channel.ts:310

---

channelMemberSearch

▸ channelMemberSearch(param): Promise<QChatServerGetMembersResp>

Fn

channelMemberSearch(param: QChatChannelMemberSearchParam) 根据关键字搜索频道成员列表 @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelMemberSearchParam

Returns

Promise<QChatServerGetMembersResp>

void

Defined in

ts/qchat/channel.ts:325

---

updateRTCInfo

▸ updateRTCInfo(param): Promise<QChatBaseResp>

Fn

updateRTCInfo(param: QChatChannelUpdateRTCInfoParam) 更新频道RTC信息 @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelUpdateRTCInfoParam

Returns

Promise<QChatBaseResp>

void

Defined in

ts/qchat/channel.ts:340

---

getRTCInfo

▸ getRTCInfo(param): Promise<QChatChannelGetRTCInfoResp>

Fn

getRTCInfo(param: QChatChannelGetRTCInfoParam) 查询频道RTC信息 @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelGetRTCInfoParam

Returns

Promise<QChatChannelGetRTCInfoResp>

void

Defined in

ts/qchat/channel.ts:355

---

getRTCOnlineMembers

▸ getRTCOnlineMembers(param): Promise<QChatChannelGetRTCOnlineMembersResp>

Fn

getRTCOnlineMembers(param: QChatChannelGetRTCOnlineMembersParam) 查询频道RTC在线成员列表 @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelGetRTCOnlineMembersParam

Returns

Promise<QChatChannelGetRTCOnlineMembersResp>

void

Defined in

ts/qchat/channel.ts:370

Properties

instance

• instance: any

Defined in

ts/qchat/channel.ts:55

Constructors

constructor

• new QChatChannelModule()

Overrides

EventEmitter<QChatChannelEvents&gt;.constructor

Defined in

ts/qchat/channel.ts:56