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)
已过时。
|
InvocationFuture<ChannelFullInfo> |
acceptInviteAndJoin(InviteParamBuilder paramBuilder,
long selfUid,
java.lang.String nertcChannelName,
java.lang.Long nertcTokenTtl)
已过时。
|
InvocationFuture<ChannelFullInfo> |
call(CallParamBuilder callParamBuilder)
已过时。
用
callEx(CallExParam) 代替 |
InvocationFuture<CallExResult> |
callEx(CallExParam callExParam)
直接呼叫,用于用户新开一个频道并邀请对方加入频道。
|
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)
|
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<ChannelFullInfo> |
join(java.lang.String channelId,
long selfUid,
java.lang.String customInfo,
boolean offlineEnable,
java.lang.String nertcChannelName,
java.lang.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(java.lang.String channelId,
long selfUid,
java.lang.String customInfo,
boolean offlineEnable,
java.lang.String nertcChannelName,
java.lang.Long nertcTokenTtl,
java.lang.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<JoinAndAcceptResult> |
joinAndAccept(JoinAndAcceptParam joinAndAcceptParam)
加入频道并接受对方邀请,该接口功能等同于用户先加入频道,然后接受对方邀请。
|
InvocationFuture<java.lang.Void> |
leave(java.lang.String channelId,
boolean offlineEnable,
java.lang.String customInfo)
|
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)
该接口用于在频道中透传一些自定义指令,协助频道管理。
|
InvocationFuture<ChannelBaseInfo> create(ChannelType type, java.lang.String channelName, java.lang.String channelExt)
type
- 频道类型channelName
- 频道名,可缺省channelExt
- 频道的自定义扩展信息,可缺省InvocationFuture<java.lang.Void> close(java.lang.String channelId, boolean offlineEnabled, java.lang.String customInfo)
channelId
- 对应频道idofflineEnabled
- 通知事件是否存离线customInfo
- 操作者附加的自定义信息,透传给其他人,可缺省InvocationFuture<ChannelFullInfo> join(java.lang.String channelId, long selfUid, java.lang.String customInfo, boolean offlineEnable)
ResponseCode.RES_CHANNEL_MEMBER_HAS_EXISTS
ResponseCode.RES_JOIN_CHANNEL_UID_CONFLICT
ResponseCode.RES_CHANNEL_MEMBER_EXCEED
ResponseCode.RES_CHANNEL_MEMBER_HAS_EXISTS_OTHER_CLIENT
channelId
- 对应频道idselfUid
- 自己在频道中对应的uid,可选,大于零有效,无效时服务器会分配随机唯一的uid, 也可以自己生成,但要保证唯一性customInfo
- 操作者附加的自定义信息,透传给其他人,可缺省offlineEnable
- 通知事件是否存离线InvocationFuture<ChannelFullInfo> join(java.lang.String channelId, long selfUid, java.lang.String customInfo, boolean offlineEnable, java.lang.String nertcChannelName, java.lang.Long nertcTokenTtl)
ResponseCode.RES_CHANNEL_MEMBER_HAS_EXISTS
ResponseCode.RES_JOIN_CHANNEL_UID_CONFLICT
ResponseCode.RES_CHANNEL_MEMBER_EXCEED
ResponseCode.RES_CHANNEL_MEMBER_HAS_EXISTS_OTHER_CLIENT
channelId
- 对应频道idselfUid
- 自己在频道中对应的uid,可选,大于零有效,无效时服务器会分配随机唯一的uid, 也可以自己生成,但要保证唯一性customInfo
- 操作者附加的自定义信息,透传给其他人,可缺省offlineEnable
- 通知事件是否存离线nertcChannelName
- 云信G2-RTC的房间名,如果填了该字段,则会返回tokennertcTokenTtl
- 云信G2-RTC的token的有效期,单位秒,选填InvocationFuture<ChannelFullInfo> join(java.lang.String channelId, long selfUid, java.lang.String customInfo, boolean offlineEnable, java.lang.String nertcChannelName, java.lang.Long nertcTokenTtl, java.lang.String nertcJoinRoomQueryParamMap)
ResponseCode.RES_CHANNEL_MEMBER_HAS_EXISTS
ResponseCode.RES_JOIN_CHANNEL_UID_CONFLICT
ResponseCode.RES_CHANNEL_MEMBER_EXCEED
ResponseCode.RES_CHANNEL_MEMBER_HAS_EXISTS_OTHER_CLIENT
channelId
- 对应频道idselfUid
- 自己在频道中对应的uid,可选,大于零有效,无效时服务器会分配随机唯一的uid, 也可以自己生成,但要保证唯一性customInfo
- 操作者附加的自定义信息,透传给其他人,可缺省offlineEnable
- 通知事件是否存离线nertcChannelName
- 云信G2-RTC的房间名,如果填了该字段,则会返回tokennertcTokenTtl
- 云信G2-RTC的token的有效期,单位秒,选填nertcJoinRoomQueryParamMap
- 云信G2-RTC加入房间的响应,可以转成json,选填InvocationFuture<java.lang.Void> leave(java.lang.String channelId, boolean offlineEnable, java.lang.String customInfo)
channelId
- 对应频道idofflineEnable
- 通知事件是否存离线customInfo
- 操作者附加的自定义信息,透传给其他人,可缺省InvocationFuture<java.lang.Void> invite(InviteParamBuilder paramBuilder)
ResponseCode.RES_PEER_NIM_OFFLINE
ResponseCode.RES_PEER_PUSH_OFFLINE
ResponseCode.RES_CHANNEL_NOT_EXISTS
ResponseCode.RES_CHANNEL_MEMBER_NOT_EXISTS
ResponseCode.RES_CHANNEL_MEMBER_HAS_EXISTS
ResponseCode.RES_CHANNEL_MEMBER_EXCEED
提示:这里的回调建议设置成 RequestCallbackWrapper
,并通过返回的code 去处理相关的逻辑 ,code = 200 为成功
如果用RequestCallback
,那么错误码将在RequestCallback.onFailed(int code)
返回。
paramBuilder
- InviteParamBuilder InviteParamBuilder
InvocationFuture<java.lang.Void> cancelInvite(InviteParamBuilder paramBuilder)
ResponseCode.RES_CHANNEL_NOT_EXISTS
ResponseCode.RES_INVITE_NOT_EXISTS
ResponseCode.RES_INVITE_HAS_REJECT
ResponseCode.RES_INVITE_HAS_ACCEPT
paramBuilder
- InviteParamBuilder InviteParamBuilder
InvocationFuture<java.lang.Void> rejectInvite(InviteParamBuilder paramBuilder)
ResponseCode.RES_PEER_NIM_OFFLINE
ResponseCode.RES_CHANNEL_NOT_EXISTS
ResponseCode.RES_INVITE_NOT_EXISTS
ResponseCode.RES_INVITE_HAS_REJECT
ResponseCode.RES_INVITE_HAS_ACCEPT
提示:这里的回调建议设置成 RequestCallbackWrapper
,并通过返回的code 去处理相关的逻辑 ,code = 200 为成功
如果用RequestCallback
,那么错误码将在RequestCallback.onFailed(int code)
返回。
paramBuilder
- InviteParamBuilder InviteParamBuilder
InvocationFuture<java.lang.Void> acceptInvite(InviteParamBuilder paramBuilder)
acceptInviteAndJoin(InviteParamBuilder, long)
ResponseCode.RES_PEER_NIM_OFFLINE
ResponseCode.RES_CHANNEL_NOT_EXISTS
ResponseCode.RES_INVITE_NOT_EXISTS
ResponseCode.RES_INVITE_HAS_REJECT
ResponseCode.RES_INVITE_HAS_ACCEPT
提示:这里的回调建议设置成 RequestCallbackWrapper
,并通过返回的code 去处理相关的逻辑 ,code = 200 为成功
如果用RequestCallback
,那么错误码将在RequestCallback.onFailed(int code)
返回。
paramBuilder
- InviteParamBuilder InviteParamBuilder
@Deprecated InvocationFuture<ChannelFullInfo> acceptInviteAndJoin(InviteParamBuilder paramBuilder, long selfUid)
joinAndAccept(JoinAndAcceptParam)
代替ResponseCode.RES_CHANNEL_MEMBER_HAS_EXISTS_OTHER_CLIENT
ResponseCode.RES_PEER_NIM_OFFLINE
ResponseCode.RES_CHANNEL_HAS_EXISTS
ResponseCode.RES_CHANNEL_MEMBER_HAS_EXISTS
ResponseCode.RES_INVITE_NOT_EXISTS
ResponseCode.RES_INVITE_HAS_REJECT
ResponseCode.RES_INVITE_HAS_ACCEPT
ResponseCode.RES_JOIN_CHANNEL_UID_CONFLICT
ResponseCode.RES_CHANNEL_MEMBER_EXCEED
提示:这里的回调建议设置成 RequestCallbackWrapper
,并通过返回的code 去处理相关的逻辑 ,code = 200 为成功
如果用RequestCallback
,那么错误码将在RequestCallback.onFailed(int code)
返回。
paramBuilder
- InviteParamBuilder InviteParamBuilder
selfUid
- 自己在频道中对应的uid,大于零有效,无效时服务器会分配随机唯一的uid, 也可以自己生成,但要保证唯一性@Deprecated InvocationFuture<ChannelFullInfo> acceptInviteAndJoin(InviteParamBuilder paramBuilder, long selfUid, java.lang.String nertcChannelName, java.lang.Long nertcTokenTtl)
joinAndAccept(JoinAndAcceptParam)
代替ResponseCode.RES_CHANNEL_MEMBER_HAS_EXISTS_OTHER_CLIENT
ResponseCode.RES_PEER_NIM_OFFLINE
ResponseCode.RES_CHANNEL_HAS_EXISTS
ResponseCode.RES_CHANNEL_MEMBER_HAS_EXISTS
ResponseCode.RES_INVITE_NOT_EXISTS
ResponseCode.RES_INVITE_HAS_REJECT
ResponseCode.RES_INVITE_HAS_ACCEPT
ResponseCode.RES_JOIN_CHANNEL_UID_CONFLICT
ResponseCode.RES_CHANNEL_MEMBER_EXCEED
提示:这里的回调建议设置成 RequestCallbackWrapper
,并通过返回的code 去处理相关的逻辑 ,code = 200 为成功
如果用RequestCallback
,那么错误码将在RequestCallback.onFailed(int code)
返回。
paramBuilder
- InviteParamBuilder InviteParamBuilder
selfUid
- 自己在频道中对应的uid,大于零有效,无效时服务器会分配随机唯一的uid, 也可以自己生成,但要保证唯一性nertcChannelName
- 云信G2-RTC的房间名,如果填了该字段,则会返回tokennertcTokenTtl
- 云信G2-RTC的token的有效期,单位秒,选填InvocationFuture<JoinAndAcceptResult> joinAndAccept(JoinAndAcceptParam joinAndAcceptParam)
acceptInviteAndJoin(InviteParamBuilder, long)
和acceptInviteAndJoin(InviteParamBuilder, long, String, Long)
需要两次网络请求,推荐使用joinAndAccept(JoinAndAcceptParam)
JoinAndAcceptResult
中的callStatus字段来体现。callStatus字段有一个特殊错误码:
10201:已经成功接受邀请但是对方不在线(推送可达,但是离线) ResponseCode.RES_PEER_NIM_OFFLINE
joinAndAcceptParam
- JoinAndAcceptParam JoinAndAcceptParam
InvocationFuture<java.lang.Void> sendControl(java.lang.String channelId, java.lang.String accountId, java.lang.String customInfo)
ResponseCode.RES_PEER_NIM_OFFLINE
ResponseCode.RES_CHANNEL_NOT_EXISTS
ResponseCode.RES_CHANNEL_MEMBER_NOT_EXISTS
提示:这里的回调建议设置成 RequestCallbackWrapper
,并通过返回的code 去处理相关的逻辑 ,code = 200 为成功
如果用RequestCallback
,那么错误码将在RequestCallback.onFailed(int code)
返回。
channelId
- 频道idaccountId
- 对方accid,如果为空,则通知所有人customInfo
- 操作者附加的自定义信息,透传给其他人,可缺省@Deprecated InvocationFuture<ChannelFullInfo> call(CallParamBuilder callParamBuilder)
callEx(CallExParam)
代替ResponseCode.RES_PEER_NIM_OFFLINE
ResponseCode.RES_PEER_PUSH_OFFLINE
ResponseCode.RES_CHANNEL_HAS_EXISTS
提示:这里的回调建议设置成 RequestCallbackWrapper
,并通过返回的code 去处理相关的逻辑 ,code = 200 为成功
如果用RequestCallback
,那么错误码将在RequestCallback.onFailed(int code)
返回。
callParamBuilder
- CallParamBuilder CallParamBuilder
InvocationFuture<CallExResult> callEx(CallExParam callExParam)
call(CallParamBuilder)
的区别在于call(CallParamBuilder)
在客户端完成组合,客户端需要向服务器发起三次网络请求;
callEx(CallExParam)
在服务端完成组合,客户端只需要向服务器发起一次网络请求,推荐使用callEx(CallExParam)
ResponseCode.RES_CHANNEL_HAS_EXISTS
提示:以上接口返回200,代表创建频道成功并且自己已经加入,邀请对方的结果通过返回值CallExResult
中的callStatus字段来体现。callStatus字段有两个特殊错误码:
10201:已经成功发出邀请但是对方不在线(推送可达,但是离线)ResponseCode.RES_PEER_NIM_OFFLINE
10202:已经成功发出邀请但是对方推送不可达 ResponseCode.RES_PEER_PUSH_OFFLINE
callExParam
- CallExParam
,通过CallExParamBuilder创建InvocationFuture<ChannelBaseInfo> queryChannelInfo(java.lang.String channelName)
ResponseCode.RES_CHANNEL_NOT_EXISTS
提示:这里的回调建议设置成 RequestCallbackWrapper
,并通过返回的code 去处理相关的逻辑 ,code = 200 为成功
如果用RequestCallback
,那么错误码将在RequestCallback.onFailed(int code)
返回。
channelName
- InvocationFuture<ChannelFullInfo> queryChannelFullInfo(java.lang.String channelName)
ResponseCode.RES_CHANNEL_NOT_EXISTS
提示:这里的回调建议设置成 RequestCallbackWrapper
,并通过返回的code 去处理相关的逻辑 ,code = 200 为成功
如果用RequestCallback
,那么错误码将在RequestCallback.onFailed(int code)
返回。
channelName
- InvocationFuture<java.lang.Integer> queryChannelMemberCount(java.lang.String channelName)
ResponseCode.RES_CHANNEL_NOT_EXISTS
提示:这里的回调建议设置成 RequestCallbackWrapper
,并通过返回的code 去处理相关的逻辑 ,code = 200 为成功
如果用RequestCallback
,那么错误码将在RequestCallback.onFailed(int code)
返回。
channelName
- InvocationFuture<java.util.List<MemberInfo>> queryChannelMemberList(java.lang.String channelName)
ResponseCode.RES_CHANNEL_NOT_EXISTS
提示:这里的回调建议设置成 RequestCallbackWrapper
,并通过返回的code 去处理相关的逻辑 ,code = 200 为成功
如果用RequestCallback
,那么错误码将在RequestCallback.onFailed(int code)
返回。
channelName
-