WuKongIM Docs

Channel

Channel 元数据、订阅者与名单管理。

编辑此页报告文档问题

创建或更新 Channel 元数据

全量更新元数据标志并可重置订阅者;disband 为终态。

替换 Channel 元数据

字段省略时仍把零值完整记录交给 UpdateInfo;该接口仅为兼容保留。

终态解散 Channel

设置持久化 disband 标志但不删除 Channel 身份;请求 Key 校验较弱。

添加或替换持久订阅者

添加非空白订阅者;channel_type=0 转为群组类型 2,reset=1 替换快照。

移除持久订阅者

移除非空白订阅者;与 subscriber_add 不同,channel_type=0 不会被归一化。

移除全部持久订阅者

通过内部有界分页清空普通订阅者;个人 Channel 会被拒绝。

替换临时 Channel 订阅者

替换派生 Type-8 临时订阅者列表;入口适配器不校验 UID 元素。

添加 Channel 拒绝列表成员

把给定 UID 字符串加入派生 Channel 拒绝列表。

替换 Channel 拒绝列表

先移除旧列表再添加给定值;入口只校验 channel_id。

移除 Channel 拒绝列表成员

从派生 Channel 拒绝列表移除给定 UID 字符串。

移除全部 Channel 拒绝列表成员

通过内部有界遍历清空派生拒绝列表。

添加 Channel 允许列表成员

把非空白 UID 加入派生 Channel 允许列表。

替换 Channel 允许列表

先移除旧列表再添加给定值;入口只校验 channel_id。

移除 Channel 允许列表成员

从派生 Channel 允许列表移除非空白 UID。

移除全部 Channel 允许列表成员

通过内部有界遍历清空派生允许列表。

列出全部 Channel 允许列表成员

返回无界完整列表;channel_type 缺失或无效时会静默视为 0。