HyphenateChatSDK 3.9.9.1
|
|
required |
同意加入频道的邀请。
serverId | 社区 ID。 |
channelId | 频道 ID。 |
inviter | 邀请人的用户 ID。 |
completion | 同意邀请的回调。 |
|
required |
同意社区加入邀请。
serverId | 社区 ID。 |
inviter | 邀请人的用户 ID。 |
completion | 同意邀请的回调。 |
|
required |
添加频道分组回调代理。
delegate | 要添加的频道分组正常的增删改查的代理。 |
queue | 代理执行的队列。如果为 nil ,则在主线程执行。 |
|
required |
添加频道回调代理。
delegate | 要添加的频道正常的增删改查的代理。 |
queue | 代理执行的队列。如果为 nil ,则在主线程执行。 |
|
required |
设置社区管理员。
仅社区所有者可调用该方法。
serverId | 社区 ID。 |
userId | 要设置为社区管理员的成员的用户 ID。 |
completion | 设置完成的回调。 |
|
required |
添加社区回调代理。
delegate | 要添加的社区正常的增删改查的代理。 |
queue | 代理执行的队列。如果为 nil ,则在主线程执行。 |
|
required |
添加社区标签。
仅社区所有者和管理员可以调用该方法。
serverId | 社区 ID。 |
tags | 要添加的标签名称列表。 |
completion | 添加标签的回调。 |
|
required |
查询当前用户是否加入了频道。
serverId | 社区 ID。 |
channelId | 频道 ID。 |
completion | 查询完成的回调。 |
|
required |
查询当前用户是否加入了社区。
serverId | 社区 ID。 |
completion | 查询完成的回调。 |
|
required |
创建频道分组。
仅社区所有者可以调用该方法。
serverId | 社区 ID。 |
name | 频道分组名称。 |
completion | 创建频道分组的回调。 |
|
required |
在社区内创建频道。
仅社区所有者可以调用该方法。
serverId | 社区 ID。 |
attribute | 频道属性配置。 |
categoryId | 频道分组 ID。若传入 nil ,该频道归为默认频道分组。 |
mode | 频道模式,即文字频道或语聊频道。 |
completion | 创建频道的回调。 |
|
required |
创建社区。
attribute | 社区详情数据。 |
completion | 创建社区的回调。 |
|
required |
拒绝加入频道的邀请。
serverId | 社区 ID。 |
channelId | 频道 ID。 |
inviter | 邀请人的用户 ID。 |
completion | 拒绝邀请的回调。 |
|
required |
拒绝社区加入邀请。
serverId | 社区 ID。 |
inviter | 邀请人的用户 ID。 |
completion | 拒绝邀请的回调。 |
|
required |
删除频道分组。
仅社区所有者和管理员可调用该方法。
删除频道分组后,该频道分组下的所有频道会添加到社区的默认频道分组中。
serverId | 社区 ID。 |
categoryId | 频道分组 ID。 |
completion | 销毁频道分组的回调。 |
|
required |
销毁社区内的频道。
仅社区所有者可调用该方法。
serverId | 社区 ID。 |
channelId | 频道 ID。 |
completion | 销毁频道的回调。 |
|
required |
销毁社区。
仅社区所有者可调用该方法。
serverId | 社区 ID。 |
completion | 销毁社区的回调。 |
|
required |
获取社区下的频道分组列表。
SDK 按频道分组的创建时间正序查询。
serverId | 社区 ID。 |
limit | 每次期望获取的频道分组数量。取值范围为 [1,20]。 |
cursor | 查询的游标位置,从上次查询的结果中获取。首次查询传入 nil 或 "",SDK 从创建最早的频道分组开始查询。 |
completion | 查询完成的回调。 |
|
required |
获取指定频道的详情。
serverId | 社区 ID。 |
channelId | 频道 ID。 |
completion | 查询完成的回调。 |
|
required |
分页获取频道中的成员列表。
SDK 从指定位置按照成员加入频道的时间正序获取。
serverId | 社区 ID。 |
channelId | 频道 ID。 |
limit | 每次期望获取的成员数量。取值范围为 [1,20]。 |
cursor | 查询的游标位置,从上次查询的结果中获取。首次查询传入 nil 或 "",SDK 从最早加入频道的成员开始查询。 |
completion | 查询完成的回调。 |
|
required |
查询频道的禁言列表。
serverId | 社区 ID。 |
channelId | 频道 ID。 |
completion | 查询完成的回调。 |
|
required |
分页获取社区中已加入的频道。
SDK 从指定位置按照频道创建时间的正序获取。
serverId | 社区 ID。 |
limit | 每次期望获取的频道数量。取值范围为 [1,20]。 |
cursor | 查询的游标位置,从上次查询的结果中获取。 首次查询传入 nil 或 "",SDK 从创建最早的加入频道开始查询。 |
completion | 查询完成的回调。 |
|
required |
查询用户加入的社区列表。
SDK 从指定的游标位置按照用户加入社区的正序查询。
limit | 每次获取的最大用户数量。取值范围为 [1,20]。 |
cursor | 查询的游标位置,从上次查询的结果中获取。首次查询传入 nil 或 "",SDK 从最早加入社区的开始获取。 |
completion | 查询完成的回调。 |
|
required |
分页获取频道分组中的私密频道列表。
SDK 按照私密频道创建时间的正序返回。
serverId | 社区 ID。 |
categoryId | 频道分组 ID。 |
limit | 每次期望获取的私密频道数量。取值范围为 [1,20]。 |
cursor | 查询的游标位置,从上次查询的结果中获取。首次查询传入 nil 或 "",SDK 从创建最早的私密频道开始查询。 |
completion | 查询完成的回调。 |
|
required |
分页获取指定社区中私密频道列表。
SDK 按照私密频道创建时间的正序返回。
serverId | 社区 ID。 |
limit | 每次期望获取的私密频道数量。取值范围为 [1,20]。 |
cursor | 查询的游标位置,从上次查询的结果中获取。首次查询传入 nil 或 "",SDK 从创建最早的私密频道开始查询。 |
completion | 查询完成的回调。 |
|
required |
分页获取指定频道分组中的公开频道列表。
SDK 按照公开频道创建时间的正序返回。
serverId | 社区 ID。 |
categoryId | 频道分组 ID。 |
limit | 每次期望获取的公开频道数量。取值范围为 [1,20]。 |
cursor | 查询的游标位置,从上次查询的结果中获取。首次查询传入 nil 或 "",SDK 从最早创建的公开频道开始查询。 |
completion | 查询完成的回调。 |
|
required |
分页获取指定社区中的公开频道列表。
SDK 按公开频道的创建时间的正序获取。
serverId | 社区 ID。 |
limit | 每次获取的最大公开频道数量。取值范围为 [1,20]。 |
cursor | 查询的游标位置,从上次查询的结果中获取。首次查询传入 nil 或 "",SDK 从最早创建的公开频道开始查询。 |
completion | 查询完成的回调。 |
|
required |
查询当前用户的社区角色。
serverId | 社区 ID。 |
completion | 查询完成的回调。 |
|
required |
查询指定社区的详情。
serverId | 社区 ID。 |
completion | 查询完成的回调。 |
|
required |
分页查询社区成员列表。
SDK 按成员加入社区时间的正序查询。
serverId | 社区 ID。 |
limit | 每次期望获取的社区数量。取值范围为 [1,20]。 |
cursor | 查询的游标位置,从上次查询的结果中获取。首次查询传入 nil 或 "",SDK 从最早加入社区的成员开始查询。 |
completion | 查询完成的回调。 |
|
required |
按照关键字查询公开社区。
keyword | 查询关键字。目前只支持按完整的社区名称或社区标签名称查询。 |
completion | 查询完成的回调。 |
|
required |
按照关键字查询公开社区。
SDK 按公开社区创建时间顺序查询。
type | 查询类型。目前只支持按社区名称或社区标签名称查询,默认根据社区名称搜索。详见 EMCircleServerSearchType 。
|
keyword | 查询关键字,即社区名称或社区标签名称。 |
limit | 每次期望获取的社区数量。取值范围为 [1,20]。 |
cursor | 查询的游标位置,从上次查询的结果中获取。首次查询传入 nil 或 "",SDK 从最新创建的社区的开始获取。 |
completion | 查询完成的回调。 |
|
required |
查询当前社区的标签列表。
serverId | 社区 ID。 |
completion | 查询完成的回调。 |
|
required |
邀请用户加入社区中的频道。
serverId | 社区 ID。 |
channelId | 频道 ID。 |
userId | 受邀用户的用户 ID。 |
completion | 邀请用户的回调。 |
|
required |
邀请用户加入社区。
serverId | 社区 ID。 |
userId | 受邀人的用户 ID。 |
completion | 邀请用户的回调。 |
|
required |
加入频道。
serverId | 社区 ID。 |
channelId | 频道 ID。 |
completion | 加入频道的回调。 |
|
required |
加入社区。
serverId | 社区 ID。 |
completion | 加入社区的回调。 |
|
required |
退出频道。
退出频道的成员不会再收到频道消息。
社区内的默认频道不允许成员主动退出。
serverId | 社区 ID。 |
channelId | 频道 ID。 |
completion | 退出频道的回调。 |
|
required |
退出社区。
社区成员若退出社区,则会退出该社区下的所有频道。
社区所有者不支持退出社区操作,只能解散社区。
serverId | 社区 ID。 |
completion | 退出社区的回调。 |
|
required |
禁言频道中的成员。
仅社区所有者和社区管理员可以调用该方法。
userId | 要禁言的成员的用户 ID。 |
serverId | 社区 ID。 |
channelId | 频道 ID。 |
duration | 禁言时长,单位为毫秒。值为 -1 时表示永久禁言。 |
completion | 禁言回调。 |
|
required |
移除频道分组回调代理。
delegate | 要移除的代理。 |
|
required |
移除频道回调代理。
delegate | 要移除的代理。 |
|
required |
移除社区管理员。
仅社区所有者可调用该方法。
serverId | 社区 ID。 |
userId | 要从社区管理员列表移除的用户 ID。 |
completion | 设置完成的回调。 |
|
required |
移除社区回调代理。
delegate | 要移除的代理。 |
|
required |
移除社区标签。
仅社区所有者和管理员可以调用该方法。
serverId | 社区 ID。 |
tagIds | 要删除的标签 ID 列表。 |
completion | 删除标签的的回调。 |
|
required |
移除频道成员。
社区所有者可将频道中的所有成员移出,社区管理员只能将普通成员移出频道。
社区内的默认频道不允许踢出成员。
serverId | 社区 ID。 |
channelId | 频道 ID。 |
userId | 要移除的成员的用户 ID。 |
completion | 移除用户的回调。 |
|
required |
将用户移出社区。
社区所有者可将所有成员移出社区,社区管理员只能将普通成员移出社区。
serverId | 社区 ID。 |
userId | 要移出的用户 ID。 |
completion | 移出用户的回调。 |
|
required |
更换指定频道所属的频道分组。
仅社区所有者和管理员可以调用该方法。
serverId | 社区 ID。 |
channelId | 频道 ID。 |
newCategoryId | 新的频道分组 ID。传 nil 或空字符串 "" 时,表示将频道转移至社区下的默认频道分组 ID。 |
completion | 更换频道分组回调。 |
|
required |
解除禁言频道中的用户。
仅社区所有者和社区管理员可以调用该方法。
userId | 要解除禁言的用户 ID。 |
serverId | 社区 ID。 |
channelId | 频道 ID。 |
completion | 解除禁言的回调。 |
|
required |
修改频道分组名称。
仅社区所有者和管理员可调用该方法。
serverId | 社区 ID。 |
categoryId | 频道分组 ID。 |
name | 修改后的频道分组名称。 |
completion | 频道分组更新回调。 |
|
required |
修改频道信息。
仅社区所有者和管理员可调用该方法。
serverId | 社区 ID。 |
channelId | 频道 ID。 |
attribute | 频道详情。 |
completion | 修改完成的回调。 |
|
required |
修改社区信息。
仅社区所有者和管理员可调用该方法。
serverId | 社区 ID。 |
attribute | 社区详情。 |
completion | 社区更新回调。 |