Options
All
  • Public
  • Public/Protected
  • All
Menu

Module QChatChannelServiceInterface

Index

Enumerations

Interfaces

Type Aliases

Type Aliases

ChannelInfo

ChannelInfo: { categoryId: string; channelId: string; createTime: number; ext: string; name: string; owner: string; reorderWeight: string; serverId: string; syncMode: number; topic: string; type: TChannelInfoType; updateTime: number; validFlag: 0 | 1; viewMode: number }

Type declaration

  • categoryId: string

    频道类别id

  • channelId: string

    频道id

  • createTime: number

    创建时间

  • ext: string

    自定义扩展

  • name: string

    名称

  • owner: string

    所有者

  • reorderWeight: string

    自定义排序权重值

  • serverId: string

    服务器ID

  • syncMode: number

    同步模式：0-不与类别同步模式(默认)1-与类别同步模式

  • topic: string

    主题

  • type: TChannelInfoType

    类型：message-消息频道,ext-自定义频道,media-音视频频道

  • updateTime: number

    更新时间

  • validFlag: 0 | 1

    有效标志：0-无效，1-有效

  • viewMode: number

    查看模式：0-公开模式(默认)，1-私密模式

CreateChannelCategoryOptions

CreateChannelCategoryOptions: { ext?: string; name?: string; serverId: string; viewMode: number }

Type declaration

  • Optional ext?: string

    自定义扩展

  • Optional name?: string

    分组名称

  • serverId: string

    服务器ID

  • viewMode: number

    查看模式：0-公开模式(默认)，1-私密模式

CreateChannelOptions

CreateChannelOptions: { antispamTag?: AntispamTag; categoryId?: string; ext?: string; name: string; serverId: string; syncMode?: number; topic?: string; type: TChannelInfoType; viewMode?: number }

Type declaration

  • Optional antispamTag?: AntispamTag

    反垃圾相关字段

  • Optional categoryId?: string

    频道类别id

  • Optional ext?: string

    自定义扩展

  • name: string

    名称

  • serverId: string

    服务器ID

  • Optional syncMode?: number

    同步模式：0-不与类别同步模式(默认)，1-与类别同步模式

  • Optional topic?: string

    主题

  • type: TChannelInfoType

    类型：message-消息频道,ext-自定义频道

  • Optional viewMode?: number

    查看模式：0-公开模式(默认)，1-私密模式

DeleteChannelOptions

DeleteChannelOptions: { channelId: string }

Type declaration

  • channelId: string

    频道id

GetChannelCategoriesByIDOptions

GetChannelCategoriesByIDOptions: { categoryIds: string[] }

Type declaration

  • categoryIds: string[]

    分组ID 列表

GetChannelCategoriesPageOptions

GetChannelCategoriesPageOptions: { limit?: number; serverId: string; timetag: number }

Type declaration

  • Optional limit?: number

    分页页码，默认 100 条

  • serverId: string

    服务器ID

  • timetag: number

    创建时间 必填 按照创建时间逆序，0等同于表示当前时间。

GetChannelCategoriesPageResult

GetChannelCategoriesPageResult: { datas: QChatChannelCategoryInfo[]; listQueryTag: { hasMore: boolean; nextTimetag: number } }

Type declaration

  • datas: QChatChannelCategoryInfo[]
  • listQueryTag: { hasMore: boolean; nextTimetag: number }

    分页便捷选项

    • hasMore: boolean

      是否还有下一页

    • nextTimetag: number

      下一次翻页时的起始时间戳

GetChannelCategoryChannelsPageOptions

GetChannelCategoryChannelsPageOptions: { categoryId: string; limit?: number; serverId: string; timetag: number }

Type declaration

  • categoryId: string

    分组ID

  • Optional limit?: number

    分页页码，默认 100 条

  • serverId: string

    服务器ID

  • timetag: number

    分页条件-上一次查询的时间戳。默认0，0等同于表示当前时间。

GetChannelCategoryChannelsPageResult

GetChannelCategoryChannelsPageResult: { datas: ChannelInfo[]; listQueryTag: { hasMore: boolean; nextTimetag: number } }

Type declaration

  • datas: ChannelInfo[]
  • listQueryTag: { hasMore: boolean; nextTimetag: number }

    分页便捷选项

    • hasMore: boolean

      是否还有下一页

    • nextTimetag: number

      下一次翻页时的起始时间戳

GetChannelCategoryWhiteBlackMembersOptions

GetChannelCategoryWhiteBlackMembersOptions: { accids: string[]; categoryId: string; serverId: string; type: keyof typeof EWhiteBlackType }

Type declaration

  • accids: string[]

    账号列表 , 最多100个

  • categoryId: string

    分组ID

  • serverId: string

    服务器ID

  • type: keyof typeof EWhiteBlackType

    类型

    1. 针对公开的频道 {@link QChatChannelCategoryInfo.viewMode | QChatChannelCategoryInfo.viewMode} 为 0，接口只允许设置黑名单，type 传 "black"

    2. 针对私密的频道 {@link QChatChannelCategoryInfo.viewMode | QChatChannelCategoryInfo.viewMode} 为 1，接口只允许设置白名单，type 传 "white"

GetChannelCategoryWhiteBlackMembersPageOptions

GetChannelCategoryWhiteBlackMembersPageOptions: { categoryId: string; limit?: number; serverId: string; timetag: number; type: keyof typeof EWhiteBlackType }

Type declaration

  • categoryId: string

    分组ID

  • Optional limit?: number

    分页页码，默认 100 条

  • serverId: string

    服务器ID

  • timetag: number

    分页条件-上一次查询的时间戳，0等同于表示当前时间。

  • type: keyof typeof EWhiteBlackType

    类型

    1. 针对公开的频道 {@link QChatChannelCategoryInfo.viewMode | QChatChannelCategoryInfo.viewMode} 为 0，接口只允许设置黑名单，type 传 "black"

    2. 针对私密的频道 {@link QChatChannelCategoryInfo.viewMode | QChatChannelCategoryInfo.viewMode} 为 1，接口只允许设置白名单，type 传 "white"

GetChannelCategoryWhiteBlackMembersPageResult

GetChannelCategoryWhiteBlackMembersPageResult: { datas: MemberInfo[]; listQueryTag: { hasMore: boolean; nextTimetag: number } }

Type declaration

  • datas: MemberInfo[]
  • listQueryTag: { hasMore: boolean; nextTimetag: number }

    分页便捷选项

    • hasMore: boolean

      是否还有下一页

    • nextTimetag: number

      下一次翻页时的起始时间戳

GetChannelCategoryWhiteBlackMembersResult

GetChannelCategoryWhiteBlackMembersResult: { datas: MemberInfo[]; listQueryTag: { hasMore: boolean; nextTimetag: number } }

Type declaration

  • datas: MemberInfo[]
  • listQueryTag: { hasMore: boolean; nextTimetag: number }

    分页便捷选项

    • hasMore: boolean

      是否还有下一页

    • nextTimetag: number

      下一次翻页时的起始时间戳

GetChannelCategoryWhiteBlackRolesOptions

GetChannelCategoryWhiteBlackRolesOptions: { categoryId: string; roleIds: string[]; serverId: string; type: keyof typeof EWhiteBlackType }

Type declaration

  • categoryId: string

    分组ID

  • roleIds: string[]

    身份组ID列表，最多100个

  • serverId: string

    服务器ID

  • type: keyof typeof EWhiteBlackType

    类型

    1. 针对公开的频道 {@link QChatChannelCategoryInfo.viewMode | QChatChannelCategoryInfo.viewMode} 为 0，接口只允许设置黑名单，type 传 "black"

    2. 针对私密的频道 {@link QChatChannelCategoryInfo.viewMode | QChatChannelCategoryInfo.viewMode} 为 1，接口只允许设置白名单，type 传 "white"

GetChannelCategoryWhiteBlackRolesPageOptions

GetChannelCategoryWhiteBlackRolesPageOptions: { categoryId: string; limit?: number; serverId: string; timetag: number; type: keyof typeof EWhiteBlackType }

Type declaration

  • categoryId: string

    分组ID

  • Optional limit?: number

    分页页码，默认 100 条

  • serverId: string

    服务器ID

  • timetag: number

    分页条件-上一次查询的时间戳，0等同于表示当前时间。

  • type: keyof typeof EWhiteBlackType

    类型

    1. 针对公开的频道 {@link QChatChannelCategoryInfo.viewMode | QChatChannelCategoryInfo.viewMode} 为 0，接口只允许设置黑名单，type 传 "black"

    2. 针对私密的频道 {@link QChatChannelCategoryInfo.viewMode | QChatChannelCategoryInfo.viewMode} 为 1，接口只允许设置白名单，type 传 "white"

GetChannelCategoryWhiteBlackRolesPageResult

GetChannelCategoryWhiteBlackRolesPageResult: { datas: QChatServerRole[]; listQueryTag: { hasMore: boolean; nextTimetag: number } }

Type declaration

  • datas: QChatServerRole[]
  • listQueryTag: { hasMore: boolean; nextTimetag: number }

    分页便捷选项

    • hasMore: boolean

      是否还有下一页

    • nextTimetag: number

      下一次翻页时的起始时间戳

GetChannelCategoryWhiteBlackRolesResult

GetChannelCategoryWhiteBlackRolesResult: { datas: QChatServerRole[]; listQueryTag: { hasMore: boolean; nextTimetag: number } }

Type declaration

  • datas: QChatServerRole[]
  • listQueryTag: { hasMore: boolean; nextTimetag: number }

    分页便捷选项

    • hasMore: boolean

      是否还有下一页

    • nextTimetag: number

      下一次翻页时的起始时间戳

GetChannelSearchByPageOptions

GetChannelSearchByPageOptions: { cursor?: string; endTime?: number; keyword: string; limit?: number; order?: TQChatSearchOrder; serverId?: string; sort?: TSortType; startTime?: number }

Type declaration

  • Optional cursor?: string

    排序条件 查询游标，查询的起始位置，上一次查询结果中的listQueryTag字段会返回cursor字段。

  • Optional endTime?: number

    查询时间范围的结束时间，要求比开始时间大

  • keyword: string

    关键字

  • Optional limit?: number

    返回结果的记录数，最大和默认都是100

  • Optional order?: TQChatSearchOrder

    排序规则：ASC-升序 ,DESC-倒序 默认DESC

  • Optional serverId?: string

    不填时查询所有服务器，填写时查询指定服务器

  • Optional sort?: TSortType

    排序条件 reorderWeight-自定义权重排序、createTime-创建时间（默认）

  • Optional startTime?: number

    查询时间范围的开始时间

GetChannelSearchByPageResult

GetChannelSearchByPageResult: { datas: ChannelInfo[]; listQueryTag: { cursor: string; hasMore: boolean; nextTimetag: number } }

Type declaration

  • datas: ChannelInfo[]
  • listQueryTag: { cursor: string; hasMore: boolean; nextTimetag: number }

    分页便捷选项

    • cursor: string

      查询游标，下次查询的起始位置

    • hasMore: boolean

      是否还有下一页

    • nextTimetag: number

      下一次翻页时的起始时间戳

GetChannelsByPageOptions

GetChannelsByPageOptions: { limit: number; serverId: string; timetag: number }

Type declaration

  • limit: number

    条数

  • serverId: string

    服务器ID

  • timetag: number

    时间戳 传0取当前时间

GetChannelsByPageResult

GetChannelsByPageResult: { datas: ChannelInfo[]; listQueryTag: { hasMore: boolean; nextTimetag: number } }

Type declaration

  • datas: ChannelInfo[]
  • listQueryTag: { hasMore: boolean; nextTimetag: number }

    分页便捷选项

    • hasMore: boolean

      是否还有下一页

    • nextTimetag: number

      下一次翻页时的起始时间戳

GetChannelsOptions

GetChannelsOptions: { channelIds: string[] }

Type declaration

  • channelIds: string[]

    频道id

GetExistingWhiteBlackMembersOptions

GetExistingWhiteBlackMembersOptions: { accids: string[]; channelId: string; serverId: string; type: keyof typeof EWhiteBlackType }

Type declaration

  • accids: string[]

    账号 数组 , 最多100个

  • channelId: string

    频道 ID

  • serverId: string

    服务器ID

  • type: keyof typeof EWhiteBlackType

    类型

    1. 针对公开的频道 {@link ChannelInfo.viewMode | ChannelInfo.viewMode} 为 0，接口只允许设置黑名单，type 传 "black"

    2. 针对私密的频道 {@link ChannelInfo.viewMode | ChannelInfo.viewMode} 为 1，接口只允许设置白名单，type 传 "white"

GetExistingWhiteBlackMembersResult

GetExistingWhiteBlackMembersResult: { datas: MemberInfo[] }

Type declaration

GetExistingWhiteBlackRolesOptions

GetExistingWhiteBlackRolesOptions: { channelId: string; roleIds: string[]; serverId: string; type: keyof typeof EWhiteBlackType }

Type declaration

  • channelId: string

    频道 ID

  • roleIds: string[]

    身份组 id 数组 , 最多100个

  • serverId: string

    服务器ID

  • type: keyof typeof EWhiteBlackType

    类型

    1. 针对公开的频道 {@link ChannelInfo.viewMode | ChannelInfo.viewMode} 为 0，接口只允许设置黑名单，type 传 "black"

    2. 针对私密的频道 {@link ChannelInfo.viewMode | ChannelInfo.viewMode} 为 1，接口只允许设置白名单，type 传 "white"

GetExistingWhiteBlackRolesResult

GetExistingWhiteBlackRolesResult: { datas: QChatServerRole[] }

Type declaration

GetMembersByPageOptions

GetMembersByPageOptions: { channelId: string; limit?: number; serverId: string; timetag?: number }

Type declaration

  • channelId: string

    频道 ID

  • Optional limit?: number

    分页数量，默认 100 条

  • serverId: string

    服务器ID

  • Optional timetag?: number

    分页条件-上一次查询的时间戳。默认0，0等同于表示当前时间。

GetMembersByPageResult

GetMembersByPageResult: { datas: MemberInfo[]; listQueryTag: { hasMore: boolean; nextTimetag: number } }

Type declaration

  • datas: MemberInfo[]
  • listQueryTag: { hasMore: boolean; nextTimetag: number }

    分页便捷选项

    • hasMore: boolean

      是否还有下一页

    • nextTimetag: number

      下一次翻页时的起始时间戳

GetUnreadInfoOptions

GetUnreadInfoOptions: { channels: { channelId: string; serverId: string }[] }

Type declaration

  • channels: { channelId: string; serverId: string }[]

GetWhiteBlackMembersPageOptions

GetWhiteBlackMembersPageOptions: { channelId: string; limit?: number; serverId: string; timetag?: number; type: keyof typeof EWhiteBlackType }

Type declaration

  • channelId: string

    频道 ID

  • Optional limit?: number

    分页页码，默认 100 条

  • serverId: string

    服务器ID

  • Optional timetag?: number

    分页条件-上一次查询的时间戳。默认0，0等同于表示当前时间。

  • type: keyof typeof EWhiteBlackType

    类型

    1. 针对公开的频道 {@link ChannelInfo.viewMode | ChannelInfo.viewMode} 为 0，接口只允许设置黑名单，type 传 "black"

    2. 针对私密的频道 {@link ChannelInfo.viewMode | ChannelInfo.viewMode} 为 1，接口只允许设置白名单，type 传 "white"

GetWhiteBlackMembersPageResult

GetWhiteBlackMembersPageResult: { datas: MemberInfo[]; listQueryTag: { hasMore: boolean; nextTimetag: number } }

Type declaration

  • datas: MemberInfo[]
  • listQueryTag: { hasMore: boolean; nextTimetag: number }

    分页便捷选项

    • hasMore: boolean

      是否还有下一页

    • nextTimetag: number

      下一次翻页时的起始时间戳

GetWhiteBlackRolesPageOptions

GetWhiteBlackRolesPageOptions: { channelId: string; limit?: number; serverId: string; timetag?: number; type: keyof typeof EWhiteBlackType }

Type declaration

  • channelId: string

    频道 ID

  • Optional limit?: number

    分页页码，默认 100 条

  • serverId: string

    服务器ID

  • Optional timetag?: number

    分页条件-上一次查询的时间戳。默认0，0等同于表示当前时间。

  • type: keyof typeof EWhiteBlackType

    类型

    1. 针对公开的频道 {@link ChannelInfo.viewMode | ChannelInfo.viewMode} 为 0，接口只允许设置黑名单，type 传 "black"

    2. 针对私密的频道 {@link ChannelInfo.viewMode | ChannelInfo.viewMode} 为 1，接口只允许设置白名单，type 传 "white"

GetWhiteBlackRolesPageResult

GetWhiteBlackRolesPageResult: { datas: QChatServerRole[]; listQueryTag: { hasMore: boolean; nextTimetag: number } }

Type declaration

  • datas: QChatServerRole[]
  • listQueryTag: { hasMore: boolean; nextTimetag: number }

    分页便捷选项

    • hasMore: boolean

      是否还有下一页

    • nextTimetag: number

      下一次翻页时的起始时间戳

QChatChannelCategoryInfo

QChatChannelCategoryInfo: { categoryId: string; channelNumber: number; createTime: number; ext?: string; name: string; owner: string; serverId: string; updateTime: number; validFlag: boolean; viewMode: number }

Type declaration

  • categoryId: string

    分组ID

  • channelNumber: number

    频道数量

  • createTime: number

    创建时间

  • Optional ext?: string

    自定义扩展

  • name: string

    名称

  • owner: string

    所有者

  • serverId: string

    服务器ID

  • updateTime: number

    更新时间

  • validFlag: boolean

    有效标志：false-无效，true-有效

  • viewMode: number

    查看模式：0-公开模式，1-私密模式

QChatChannelMemberInfo

QChatChannelMemberInfo: { accid: string; avatar: string; channelId: string; createTime: string; nick: string; serverId: string; updateTime: string }

Type declaration

  • accid: string

    账号 数组 , 最多100个

  • avatar: string

    头像

  • channelId: string

    频道 ID

  • createTime: string

    创建时间

  • nick: string

    昵称

  • serverId: string

    服务器ID

  • updateTime: string

    修改时间

QChatChannelMemberSearchOptions

QChatChannelMemberSearchOptions: { channelId: string; keyword: string; limit?: number; serverId: string }

Type declaration

  • channelId: string

    频道 ID

  • keyword: string

    关键字

  • Optional limit?: number

    查询数量，默认和最大都是 100 条

  • serverId: string

    服务器ID

QChatChannelUnreadInfo

QChatChannelUnreadInfo: { ackTimestamp?: number; channelId: string; lastMsgTime?: number; maxCount?: number; mentionedCount: number; serverId: string; unreadCount: number }

Type declaration

  • Optional ackTimestamp?: number

    已读时间戳

  • channelId: string

    频道id

  • Optional lastMsgTime?: number

    最后一条消息的时间戳

  • Optional maxCount?: number

    最大未读数

  • mentionedCount: number

    艾特消息未读数

  • serverId: string

    服务器id

  • unreadCount: number

    未读数

QChatServerUnreadInfo

QChatServerUnreadInfo: { maxCount?: number; mentionedCount: number; serverId: string; unreadCount: number }

Type declaration

  • Optional maxCount?: number

    最大未读数

  • mentionedCount: number

    艾特消息未读数

  • serverId: string

    服务器id

  • unreadCount: number

    未读数

RemoveChannelCategoryOptions

RemoveChannelCategoryOptions: { categoryId: string }

Type declaration

  • categoryId: string

    分组ID

SubscribeChannelOptions

SubscribeChannelOptions: { channels: { channelId: string; serverId: string }[]; opeType: 1 | 2; type: number }

Type declaration

  • channels: { channelId: string; serverId: string }[]
  • opeType: 1 | 2

    操作类型 1 为订阅； 2 为取消订阅

  • type: number

    订阅类型 :

    1.订阅某个channel的【消息】/【通知】

    2.订阅某个channel的【消息未读数】/【通知】

    3.订阅某个channel的【消息未读状态】/【通知】

    5.订阅某个频道的消息正在输入的系统通知

SubscribeChannelResult

SubscribeChannelResult: { failedChannels: { channelId: string; serverId: string }[]; unreadInfos: QChatChannelUnreadInfo[] }

Type declaration

  • failedChannels: { channelId: string; serverId: string }[]

    订阅失败频道列表

  • unreadInfos: QChatChannelUnreadInfo[]

    订阅成功频道的未读数详情

TChannelInfoType

TChannelInfoType: keyof typeof EChannelInfoType

TSortType

TSortType: keyof typeof QChatEChannelSortType

UpdateCategoryInfoOfChannelOptions

UpdateCategoryInfoOfChannelOptions: { categoryId?: string; channelId: string; syncMode?: number }

Type declaration

  • Optional categoryId?: string

    频道类别id，传0从频道分组中移除频道

  • channelId: string

    频道 ID

  • Optional syncMode?: number

    同步模式：0-不与类别同步模式(默认)，1-与类别同步模式

UpdateChannelCategoryOptions

UpdateChannelCategoryOptions: { categoryId: string; ext?: string; name?: string; viewMode: number }

Type declaration

  • categoryId: string

    分组ID

  • Optional ext?: string

    自定义扩展

  • Optional name?: string

    分组名称

  • viewMode: number

    查看模式：0-公开模式(默认)，1-私密模式

UpdateChannelCategoryWhiteBlackMembersOptions

UpdateChannelCategoryWhiteBlackMembersOptions: { categoryId: string; opeType: keyof typeof EWhiteBlackOpeType; serverId: string; toAccids: string[]; type: keyof typeof EWhiteBlackType }

Type declaration

  • categoryId: string

    分组ID

  • opeType: keyof typeof EWhiteBlackOpeType

    操作类型。新增传 "add", 移除传 "remove"

  • serverId: string

    服务器ID

  • toAccids: string[]

    成员的 account ID，一次最多传入 100 个

  • type: keyof typeof EWhiteBlackType

    类型

    1. 针对公开的频道 {@link QChatChannelCategoryInfo.viewMode | QChatChannelCategoryInfo.viewMode} 为 0，接口只允许设置黑名单，type 传 "black"

    2. 针对私密的频道 {@link QChatChannelCategoryInfo.viewMode | QChatChannelCategoryInfo.viewMode} 为 1，接口只允许设置白名单，type 传 "white"

UpdateChannelCategoryWhiteBlackRoleOptions

UpdateChannelCategoryWhiteBlackRoleOptions: { categoryId: string; opeType: keyof typeof EWhiteBlackOpeType; roleId: string; serverId: string; type: keyof typeof EWhiteBlackType }

Type declaration

  • categoryId: string

    分组ID

  • opeType: keyof typeof EWhiteBlackOpeType

    操作类型。新增传 "add", 移除传 "remove"

  • roleId: string

    身份组 ID

  • serverId: string

    服务器ID

  • type: keyof typeof EWhiteBlackType

    类型

    1. 针对公开的频道 {@link QChatChannelCategoryInfo.viewMode | QChatChannelCategoryInfo.viewMode} 为 0，接口只允许设置黑名单，type 传 "black"

    2. 针对私密的频道 {@link QChatChannelCategoryInfo.viewMode | QChatChannelCategoryInfo.viewMode} 为 1，接口只允许设置白名单，type 传 "white"

UpdateChannelOptions

UpdateChannelOptions: { antispamTag?: AntispamTag; channelId: string; ext?: string; name?: string; serverId?: string; topic?: string; type: TChannelInfoType; viewMode?: number }

Type declaration

  • Optional antispamTag?: AntispamTag

    反垃圾相关字段

  • channelId: string

    频道ID

  • Optional ext?: string

    自定义扩展

  • Optional name?: string

    名称

  • Optional serverId?: string

    服务器ID

  • Optional topic?: string

    主题

  • type: TChannelInfoType

    类型：message-消息频道,ext-自定义频道

  • Optional viewMode?: number

    查看模式：0-公开模式(默认)，1-私密模式

UpdateWhiteBlackMembersOptions

UpdateWhiteBlackMembersOptions: { channelId: string; opeType: keyof typeof EWhiteBlackOpeType; serverId: string; toAccids: string[]; type: keyof typeof EWhiteBlackType }

Type declaration

  • channelId: string

    频道 ID

  • opeType: keyof typeof EWhiteBlackOpeType

    操作类型。新增传 "add", 移除传 "remove"

  • serverId: string

    服务器ID

  • toAccids: string[]

    成员的 account ID，一次最多传入 100 个

  • type: keyof typeof EWhiteBlackType

    类型

    1. 针对公开的频道 {@link ChannelInfo.viewMode | ChannelInfo.viewMode} 为 0，接口只允许设置黑名单，type 传 "black"

    2. 针对私密的频道 {@link ChannelInfo.viewMode | ChannelInfo.viewMode} 为 1，接口只允许设置白名单，type 传 "white"

UpdateWhiteBlackRoleOptions

UpdateWhiteBlackRoleOptions: { channelId: string; opeType: keyof typeof EWhiteBlackOpeType; roleId: string; serverId: string; type: keyof typeof EWhiteBlackType }

Type declaration

  • channelId: string

    频道 ID

  • opeType: keyof typeof EWhiteBlackOpeType

    操作类型。新增传 "add", 移除传 "remove"

  • roleId: string

    身份组 ID

  • serverId: string

    服务器ID

  • type: keyof typeof EWhiteBlackType

    类型

    1. 针对公开的频道 {@link ChannelInfo.viewMode | ChannelInfo.viewMode} 为 0，接口只允许设置黑名单，type 传 "black"

    2. 针对私密的频道 {@link ChannelInfo.viewMode | ChannelInfo.viewMode} 为 1，接口只允许设置白名单，type 传 "white"