Class V2TIMManager
SDK管理类
Inheritance
Namespace: com.tencent.imsdk.unity
Assembly: im-unity-plugin.dll
Syntax
public class V2TIMManager : object
Methods
addAdvancedMsgListener()
设置高级消息监听器
高级消息和基本消息,两个监听器不能共用,只能设置一个,否则回调信息可能会错乱
Declaration
public void addAdvancedMsgListener()
addSignalingListener()
设置信令监听器
Declaration
public void addSignalingListener()
addSimpleMsgListener()
设置基本消息(文本消息和自定义消息)的事件监听器
图片消息、视频消息、语音消息等高级消息的监听,请参考addAdvancedMsgListener
高级消息和基本消息,两个监听器不能共用,只能设置一个,否则回调信息可能会错乱
Declaration
public void addSimpleMsgListener()
getDocumentDirectory()
获取app document目录地址(未实现)
Declaration
public string getDocumentDirectory()
Returns
Type | Description |
---|---|
System.String |
getLoginStatus()
获取登录状态
如果用户已经处于已登录和登录中状态,请勿再频繁调用登录接口登录。
Declaration
public LoginStatus getLoginStatus()
Returns
Type | Description |
---|---|
LoginStatus | 用户登录状态 |
getLoginUser()
获取登录用户
Declaration
public string getLoginUser()
Returns
Type | Description |
---|---|
System.String | 用户登录状态 |
getServerTime()
获取服务器当前时间
可用于信令离线推送场景下超时判断。
Declaration
public long getServerTime()
Returns
Type | Description |
---|---|
System.Int64 | 服务器时间,单位 s |
getUsersInfo(String[])
获取用户资料
获取自己的资料,传入自己的 ID 即可。
userIDList 建议一次最大 100 个,因为数量过多可能会导致数据包太大被后台拒绝,后台限制数据包最大为 1M。
Declaration
public void getUsersInfo(string[] userIDList)
Parameters
Type | Name | Description |
---|---|---|
System.String[] | userIDList | 用户id列表 |
getVersion()
获取版本号
Declaration
public string getVersion()
Returns
Type | Description |
---|---|
System.String | 返回版本号,字符串表示,例如 5.0.10 |
initSDK(Int32, LogLevel)
初始化SDK
Declaration
public bool initSDK(int sdkAppID, LogLevel logLevel)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | sdkAppID | 应用 ID,必填项,可以在 控制台 中获取 |
LogLevel | logLevel | 日志级别 |
Returns
Type | Description |
---|---|
System.Boolean |
login(String, String)
登录
登录需要设置用户名 userID 和用户签名 userSig,userSig 生成请参考 UserSig 后台 API。
请注意如下特殊逻辑:
登陆时票据过期:login 函数的失败,会返回 6206、20002、70001 错误码,此时生成新的 userSig 重新登录。
在线时票据过期:用户在线期间也可能收到 onUserSigExpired 回调,此时也是需要您生成新的 userSig 并重新登录。
在线时被踢下线:用户在线情况下被踢,SDK 会通过 onKickedOffline 回调通知给您,此时可以 UI 提示用户,并再次调用 login() 重新登录。
Declaration
public void login(string userID, string userSig)
Parameters
Type | Name | Description |
---|---|---|
System.String | userID | |
System.String | userSig |
logout()
退出登录
退出登录,如果切换账号,需要 logout 回调成功或者失败后才能再次 login,否则 login 可能会失败。
Declaration
public void logout()
setAPNS()
设置推送配置(未实现)
Declaration
public void setAPNS()
setAPNSListener()
设置推送监听器
Declaration
public void setAPNSListener()
setConversationListener()
设置会话监听器
Declaration
public void setConversationListener()
setFriendListener()
设置好友关系监听器
Declaration
public void setFriendListener()
setGroupListener()
设置群监听器
Declaration
public void setGroupListener()
setSelfInfo(String, String, String, Gender, FriendAllowType, Dictionary<String, String>, UInt32, UInt32)
修改个人资料
Declaration
public void setSelfInfo(string nickName, string faceUrl, string selfSignature, Gender gender, FriendAllowType allowType, Dictionary<string, string> customInfo, uint role, uint level)
Parameters
Type | Name | Description |
---|---|---|
System.String | nickName | 用户昵称 |
System.String | faceUrl | 用户头像地址 |
System.String | selfSignature | 用户签名 |
Gender | gender | 性别 |
FriendAllowType | allowType | 好友验证方式 |
Dictionary<System.String, System.String> | customInfo | 用户自定义字段,首先要在 控制台 (功能配置 -> 用户自定义字段) 配置用户自定义字段,然后再调用该接口进行设置,key 值不需要加 Tag_Profile_Custom_ 前缀。 |
System.UInt32 | role | |
System.UInt32 | level |
setUnreadCount()
设置角标未读数量(未实现)
Declaration
public void setUnreadCount()
unInitSDK()
反初始化SDK
Declaration
public void unInitSDK()