qchat.channel_category.QChatChannelCategoryModule

Class: QChatChannelCategoryModule

qchat/channel_category.QChatChannelCategoryModule

Hierarchy

• EventEmitter<QChatChannelCategoryEvents>

  ↳ QChatChannelCategoryModule

Table of contents

Methods

• eventNames
• listeners
• listenerCount
• emit
• on
• addListener
• once
• removeListener
• off
• removeAllListeners
• initEventHandlers
• createChannelCategory
• updateChannelCategory
• removeChannelCategory
• getChannelCategoriesByID
• getChannelCategoriesPage
• getChannelCategoryChannelsPage
• updateChannelCategoryWhiteBlackRole
• getExistingChannelCategoryWhiteBlackRoles
• getChannelCategoryWhiteBlackRolesPage
• updateChannelCategoryWhiteBlackMembers
• getExistingChannelCategoryWhiteBlackMembers
• getChannelCategoryWhiteBlackMembersPage

Properties

• instance

Constructors

• constructor

Methods

eventNames

▸ eventNames(): never[]

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

Returns

never[]

Inherited from

EventEmitter.eventNames

Defined in

node_modules/eventemitter3/index.d.ts:15

---

listeners

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

Return the listeners registered for a given event.

Type parameters

Name	Type
T	extends never

Parameters

Name	Type
event	T

Returns

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

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 never

Parameters

Name	Type
event	T
...args	ArgumentMap<QChatChannelCategoryEvents>[Extract<T, never>]

Returns

boolean

Inherited from

EventEmitter.emit

Defined in

node_modules/eventemitter3/index.d.ts:32

---

on

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

Add a listener for a given event.

Type parameters

Name	Type
T	extends never

Parameters

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

Returns

QChatChannelCategoryModule

Inherited from

EventEmitter.on

Defined in

node_modules/eventemitter3/index.d.ts:40

---

addListener

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

Type parameters

Name	Type
T	extends never

Parameters

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

Returns

QChatChannelCategoryModule

Inherited from

EventEmitter.addListener

Defined in

node_modules/eventemitter3/index.d.ts:45

---

once

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

Add a one-time listener for a given event.

Type parameters

Name	Type
T	extends never

Parameters

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

Returns

QChatChannelCategoryModule

Inherited from

EventEmitter.once

Defined in

node_modules/eventemitter3/index.d.ts:54

---

removeListener

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

Remove the listeners of a given event.

Type parameters

Name	Type
T	extends never

Parameters

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

Returns

QChatChannelCategoryModule

Inherited from

EventEmitter.removeListener

Defined in

node_modules/eventemitter3/index.d.ts:63

---

off

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

Type parameters

Name	Type
T	extends never

Parameters

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

Returns

QChatChannelCategoryModule

Inherited from

EventEmitter.off

Defined in

node_modules/eventemitter3/index.d.ts:69

---

removeAllListeners

▸ removeAllListeners(event?): QChatChannelCategoryModule

Remove all listeners, or those of the specified event.

Parameters

Name	Type
event?	undefined

Returns

QChatChannelCategoryModule

Inherited from

EventEmitter.removeAllListeners

Defined in

node_modules/eventemitter3/index.d.ts:79

---

initEventHandlers

▸ initEventHandlers(): void

注册全局回调

Returns

void

Defined in

ts/qchat/channel_category.ts:39

---

createChannelCategory

▸ createChannelCategory(param): Promise<QChatChannelCategoryCreateResp>

Fn

createChannelCategory(param: QChatChannelCategoryCreateParam) 创建频道分组 @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelCategoryCreateParam

Returns

Promise<QChatChannelCategoryCreateResp>

void

Defined in

ts/qchat/channel_category.ts:47

---

updateChannelCategory

▸ updateChannelCategory(param): Promise<QChatChannelCategoryCreateResp>

Fn

updateChannelCategory(param: QChatChannelCategoryUpdateParam) 更新频道分组 @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelCategoryUpdateParam

Returns

Promise<QChatChannelCategoryCreateResp>

void

Defined in

ts/qchat/channel_category.ts:62

---

removeChannelCategory

▸ removeChannelCategory(param): Promise<QChatBaseResp>

Fn

removeChannelCategory(param: QChatChannelCategoryRemoveParam) 删除频道分组 @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelCategoryRemoveParam

Returns

Promise<QChatBaseResp>

void

Defined in

ts/qchat/channel_category.ts:77

---

getChannelCategoriesByID

▸ getChannelCategoriesByID(param): Promise<QChatChannelGetCategoriesByIDResp>

Fn

getChannelCategoriesByID(param: QChatChannelGetCategoriesByIDParam) 根据分组ID查询频道分组 @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelGetCategoriesByIDParam

Returns

Promise<QChatChannelGetCategoriesByIDResp>

void

Defined in

ts/qchat/channel_category.ts:92

---

getChannelCategoriesPage

▸ getChannelCategoriesPage(param): Promise<QChatChannelGetCategoriesPageResp>

Fn

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

Parameters

Name	Type
param	QChatChannelGetCategoriesPageParam

Returns

Promise<QChatChannelGetCategoriesPageResp>

void

Defined in

ts/qchat/channel_category.ts:107

---

getChannelCategoryChannelsPage

▸ getChannelCategoryChannelsPage(param): Promise<QChatChannelGetChannelsPageResp>

Fn

getChannelCategoryChannelsPage(param: QChatChannelGetCategoryChannelsPageParam) 查询频道分组下频道列表(分页) @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelGetCategoryChannelsPageParam

Returns

Promise<QChatChannelGetChannelsPageResp>

void

Defined in

ts/qchat/channel_category.ts:122

---

updateChannelCategoryWhiteBlackRole

▸ updateChannelCategoryWhiteBlackRole(param): Promise<QChatBaseResp>

Fn

updateChannelCategoryWhiteBlackRole(param: QChatChannelCategoryUpdateWhiteBlackRoleParam) 更新频道分组白/黑名单身份组 @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelCategoryUpdateWhiteBlackRoleParam

Returns

Promise<QChatBaseResp>

void

Defined in

ts/qchat/channel_category.ts:137

---

getExistingChannelCategoryWhiteBlackRoles

▸ getExistingChannelCategoryWhiteBlackRoles(param): Promise<QChatChannelCategoryGetExistingWhiteBlackRolesResp>

Fn

getExistingChannelCategoryWhiteBlackRoles(param: QChatChannelCategoryGetExistingWhiteBlackRolesParam) 根据身份组ID查询频道分组白/黑名单身份组列表 @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelCategoryGetExistingWhiteBlackRolesParam

Returns

Promise<QChatChannelCategoryGetExistingWhiteBlackRolesResp>

void

Defined in

ts/qchat/channel_category.ts:152

---

getChannelCategoryWhiteBlackRolesPage

▸ getChannelCategoryWhiteBlackRolesPage(param): Promise<QChatChannelCategoryGetWhiteBlackRolesPageResp>

Fn

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

Parameters

Name	Type
param	QChatChannelCategoryGetWhiteBlackRolesPageParam

Returns

Promise<QChatChannelCategoryGetWhiteBlackRolesPageResp>

void

Defined in

ts/qchat/channel_category.ts:169

---

updateChannelCategoryWhiteBlackMembers

▸ updateChannelCategoryWhiteBlackMembers(param): Promise<QChatBaseResp>

Fn

updateChannelCategoryWhiteBlackMembers(param: QChatChannelCategoryUpdateWhiteBlackMembersParam) 更新频道分组白/黑名单成员 @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelCategoryUpdateWhiteBlackMembersParam

Returns

Promise<QChatBaseResp>

void

Defined in

ts/qchat/channel_category.ts:184

---

getExistingChannelCategoryWhiteBlackMembers

▸ getExistingChannelCategoryWhiteBlackMembers(param): Promise<QChatChannelCategoryGetExistingWhiteBlackMembersResp>

Fn

getExistingChannelCategoryWhiteBlackMembers(param: QChatChannelCategoryGetExistingWhiteBlackMembersParam) 根据成员ID查询频道分组白/黑名单成员列表 @param[in] param 接口参数

Parameters

Name	Type
param	QChatChannelCategoryGetExistingWhiteBlackMembersParam

Returns

Promise<QChatChannelCategoryGetExistingWhiteBlackMembersResp>

void

Defined in

ts/qchat/channel_category.ts:199

---

getChannelCategoryWhiteBlackMembersPage

▸ getChannelCategoryWhiteBlackMembersPage(param): Promise<QChatChannelCategoryGetWhiteBlackMembersPageResp>

Fn

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

Parameters

Name	Type
param	QChatChannelCategoryGetWhiteBlackMembersPageParam

Returns

Promise<QChatChannelCategoryGetWhiteBlackMembersPageResp>

void

Defined in

ts/qchat/channel_category.ts:216

Properties

instance

• instance: any

Defined in

ts/qchat/channel_category.ts:33

Constructors

constructor

• new QChatChannelCategoryModule()

Overrides

EventEmitter<QChatChannelCategoryEvents&gt;.constructor

Defined in

ts/qchat/channel_category.ts:34