com.tencent.imsdk.v2

类 V2TIMSignalingManagerImpl

java.lang.Object

com.tencent.imsdk.v2.V2TIMSignalingManager

com.tencent.imsdk.v2.V2TIMSignalingManagerImpl

public class V2TIMSignalingManagerImpl
extends V2TIMSignalingManager

方法概要

限定符和类型	方法和说明
void	accept(java.lang.String inviteID, java.lang.String data, V2TIMCallback callback) 接收方接收邀请
void	addInvitedSignaling(V2TIMSignalingInfo info, V2TIMCallback callback) 添加邀请信令（可以用于群离线推送消息触发的邀请信令） 在离线推送的场景下： - 1V1邀请，被邀请者 APP 如果被 Kill，当 APP 收到离线推送再次启动后，如果邀请还没超时，用户会收到 onReceiveNewInvitation 回调，如果邀请已经超时，用户会收到 onInvitationTimeout 回调。
void	addSignalingListener(V2TIMSignalingListener listener) 添加信令监听
void	cancel(java.lang.String inviteID, java.lang.String data, V2TIMCallback callback) 邀请方取消邀请
V2TIMSignalingInfo	getSignalingInfo(V2TIMMessage msg) 获取信令信息 如果 invite 设置 onlineUserOnly 为 false，每次信令操作（包括 invite、cancel、accept、reject、timeout）都会产生一条自定义消息， 该消息会通过 V2TIMAdvancedMsgListener -> onRecvNewMessage 抛给用户，用户也可以通过历史消息拉取，如果需要根据信令信息做自定义化文本展示，可以调用下面接口获取信令信息。
java.lang.String	invite(java.lang.String invitee, java.lang.String data, boolean onlineUserOnly, V2TIMOfflinePushInfo offlinePushInfo, int timeout, V2TIMCallback callback) 邀请某个人
java.lang.String	inviteInGroup(java.lang.String groupID, java.util.List<java.lang.String> inviteeList, java.lang.String data, boolean onlineUserOnly, int timeout, V2TIMCallback callback) 邀请群内的某些人
void	reject(java.lang.String inviteID, java.lang.String data, V2TIMCallback callback) 接收方拒绝邀请
void	removeSignalingListener(V2TIMSignalingListener listener) 移除信令监听

从类继承的方法 java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

方法详细资料

addSignalingListener

public void addSignalingListener(V2TIMSignalingListener listener)

从类复制的说明: V2TIMSignalingManager

添加信令监听

指定者:

addSignalingListener 在类中 V2TIMSignalingManager

removeSignalingListener

public void removeSignalingListener(V2TIMSignalingListener listener)

从类复制的说明: V2TIMSignalingManager

移除信令监听

指定者:

removeSignalingListener 在类中 V2TIMSignalingManager

invite

public java.lang.String invite(java.lang.String invitee,
                               java.lang.String data,
                               boolean onlineUserOnly,
                               V2TIMOfflinePushInfo offlinePushInfo,
                               int timeout,
                               V2TIMCallback callback)

从类复制的说明: V2TIMSignalingManager

邀请某个人

指定者:

invite 在类中 V2TIMSignalingManager

参数:

invitee - 被邀请人用户 ID

data - 自定义数据

onlineUserOnly - 是否只有在线用户才能收到邀请，如果设置为 true，只有在线用户才能收到， 并且 invite 操作也不会产生历史消息（针对该次 invite 的后续 cancel、accept、reject、timeout 操作也同样不会产生历史消息）。

offlinePushInfo - 离线推送信息，其中 desc 为必填字段，推送的时候会默认展示 desc 信息。

timeout - 超时时间，单位秒，如果设置为 0，SDK 不会做超时检测，也不会触发 onInvitationTimeout 回调

返回:

inviteID 邀请 ID，如果邀请失败，返回 null

inviteInGroup

public java.lang.String inviteInGroup(java.lang.String groupID,
                                      java.util.List<java.lang.String> inviteeList,
                                      java.lang.String data,
                                      boolean onlineUserOnly,
                                      int timeout,
                                      V2TIMCallback callback)

从类复制的说明: V2TIMSignalingManager

邀请群内的某些人

指定者:

inviteInGroup 在类中 V2TIMSignalingManager

参数:

groupID - 发起邀请所在群组

inviteeList - 被邀请人列表，inviteeList 必须已经在 groupID 群里，否则邀请无效

onlineUserOnly - 是否只有在线用户才能收到邀请，如果设置为 true，只有在线用户才能收到， 并且 invite 操作也不会产生历史消息（针对该次 invite 的后续 cancel、accept、reject、timeout 操作也同样不会产生历史消息）。

timeout - 超时时间，单位秒，如果设置为 0，SDK 不会做超时检测，也不会触发 onInvitationTimeout 回调

返回:

inviteID 邀请 ID，如果邀请失败，返回 null

cancel

public void cancel(java.lang.String inviteID,
                   java.lang.String data,
                   V2TIMCallback callback)

从类复制的说明: V2TIMSignalingManager

邀请方取消邀请

指定者:

cancel 在类中 V2TIMSignalingManager

参数:

inviteID - 邀请 ID

accept

public void accept(java.lang.String inviteID,
                   java.lang.String data,
                   V2TIMCallback callback)

从类复制的说明: V2TIMSignalingManager

接收方接收邀请

指定者:

accept 在类中 V2TIMSignalingManager

reject

public void reject(java.lang.String inviteID,
                   java.lang.String data,
                   V2TIMCallback callback)

从类复制的说明: V2TIMSignalingManager

接收方拒绝邀请

指定者:

reject 在类中 V2TIMSignalingManager

getSignalingInfo

public V2TIMSignalingInfo getSignalingInfo(V2TIMMessage msg)

从类复制的说明: V2TIMSignalingManager

获取信令信息 如果 invite 设置 onlineUserOnly 为 false，每次信令操作（包括 invite、cancel、accept、reject、timeout）都会产生一条自定义消息， 该消息会通过 V2TIMAdvancedMsgListener -> onRecvNewMessage 抛给用户，用户也可以通过历史消息拉取，如果需要根据信令信息做自定义化文本展示，可以调用下面接口获取信令信息。

指定者:

getSignalingInfo 在类中 V2TIMSignalingManager

参数:

msg - 消息对象

返回:

V2TIMSignalingInfo 信令信息，如果为 null，则 msg 不是一条信令消息。

addInvitedSignaling

public void addInvitedSignaling(V2TIMSignalingInfo info,
                                V2TIMCallback callback)

从类复制的说明: V2TIMSignalingManager

添加邀请信令（可以用于群离线推送消息触发的邀请信令） 在离线推送的场景下： - 1V1邀请，被邀请者 APP 如果被 Kill，当 APP 收到离线推送再次启动后，如果邀请还没超时，用户会收到 onReceiveNewInvitation 回调，如果邀请已经超时，用户会收到 onInvitationTimeout 回调。 - 群邀请，被邀请者 APP 如果被 Kill，当 APP 收到离线推送再次启动后，SDK 无法自动同步到邀请信令信息，如果您想要在该场景下处理邀请，请在发送推送消息时携带信令信息（代码参考 TRTCAVCallImpl -> sendOnlineMessageWithOfflinePushInfo），收到推送时候解析信令信息（代码参考 OfflineMessageDispatcher -> redirect），然后调用 addInvitedSignaling 主动添加信令信息。 TUIKit 音视频通话离线推送功能基于这个接口实现，详细实现方法请参考文档：[集成音视频通话](https://cloud.tencent.com/document/product/269/46141)

指定者:

addInvitedSignaling 在类中 V2TIMSignalingManager