频道相关

更新时间: 2022/08/26 03:40:09

参数配置限制

参数 限制说明
频道名称长度 长度限制:128 字符
频道扩展字段 长度限制:4096 字符
频道成员人数 人数限制:100 人

创建频道

  • API原型
objc/**
 创建频道

 @param request 创建频道请求
 @param completion 完成回调
 @discussion 该接口用户创建频道,同一时刻频道名互斥,不能重复创建。但如果频道名缺省,服务器会自动分配频道id。对于频道在创建后如果没人加入,有效期2小时,当有成员加入后会自动延续频道有效期。当主动关闭频道或者最后一个成员退出后2小时后频道销毁。
 @discussion 错误码 200:成功  10405:房间已存在
 */
- (void)signalingCreateChannel:(NIMSignalingCreateChannelRequest *)request
                    completion:(nullable NIMSignalingCreateChannelBlock)completion;
  • 说明 创建频道后并不会主动加入频道,需要手动加入频道。

加入频道

  • API原型
objc
 /**
 加入频道

 @param request 加入频道请求
 @param completion 完成回调
 @discussion 错误码 200:成功  10407:已经房间内 10420:已经在房间内(自己的其他端) 10419:房间人数超限  10417:uid冲突
 */
- (void)signalingJoinChannel:(NIMSignalingJoinChannelRequest *)request
                  completion:(nullable NIMSignalingJoinChannelBlock)completion;

离开频道

  • API原型
objc/**
 离开频道

 @param request 离开频道请求
 @param completion 完成回调
 @discussion 该接口用于自己退出频道,但不对频道进行销毁
 @discussion 错误码 200:成功  10406:不在房间内
 */
- (void)signalingLeaveChannel:(NIMSignalingLeaveChannelRequest *)request
                   completion:(nullable NIMSignalingOperationBlock)completion;

关闭频道

  • API原型
objc/**
 关闭频道

 @param request 关闭频道请求
 @param completion 完成回调
 @discussion 该接口可以由创建者和频道内所有成员调用,无权限限制。调用该接口成功后,其他所有频道内的成员都回收到频道结束的通知,被动离开频道。此时其他成员需要调用离开接口,也不会收到别人的离开通知。
 @discussion 错误码 200:成功  10406:不在房间内
 */
- (void)signalingCloseChannel:(NIMSignalingCloseChannelRequest *)request
                   completion:(nullable NIMSignalingOperationBlock)completion;
此文档是否对你有帮助?
有帮助
去反馈
  • 参数配置限制
  • 创建频道
  • 加入频道
  • 离开频道
  • 关闭频道