|
InvocationFuture< ChannelBaseInfo > | create (ChannelType type, String channelName, String channelExt) |
| 创建频道
同一时刻频道名互斥,不能重复创建,但如果频道名缺省,服务器会自动分配频道id。
错误码如下:
10405:频道已存在 ResponseCode#RES_CHANNEL_HAS_EXISTS 更多...
|
|
InvocationFuture< Void > | close (String channelId, boolean offlineEnabled, String customInfo) |
| 关闭频道
错误码如下:
10406:不在频道内 ResponseCode#RES_CHANNEL_MEMBER_NOT_EXISTS 更多...
|
|
InvocationFuture< ChannelFullInfo > | join (String channelId, long selfUid, String customInfo, boolean offlineEnable) |
| 加入频道
错误码如下:
10407:已经频道内 ResponseCode#RES_CHANNEL_MEMBER_HAS_EXISTS
10417:uid冲突 ResponseCode#RES_JOIN_CHANNEL_UID_CONFLICT
10419:频道人数超限 ResponseCode#RES_CHANNEL_MEMBER_EXCEED
10420:自己的其他端已经在频道内 ResponseCode#RES_CHANNEL_MEMBER_HAS_EXISTS_OTHER_CLIENT
更多...
|
|
InvocationFuture< ChannelFullInfo > | join (String channelId, long selfUid, String customInfo, boolean offlineEnable, String nertcChannelName, Long nertcTokenTtl) |
| 加入频道
错误码如下:
10407:已经频道内 ResponseCode#RES_CHANNEL_MEMBER_HAS_EXISTS
10417:uid冲突 ResponseCode#RES_JOIN_CHANNEL_UID_CONFLICT
10419:频道人数超限 ResponseCode#RES_CHANNEL_MEMBER_EXCEED
10420:自己的其他端已经在频道内 ResponseCode#RES_CHANNEL_MEMBER_HAS_EXISTS_OTHER_CLIENT
更多...
|
|
InvocationFuture< ChannelFullInfo > | join (String channelId, long selfUid, String customInfo, boolean offlineEnable, String nertcChannelName, Long nertcTokenTtl, String nertcJoinRoomQueryParamMap) |
| 加入频道
错误码如下:
10407:已经频道内 ResponseCode#RES_CHANNEL_MEMBER_HAS_EXISTS
10417:uid冲突 ResponseCode#RES_JOIN_CHANNEL_UID_CONFLICT
10419:频道人数超限 ResponseCode#RES_CHANNEL_MEMBER_EXCEED
10420:自己的其他端已经在频道内 ResponseCode#RES_CHANNEL_MEMBER_HAS_EXISTS_OTHER_CLIENT
更多...
|
|
InvocationFuture< Void > | leave (String channelId, boolean offlineEnable, String customInfo) |
| 离开频道
错误码如下:
10406:不在频道内 ResponseCode#RES_CHANNEL_MEMBER_NOT_EXISTS 更多...
|
|
InvocationFuture< Void > | invite (InviteParamBuilder paramBuilder) |
| 邀请他人加入频道
该接口用于邀请对方加入频道,邀请者必须是创建者或者是频道中成员。如果需要对离线成员邀请,可以打开离线邀请开关并填写推送信息,被邀请者上线后通过离线通知接收到该邀请。 错误码如下:
10201:已经成功发出邀请但是对方不在线(推送可达,但是离线)ResponseCode#RES_PEER_NIM_OFFLINE
10202:已经成功发出邀请但是对方推送不可达 ResponseCode#RES_PEER_PUSH_OFFLINE
10404:频道不存在 ResponseCode#RES_CHANNEL_NOT_EXISTS
10406:自己不在频道内(仅对于普通用户,频道创建者不在频道内也可以邀请别人)ResponseCode#RES_CHANNEL_MEMBER_NOT_EXISTS
10407:对方已经频道内 ResponseCode#RES_CHANNEL_MEMBER_HAS_EXISTS
10419:频道人数超限 ResponseCode#RES_CHANNEL_MEMBER_EXCEED
更多...
|
|
InvocationFuture< Void > | cancelInvite (InviteParamBuilder paramBuilder) |
| 取消邀请
错误码如下:
10404:频道不存在 ResponseCode#RES_CHANNEL_NOT_EXISTS
10408:邀请不存在或已过期 ResponseCode#RES_INVITE_NOT_EXISTS
10409:邀请已经拒绝 ResponseCode#RES_INVITE_HAS_REJECT
10410:邀请已经接受 ResponseCode#RES_INVITE_HAS_ACCEPT 更多...
|
|
InvocationFuture< Void > | rejectInvite (InviteParamBuilder paramBuilder) |
| 拒绝对方邀请
错误码如下:
10201:已经成功拒绝邀请但是对方不在线(推送可达,但是离线) ResponseCode#RES_PEER_NIM_OFFLINE
10404:频道不存在 ResponseCode#RES_CHANNEL_NOT_EXISTS
10408:邀请不存在或已过期 ResponseCode#RES_INVITE_NOT_EXISTS
10409:邀请已经拒绝 ResponseCode#RES_INVITE_HAS_REJECT
10410:邀请已经接受 ResponseCode#RES_INVITE_HAS_ACCEPT
更多...
|
|
InvocationFuture< Void > | acceptInvite (InviteParamBuilder paramBuilder) |
| 接受对方邀请,但并不代表加入了频道,如果想在接受邀请时自动加入频道,参考SignallingService#acceptInviteAndJoin(InviteParamBuilder, long)
错误码如下:
10201:已经成功接受邀请但是对方不在线(推送可达,但是离线) ResponseCode#RES_PEER_NIM_OFFLINE
10404:频道不存在 ResponseCode#RES_CHANNEL_NOT_EXISTS
10408:邀请不存在或已过期 ResponseCode#RES_INVITE_NOT_EXISTS
10409:邀请已经拒绝 ResponseCode#RES_INVITE_HAS_REJECT
10410:邀请已经接受 ResponseCode#RES_INVITE_HAS_ACCEPT
更多...
|
|
InvocationFuture< ChannelFullInfo > | acceptInviteAndJoin (InviteParamBuilder paramBuilder, long selfUid) |
| 接受对方邀请并自动加入频道
错误码如下:
10420:自己的其他端已经在频道内 ResponseCode#RES_CHANNEL_MEMBER_HAS_EXISTS_OTHER_CLIENT
10201:已经成功接受邀请但是对方不在线(推送可达,但是离线)ResponseCode#RES_PEER_NIM_OFFLINE
10404:频道不存在 ResponseCode#RES_CHANNEL_HAS_EXISTS
10407:已经频道内 ResponseCode#RES_CHANNEL_MEMBER_HAS_EXISTS
10408:邀请不存在或已过期 ResponseCode#RES_INVITE_NOT_EXISTS
10409:邀请已经拒绝 ResponseCode#RES_INVITE_HAS_REJECT
10410:邀请已经接受 ResponseCode#RES_INVITE_HAS_ACCEPT
10417:uid冲突 ResponseCode#RES_JOIN_CHANNEL_UID_CONFLICT
10419:频道人数超限 ResponseCode#RES_CHANNEL_MEMBER_EXCEED
更多...
|
|
InvocationFuture< ChannelFullInfo > | acceptInviteAndJoin (InviteParamBuilder paramBuilder, long selfUid, String nertcChannelName, Long nertcTokenTtl) |
| 接受对方邀请并自动加入频道
错误码如下:
10420:自己的其他端已经在频道内 ResponseCode#RES_CHANNEL_MEMBER_HAS_EXISTS_OTHER_CLIENT
10201:已经成功接受邀请但是对方不在线(推送可达,但是离线)ResponseCode#RES_PEER_NIM_OFFLINE
10404:频道不存在 ResponseCode#RES_CHANNEL_HAS_EXISTS
10407:已经频道内 ResponseCode#RES_CHANNEL_MEMBER_HAS_EXISTS
10408:邀请不存在或已过期 ResponseCode#RES_INVITE_NOT_EXISTS
10409:邀请已经拒绝 ResponseCode#RES_INVITE_HAS_REJECT
10410:邀请已经接受 ResponseCode#RES_INVITE_HAS_ACCEPT
10417:uid冲突 ResponseCode#RES_JOIN_CHANNEL_UID_CONFLICT
10419:频道人数超限 ResponseCode#RES_CHANNEL_MEMBER_EXCEED
更多...
|
|
InvocationFuture< JoinAndAcceptResult > | joinAndAccept (JoinAndAcceptParam joinAndAcceptParam) |
| 加入频道并接受对方邀请,该接口功能等同于用户先加入频道,然后接受对方邀请。该接口只需要一次网络请求,acceptInviteAndJoin(InviteParamBuilder, long) 和acceptInviteAndJoin(InviteParamBuilder, long, String, Long)需要两次网络请求,推荐使用joinAndAccept(JoinAndAcceptParam)
提示:以上接口返回200,代表加入频道成功,接受邀请的结果通过返回值JoinAndAcceptResult中的callStatus字段来体现。callStatus字段有一个特殊错误码: 10201:已经成功接受邀请但是对方不在线(推送可达,但是离线) ResponseCode#RES_PEER_NIM_OFFLINE
更多...
|
|
InvocationFuture< Void > | sendControl (String channelId, String accountId, String customInfo) |
| 该接口用于在频道中透传一些自定义指令,协助频道管理。该接口允许非频道内成员调用,但接收者必须是频道内成员或创建者
错误码如下:
10201:已经成功发出命令但是对方不在线(推送可达,但是离线) ResponseCode#RES_PEER_NIM_OFFLINE
10404:频道不存在 ResponseCode#RES_CHANNEL_NOT_EXISTS
10406:不在频道内(自己或者对方)ResponseCode#RES_CHANNEL_MEMBER_NOT_EXISTS
更多...
|
|
InvocationFuture< ChannelFullInfo > | call (CallParamBuilder callParamBuilder) |
| 直接呼叫 , 用于用户新开一个频道并邀请对方加入频道。该接口为组合接口,等同于用户先创建频道,然后加入频道并邀请对方。
错误码如下:
10201:已经成功发出邀请但是对方不在线(推送可达,但是离线)ResponseCode#RES_PEER_NIM_OFFLINE
10202:已经成功发出邀请但是对方推送不可达 ResponseCode#RES_PEER_PUSH_OFFLINE
10405:频道已存在 ResponseCode#RES_CHANNEL_HAS_EXISTS
更多...
|
|
InvocationFuture< CallExResult > | callEx (CallExParam callExParam) |
| 直接呼叫,用于用户新开一个频道并邀请对方加入频道。该接口功能等同于用户先创建频道,然后加入频道并邀请对方。 和call(CallParamBuilder)的区别在于call(CallParamBuilder)在客户端完成组合,客户端需要向服务器发起三次网络请求; callEx(CallExParam)在服务端完成组合,客户端只需要向服务器发起一次网络请求,推荐使用callEx(CallExParam)
错误码如下:
10405:频道已存在 ResponseCode#RES_CHANNEL_HAS_EXISTS
更多...
|
|
InvocationFuture< ChannelBaseInfo > | queryChannelInfo (String channelName) |
| 根据channelName反查channelInfo 更多...
|
|
InvocationFuture< ChannelFullInfo > | queryChannelFullInfo (String channelName) |
| 根据channelName反查channelInfo, 聚合接口,可以替代queryChannelInfo, queryChannelMemberCount, queryChannelMemberList 更多...
|
|
InvocationFuture< Integer > | queryChannelMemberCount (String channelName) |
| 根据channelName查询房间内人数 10404:频道不存在 ResponseCode#RES_CHANNEL_NOT_EXISTS
更多...
|
|
InvocationFuture< List< MemberInfo > > | queryChannelMemberList (String channelName) |
| 根据channelName查询房间内用户列表 10404:频道不存在 ResponseCode#RES_CHANNEL_NOT_EXISTS
更多...
|
|