Show / Hide Table of Contents

Class V2TIMSignalingManager

信令管理类

Inheritance
System.Object
V2TIMSignalingManager
Namespace: com.tencent.imsdk.unity
Assembly: im-unity-plugin.dll
Syntax
public class V2TIMSignalingManager : object

Methods

accept(String, String)

接收方接受邀请

不能接受不是针对自己的邀请,请在收到 onReceiveNewInvitation 回调的时候先判断 inviteeList 有没有自己,如果没有自己,不能 accept 邀请

Declaration
public void accept(string inviteID, string data)
Parameters
Type Name Description
System.String inviteID

邀请ID

System.String data

自定义数据

addInvitedSignaling(SignalingInfo)

添加邀请信令

Declaration
public void addInvitedSignaling(SignalingInfo signalingInfo)
Parameters
Type Name Description
SignalingInfo signalingInfo

cancel(String, String)

邀请方取消邀请

如果所有被邀请人都已经处理了当前邀请(包含超时),不能再取消当前邀请

Declaration
public void cancel(string inviteID, string data)
Parameters
Type Name Description
System.String inviteID

邀请ID

System.String data

自定义数据

getSignallingInfo(String)

获取信令消息

V2TIMSignalingInfo 信令信息,如果为 nil,则 msg 不是一条信令消息

Declaration
public void getSignallingInfo(string msgID)
Parameters
Type Name Description
System.String msgID

invite(String, String, Boolean, Int32, OfflinePushInfo)

邀请某个人

inviteID 邀请 ID,如果邀请失败,返回 nil

Declaration
public void invite(string invitee, string data, bool onlineUserOnly, int timeout, OfflinePushInfo offlinePushInfo)
Parameters
Type Name Description
System.String invitee

被邀请人用户 ID

System.String data

自定义数据

System.Boolean onlineUserOnly

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

System.Int32 timeout

超时时间,单位 s,如果设置为 0,SDK 不会做超时检测,也不会触发 onInvitationTimeout 回调

OfflinePushInfo offlinePushInfo

苹果 APNS 离线推送时携带的标题和声音,其中 desc 为必填字段,推送的时候会默认展示 desc 信息

inviteInGroup(String, String[], String, Boolean, Int32)

邀请群内的某些人

Declaration
public void inviteInGroup(string groupID, string[] inviteeList, string data, bool onlineUserOnly, int timeout)
Parameters
Type Name Description
System.String groupID

发起邀请所在群组

System.String[] inviteeList

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

System.String data

自定义数据

System.Boolean onlineUserOnly

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

System.Int32 timeout

超时时间,单位 s,如果设置为 0,SDK 不会做超时检测,也不会触发 onInvitationTimeout 回调

reject(String, String)

接收方拒绝邀请

不能接受不是针对自己的邀请,请在收到 onReceiveNewInvitation 回调的时候先判断 inviteeList 有没有自己,如果没有自己,不能 reject 邀请

Declaration
public void reject(string inviteID, string data)
Parameters
Type Name Description
System.String inviteID

邀请ID

System.String data

自定义数据

In This Article
  • Methods
    • accept(String, String)
    • addInvitedSignaling(SignalingInfo)
    • cancel(String, String)
    • getSignallingInfo(String)
    • invite(String, String, Boolean, Int32, OfflinePushInfo)
    • inviteInGroup(String, String[], String, Boolean, Int32)
    • reject(String, String)
Back to top Generated by DocFX