SignallingService

```
public interface SignallingService
```

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`InvocationFuture<java.lang.Void>`	`acceptInvite(InviteParamBuilder paramBuilder)` 接受对方邀请，但并不代表加入了频道，如果想在接受邀请时自动加入频道，参考`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` 提示：这里的回调建议设置成 `RequestCallbackWrapper`，并通过返回的code 去处理相关的逻辑，code = 200 为成功如果用`RequestCallback`，那么错误码将在`RequestCallback.onFailed(int code)`返回。
`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` 提示：这里的回调建议设置成 `RequestCallbackWrapper`，并通过返回的code 去处理相关的逻辑，code = 200 为成功如果用`RequestCallback`，那么错误码将在`RequestCallback.onFailed(int code)`返回。
`InvocationFuture<ChannelFullInfo>`	`call(CallParamBuilder callParamBuilder)` 直接呼叫，用于用户新开一个频道并邀请对方加入频道。
`InvocationFuture<java.lang.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<java.lang.Void>`	`close(java.lang.String channelId, boolean offlineEnabled, java.lang.String customInfo)` 关闭频道错误码如下： 10406：不在频道内 `ResponseCode.RES_CHANNEL_MEMBER_NOT_EXISTS`
`InvocationFuture<ChannelBaseInfo>`	`create(ChannelType type, java.lang.String channelName, java.lang.String channelExt)` 创建频道同一时刻频道名互斥，不能重复创建，但如果频道名缺省，服务器会自动分配频道id。
`InvocationFuture<java.lang.Void>`	`invite(InviteParamBuilder paramBuilder)` 邀请他人加入频道该接口用于邀请对方加入频道，邀请者必须是创建者或者是频道中成员。
`InvocationFuture<ChannelFullInfo>`	`join(java.lang.String channelId, long selfUid, java.lang.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<java.lang.Void>`	`leave(java.lang.String channelId, boolean offlineEnable, java.lang.String customInfo)` 离开频道错误码如下： 10406：不在频道内 `ResponseCode.RES_CHANNEL_MEMBER_NOT_EXISTS`
`InvocationFuture<ChannelFullInfo>`	`queryChannelFullInfo(java.lang.String channelName)` 根据channelName反查channelInfo，聚合接口，可以替代queryChannelInfo， queryChannelMemberCount， queryChannelMemberList 10404:频道不存在 `ResponseCode.RES_CHANNEL_NOT_EXISTS` 提示：这里的回调建议设置成 `RequestCallbackWrapper`，并通过返回的code 去处理相关的逻辑，code = 200 为成功如果用`RequestCallback`，那么错误码将在`RequestCallback.onFailed(int code)`返回。
`InvocationFuture<ChannelBaseInfo>`	`queryChannelInfo(java.lang.String channelName)` 根据channelName反查channelInfo 10404:频道不存在 `ResponseCode.RES_CHANNEL_NOT_EXISTS` 提示：这里的回调建议设置成 `RequestCallbackWrapper`，并通过返回的code 去处理相关的逻辑，code = 200 为成功如果用`RequestCallback`，那么错误码将在`RequestCallback.onFailed(int code)`返回。
`InvocationFuture<java.lang.Integer>`	`queryChannelMemberCount(java.lang.String channelName)` 根据channelName查询房间内人数 10404:频道不存在 `ResponseCode.RES_CHANNEL_NOT_EXISTS` 提示：这里的回调建议设置成 `RequestCallbackWrapper`，并通过返回的code 去处理相关的逻辑，code = 200 为成功如果用`RequestCallback`，那么错误码将在`RequestCallback.onFailed(int code)`返回。
`InvocationFuture<java.util.List<MemberInfo>>`	`queryChannelMemberList(java.lang.String channelName)` 根据channelName查询房间内用户列表 10404:频道不存在 `ResponseCode.RES_CHANNEL_NOT_EXISTS` 提示：这里的回调建议设置成 `RequestCallbackWrapper`，并通过返回的code 去处理相关的逻辑，code = 200 为成功如果用`RequestCallback`，那么错误码将在`RequestCallback.onFailed(int code)`返回。
`InvocationFuture<java.lang.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` 提示：这里的回调建议设置成 `RequestCallbackWrapper`，并通过返回的code 去处理相关的逻辑，code = 200 为成功如果用`RequestCallback`，那么错误码将在`RequestCallback.onFailed(int code)`返回。
`InvocationFuture<java.lang.Void>`	`sendControl(java.lang.String channelId, java.lang.String accountId, java.lang.String customInfo)` 该接口用于在频道中透传一些自定义指令，协助频道管理。

- 方法详细资料
  - create
```
InvocationFuture<ChannelBaseInfo> create(ChannelType type,
                                         java.lang.String channelName,
                                         java.lang.String channelExt)
```
    创建频道
    同一时刻频道名互斥，不能重复创建，但如果频道名缺省，服务器会自动分配频道id。
    
    错误码如下：
    10405：频道已存在 ResponseCode.RES_CHANNEL_HAS_EXISTS
    
    参数:
    
    type - 频道类型
    
    channelName - 频道名，可缺省
    
    channelExt - 频道的自定义扩展信息，可缺省
    
    返回:
    
    InvocationFuture
  - close
```
InvocationFuture<java.lang.Void> close(java.lang.String channelId,
                                       boolean offlineEnabled,
                                       java.lang.String customInfo)
```
    关闭频道
    
    错误码如下：
    10406：不在频道内 ResponseCode.RES_CHANNEL_MEMBER_NOT_EXISTS
    
    参数:
    
    channelId - 对应频道id
    
    offlineEnabled - 通知事件是否存离线
    
    customInfo - 操作者附加的自定义信息，透传给其他人，可缺省
    
    返回:
    
    InvocationFuture
  - join
```
InvocationFuture<ChannelFullInfo> join(java.lang.String channelId,
                                       long selfUid,
                                       java.lang.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
    
    参数:
    
    channelId - 对应频道id
    
    selfUid - 自己在频道中对应的uid，可选，大于零有效，无效时服务器会分配随机唯一的uid，也可以自己生成，但要保证唯一性
    
    customInfo - 操作者附加的自定义信息，透传给其他人，可缺省
    
    offlineEnable - 通知事件是否存离线
    
    返回:
    
    InvocationFuture
  - leave
```
InvocationFuture<java.lang.Void> leave(java.lang.String channelId,
                                       boolean offlineEnable,
                                       java.lang.String customInfo)
```
    离开频道
    
    错误码如下：
    10406：不在频道内 ResponseCode.RES_CHANNEL_MEMBER_NOT_EXISTS
    
    参数:
    
    channelId - 对应频道id
    
    offlineEnable - 通知事件是否存离线
    
    customInfo - 操作者附加的自定义信息，透传给其他人，可缺省
    
    返回:
    
    InvocationFuture
  - invite
```
InvocationFuture<java.lang.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
    
    提示：这里的回调建议设置成 RequestCallbackWrapper，并通过返回的code 去处理相关的逻辑，code = 200 为成功
    如果用RequestCallback，那么错误码将在RequestCallback.onFailed(int code)返回。
    
    参数:
    
    paramBuilder - InviteParamBuilder InviteParamBuilder
    
    返回:
    
    InvocationFuture
  - cancelInvite
```
InvocationFuture<java.lang.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
    
    参数:
    
    paramBuilder - InviteParamBuilder InviteParamBuilder
    
    返回:
    
    InvocationFuture
  - rejectInvite
```
InvocationFuture<java.lang.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
    
    提示：这里的回调建议设置成 RequestCallbackWrapper，并通过返回的code 去处理相关的逻辑，code = 200 为成功
    如果用RequestCallback，那么错误码将在RequestCallback.onFailed(int code)返回。
    
    参数:
    
    paramBuilder - InviteParamBuilder InviteParamBuilder
    
    返回:
    
    InvocationFuture
  - acceptInvite
```
InvocationFuture<java.lang.Void> acceptInvite(InviteParamBuilder paramBuilder)
```
    接受对方邀请，但并不代表加入了频道，如果想在接受邀请时自动加入频道，参考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
    
    提示：这里的回调建议设置成 RequestCallbackWrapper，并通过返回的code 去处理相关的逻辑，code = 200 为成功
    如果用RequestCallback，那么错误码将在RequestCallback.onFailed(int code)返回。
    
    参数:
    
    paramBuilder - InviteParamBuilder InviteParamBuilder
    
    返回:
    
    InvocationFuture
  - acceptInviteAndJoin
```
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
    
    提示：这里的回调建议设置成 RequestCallbackWrapper，并通过返回的code 去处理相关的逻辑，code = 200 为成功
    如果用RequestCallback，那么错误码将在RequestCallback.onFailed(int code)返回。
    
    参数:
    
    paramBuilder - InviteParamBuilder InviteParamBuilder
    
    selfUid - 自己在频道中对应的uid，大于零有效，无效时服务器会分配随机唯一的uid，也可以自己生成，但要保证唯一性
    
    返回:
    
    InvocationFuture
  - sendControl
```
InvocationFuture<java.lang.Void> sendControl(java.lang.String channelId,
                                             java.lang.String accountId,
                                             java.lang.String customInfo)
```
    该接口用于在频道中透传一些自定义指令，协助频道管理。该接口允许非频道内成员调用，但接收者必须是频道内成员或创建者
    
    错误码如下：
    10201：已经成功发出命令但是对方不在线（推送可达，但是离线） ResponseCode.RES_PEER_NIM_OFFLINE
    10404:频道不存在 ResponseCode.RES_CHANNEL_NOT_EXISTS
    10406:不在频道内（自己或者对方）ResponseCode.RES_CHANNEL_MEMBER_NOT_EXISTS
    
    提示：这里的回调建议设置成 RequestCallbackWrapper，并通过返回的code 去处理相关的逻辑，code = 200 为成功
    如果用RequestCallback，那么错误码将在RequestCallback.onFailed(int code)返回。
    
    参数:
    
    channelId - 频道id
    
    accountId - 对方accid，如果为空，则通知所有人
    
    customInfo - 操作者附加的自定义信息，透传给其他人，可缺省
    
    返回:
    
    InvocationFuture
  - call
```
InvocationFuture<ChannelFullInfo> call(CallParamBuilder callParamBuilder)
```
    直接呼叫，用于用户新开一个频道并邀请对方加入频道。该接口为组合接口，等同于用户先创建频道，然后加入频道并邀请对方。
    
    错误码如下：
    10201:已经成功发出邀请但是对方不在线（推送可达，但是离线）ResponseCode.RES_PEER_NIM_OFFLINE
    10202:已经成功发出邀请但是对方推送不可达 ResponseCode.RES_PEER_PUSH_OFFLINE
    10405:频道已存在 ResponseCode.RES_CHANNEL_HAS_EXISTS
    
    提示：这里的回调建议设置成 RequestCallbackWrapper，并通过返回的code 去处理相关的逻辑，code = 200 为成功
    如果用RequestCallback，那么错误码将在RequestCallback.onFailed(int code)返回。
    
    参数:
    
    callParamBuilder - CallParamBuilder CallParamBuilder
    
    返回:
    
    InvocationFuture
  - queryChannelInfo
```
InvocationFuture<ChannelBaseInfo> queryChannelInfo(java.lang.String channelName)
```
    根据channelName反查channelInfo 10404:频道不存在 ResponseCode.RES_CHANNEL_NOT_EXISTS
    
    提示：这里的回调建议设置成 RequestCallbackWrapper，并通过返回的code 去处理相关的逻辑，code = 200 为成功
    如果用RequestCallback，那么错误码将在RequestCallback.onFailed(int code)返回。
    
    参数:
    
    channelName -
    
    返回:
    
    InvocationFuture
  - queryChannelFullInfo
```
InvocationFuture<ChannelFullInfo> queryChannelFullInfo(java.lang.String channelName)
```
    根据channelName反查channelInfo，聚合接口，可以替代queryChannelInfo， queryChannelMemberCount， queryChannelMemberList 10404:频道不存在 ResponseCode.RES_CHANNEL_NOT_EXISTS
    
    提示：这里的回调建议设置成 RequestCallbackWrapper，并通过返回的code 去处理相关的逻辑，code = 200 为成功
    如果用RequestCallback，那么错误码将在RequestCallback.onFailed(int code)返回。
    
    参数:
    
    channelName -
    
    返回:
    
    InvocationFuture
  - queryChannelMemberCount
```
InvocationFuture<java.lang.Integer> queryChannelMemberCount(java.lang.String channelName)
```
    根据channelName查询房间内人数 10404:频道不存在 ResponseCode.RES_CHANNEL_NOT_EXISTS
    
    提示：这里的回调建议设置成 RequestCallbackWrapper，并通过返回的code 去处理相关的逻辑，code = 200 为成功
    如果用RequestCallback，那么错误码将在RequestCallback.onFailed(int code)返回。
    
    参数:
    
    channelName -
    
    返回:
    
    InvocationFuture
  - queryChannelMemberList
```
InvocationFuture<java.util.List<MemberInfo>> queryChannelMemberList(java.lang.String channelName)
```
    根据channelName查询房间内用户列表 10404:频道不存在 ResponseCode.RES_CHANNEL_NOT_EXISTS
    
    提示：这里的回调建议设置成 RequestCallbackWrapper，并通过返回的code 去处理相关的逻辑，code = 200 为成功
    如果用RequestCallback，那么错误码将在RequestCallback.onFailed(int code)返回。
    
    参数:
    
    channelName -
    
    返回:
    
    InvocationFuture>

接口 SignallingService

方法概要

方法详细资料

create

close

join

leave

invite

cancelInvite

rejectInvite

acceptInvite

acceptInviteAndJoin

sendControl

call

queryChannelInfo

queryChannelFullInfo

queryChannelMemberCount

queryChannelMemberList