Interface QChatChannelServiceInterface

Hierarchy

QChatChannelServiceInterface

Methods

channelMemberSearch

channelMemberSearch(options: QChatChannelMemberSearchOptions): Promise<QChatChannelMemberInfo[]>

检索频道

Parameters
- options: QChatChannelMemberSearchOptions
Returns Promise<QChatChannelMemberInfo[]>

createChannel

createChannel(options: CreateChannelOptions): Promise<ChannelInfo>

创建频道

Parameters
- options: CreateChannelOptions
Returns Promise<ChannelInfo>

createChannelCategory

createChannelCategory(options: CreateChannelCategoryOptions): Promise<QChatChannelCategoryInfo>

创建"频道分组"

Parameters
- options: CreateChannelCategoryOptions
Returns Promise<QChatChannelCategoryInfo>

deleteChannel

deleteChannel(options: DeleteChannelOptions): Promise<void>

删除建频道

Parameters
- options: DeleteChannelOptions
Returns Promise<void>

getChannelCategoriesByID

getChannelCategoriesByID(options: GetChannelCategoriesByIDOptions): Promise<QChatChannelCategoryInfo[]>

根据分组ID查询"频道分组"

Parameters
- options: GetChannelCategoriesByIDOptions
Returns Promise<QChatChannelCategoryInfo[]>

getChannelCategoriesPage

getChannelCategoriesPage(options: GetChannelCategoriesPageOptions): Promise<GetChannelCategoriesPageResult>

查询"频道分组"列表

Parameters
- options: GetChannelCategoriesPageOptions
Returns Promise<GetChannelCategoriesPageResult>

getChannelCategoryChannelsPage

getChannelCategoryChannelsPage(options: GetChannelCategoryChannelsPageOptions): Promise<GetChannelCategoryChannelsPageResult>

查询"频道分组"下频道列表

Parameters
- options: GetChannelCategoryChannelsPageOptions
Returns Promise<GetChannelCategoryChannelsPageResult>

getChannelCategoryWhiteBlackMembers

getChannelCategoryWhiteBlackMembers(options: GetChannelCategoryWhiteBlackMembersOptions): Promise<MemberInfo[]>

根据成员ID查询"频道分组"白/黑名单成员列表

Parameters
- options: GetChannelCategoryWhiteBlackMembersOptions
Returns Promise<MemberInfo[]>

getChannelCategoryWhiteBlackMembersPage

getChannelCategoryWhiteBlackMembersPage(options: GetChannelCategoryWhiteBlackMembersPageOptions): Promise<GetChannelCategoryWhiteBlackMembersPageResult>

查询"频道分组"白/黑名单成员列表(分页)

Parameters
- options: GetChannelCategoryWhiteBlackMembersPageOptions
Returns Promise<GetChannelCategoryWhiteBlackMembersPageResult>

getChannelCategoryWhiteBlackRoles

getChannelCategoryWhiteBlackRoles(options: GetChannelCategoryWhiteBlackRolesOptions): Promise<QChatServerRole[]>

根据身份组ID查询"频道分组"白/黑名单身份组列表

Parameters
- options: GetChannelCategoryWhiteBlackRolesOptions
Returns Promise<QChatServerRole[]>

getChannelCategoryWhiteBlackRolesPage

getChannelCategoryWhiteBlackRolesPage(options: GetChannelCategoryWhiteBlackRolesPageOptions): Promise<GetChannelCategoryWhiteBlackRolesPageResult>

查询"频道分组"白/黑名单身份组列表(分页)

Parameters
- options: GetChannelCategoryWhiteBlackRolesPageOptions
Returns Promise<GetChannelCategoryWhiteBlackRolesPageResult>

getChannelSearchByPage

getChannelSearchByPage(options: GetChannelSearchByPageOptions): Promise<GetChannelSearchByPageResult>

检索频道

Parameters
- options: GetChannelSearchByPageOptions
Returns Promise<GetChannelSearchByPageResult>

getChannelUnreadInfos

getChannelUnreadInfos(options: GetUnreadInfoOptions): Promise<QChatChannelUnreadInfo[]>

查询未读信息

Parameters
- options: GetUnreadInfoOptions
Returns Promise<QChatChannelUnreadInfo[]>

getChannels

getChannels(options: GetChannelsOptions): Promise<ChannelInfo[]>

查询频道列表

Parameters
- options: GetChannelsOptions
Returns Promise<ChannelInfo[]>

getChannelsByPage

getChannelsByPage(options: GetChannelsByPageOptions): Promise<GetChannelsByPageResult>

查询频道列表（分页）

Parameters
- options: GetChannelsByPageOptions
Returns Promise<GetChannelsByPageResult>

getExistingWhiteBlackMembers

getExistingWhiteBlackMembers(options: GetExistingWhiteBlackMembersOptions): Promise<GetExistingWhiteBlackMembersResult>

根据成员ID查询已存在的白/黑名单的成员

Parameters
- options: GetExistingWhiteBlackMembersOptions
Returns Promise<GetExistingWhiteBlackMembersResult>

getExistingWhiteBlackRoles

getExistingWhiteBlackRoles(options: GetExistingWhiteBlackRolesOptions): Promise<GetExistingWhiteBlackRolesResult>

根据身份组ID查询已存在的白/黑名单身份组

Parameters
- options: GetExistingWhiteBlackRolesOptions
Returns Promise<GetExistingWhiteBlackRolesResult>

getMembersByPage

getMembersByPage(options: GetMembersByPageOptions): Promise<GetMembersByPageResult>

获取频道下的成员（分页）

Parameters
- options: GetMembersByPageOptions
Returns Promise<GetMembersByPageResult>

getWhiteBlackMembersPage

getWhiteBlackMembersPage(options: GetWhiteBlackMembersPageOptions): Promise<GetWhiteBlackMembersPageResult>

分页查询频道的白/黑名单成员

Parameters
- options: GetWhiteBlackMembersPageOptions
Returns Promise<GetWhiteBlackMembersPageResult>

getWhiteBlackRolesPage

getWhiteBlackRolesPage(options: GetWhiteBlackRolesPageOptions): Promise<GetWhiteBlackRolesPageResult>

分页查询频道的白/黑名单身份组

Parameters
- options: GetWhiteBlackRolesPageOptions
Returns Promise<GetWhiteBlackRolesPageResult>

removeChannelCategory

removeChannelCategory(options: RemoveChannelCategoryOptions): Promise<void>

删除"频道分组"

Parameters
- options: RemoveChannelCategoryOptions
Returns Promise<void>

subscribeChannel

subscribeChannel(options: SubscribeChannelOptions): Promise<void | SubscribeChannelResult>

订阅频道

注：仅当 type 为 5 时返回 undefined，而 type 为 1，2，3 时返回 UnreadInfo[]。

Parameters
- options: SubscribeChannelOptions
Returns Promise<void | SubscribeChannelResult>

updateCategoryInfoOfChannel

updateCategoryInfoOfChannel(options: UpdateCategoryInfoOfChannelOptions): Promise<ChannelInfo>

修改频道信息中的"频道分组"相关字段

Parameters
- options: UpdateCategoryInfoOfChannelOptions
Returns Promise<ChannelInfo>

updateChannel

updateChannel(options: UpdateChannelOptions): Promise<ChannelInfo>

更新频道

Parameters
- options: UpdateChannelOptions
Returns Promise<ChannelInfo>

updateChannelCategory

updateChannelCategory(options: UpdateChannelCategoryOptions): Promise<QChatChannelCategoryInfo>

更新""频道分组""

Parameters
- options: UpdateChannelCategoryOptions
Returns Promise<QChatChannelCategoryInfo>

updateChannelCategoryWhiteBlackMembers

updateChannelCategoryWhiteBlackMembers(options: UpdateChannelCategoryWhiteBlackMembersOptions): Promise<void>

更新"频道分组"白/黑名单成员

Parameters
- options: UpdateChannelCategoryWhiteBlackMembersOptions
Returns Promise<void>

updateChannelCategoryWhiteBlackRole

updateChannelCategoryWhiteBlackRole(options: UpdateChannelCategoryWhiteBlackRoleOptions): Promise<void>

更新"频道分组"白/黑名单身份组

Parameters
- options: UpdateChannelCategoryWhiteBlackRoleOptions
Returns Promise<void>

updateWhiteBlackMembers

updateWhiteBlackMembers(options: UpdateWhiteBlackMembersOptions): Promise<void>

更新频道的白/黑名单成员
1. 针对公开的频道 {@link ChannelInfo.viewMode | ChannelInfo.viewMode} 为 0，那么设置的成员在此公开频道的黑名单。此成员将无法查到此频道的信息
2. 针对私密的频道 {@link ChannelInfo.viewMode | ChannelInfo.viewMode} 为 1，那么设置的成员在此私密频道的白名单。此成员将可以查到此频道的信息
Parameters
- options: UpdateWhiteBlackMembersOptions
Returns Promise<void>

updateWhiteBlackRole

updateWhiteBlackRole(options: UpdateWhiteBlackRoleOptions): Promise<void>

更新频道的白/黑名单身份组
1. 针对公开的频道 {@link ChannelInfo.viewMode | ChannelInfo.viewMode} 为 0，那么设置的身份组在此公开频道的黑名单。此身份组用户将无法查到此频道的信息
2. 针对私密的频道 {@link ChannelInfo.viewMode | ChannelInfo.viewMode} 为 1，那么设置的身份组在此私密频道的白名单。此身份组用户将可以查到此频道的信息
Parameters
- options: UpdateWhiteBlackRoleOptions
Returns Promise<void>