ChatSDK.SDKClient类 参考

Public 成员函数
void	AddConnectionDelegate (IConnectionDelegate connectionDelegate)
void	DeleteConnectionDelegate (IConnectionDelegate connectionDelegate)
void	AddMultiDeviceDelegate (IMultiDeviceDelegate multiDeviceDelegate)
void	DeleteMultiDeviceDelegate (IMultiDeviceDelegate multiDeviceDelegate)
void	InitWithOptions (Options options)
void	CreateAccount (string username, string password, CallBack handle=null)
void	Login (string username, string pwdOrToken, bool isToken=false, CallBack handle=null)
void	LoginWithAgoraToken (string username, string token, CallBack handle=null)
void	RenewAgoraToken (string token)
void	Logout (bool unbindDeviceToken, CallBack handle=null)

属性
static SDKClient	Instance [get]
IChatManager	ChatManager [get]
IContactManager	ContactManager [get]
IGroupManager	GroupManager [get]
IRoomManager	RoomManager [get]
IUserInfoManager	UserInfoManager [get]
IPresenceManager	PresenceManager [get]
IChatThreadManager	ThreadManager [get]
Options	Options [get]
string	SdkVersion [get]
string	CurrentUsername [get]
bool	IsLoggedIn [get]
bool	IsConnected [get]
string	AccessToken [get]

详细描述

SDK 客户端类是 Chat SDK 的入口，负责登录、登出及管理 SDK 与 chat 服务器之间的连接。

成员函数说明

AddConnectionDelegate()

void ChatSDK.SDKClient.AddConnectionDelegate

(

IConnectionDelegate

connectionDelegate

)

注册连接监听器。

参数

connectionDelegate

要注册的连接监听器，继承自 IConnectionDelegate。

DeleteConnectionDelegate()

void ChatSDK.SDKClient.DeleteConnectionDelegate

(

IConnectionDelegate

connectionDelegate

)

移除指定的连接监听器。

参数

connectionDelegate

要移除的连接监听器，继承自 IConnectionDelegate。

AddMultiDeviceDelegate()

void ChatSDK.SDKClient.AddMultiDeviceDelegate

(

IMultiDeviceDelegate

multiDeviceDelegate

)

注册多设备监听器。

参数

multiDeviceDelegate

要注册的多设备监听器，继承自 IMultiDeviceDelegate。

DeleteMultiDeviceDelegate()

void ChatSDK.SDKClient.DeleteMultiDeviceDelegate

(

IMultiDeviceDelegate

multiDeviceDelegate

)

移除指定的多设备监听器。

参数

multiDeviceDelegate

要移除的多设备监听器，继承自 IMultiDeviceDelegate。

InitWithOptions()

void ChatSDK.SDKClient.InitWithOptions

(

Options

options

)

初始化 SDK。

请确保调用其他方法前，完成 SDK 初始化。

参数

options

SDK 初始化选项，必填，请参见 Options。

CreateAccount()

void ChatSDK.SDKClient.CreateAccount	(	string	username,
		string	password,
		CallBack	handle = null
	)

创建账号。

异步方法。

参数

username

用户 ID。该参数必填。用户 ID 不能超过 64 个字符，支持以下类型的字符： 26 个小写英文字母 a-z 26 个大写英文字母 A-Z 10 个数字 0-9 "_", "-", "."

用户 ID 不区分大小写，大写字母会自动转换为小写字母。

用户的电子邮件地址和 UUID 不能作为用户 ID。

可通过以下格式的正则表达式设置用户 ID：^[a-zA-Z0-9_-]+$。

参数

password	密码，长度不超过 64 个字符。该参数必填。
handle	创建结果回调，详见 CallBack。

Login()

void ChatSDK.SDKClient.Login	(	string	username,
		string	pwdOrToken,
		bool	isToken = false,
		CallBack	handle = null
	)

利用密码或环信 token 登录 chat 服务器。

异步方法。

参数

username	用户 ID，必填。
pwdOrToken	用户密码或者 token，必填。
isToken	是否通过 token 登录。 true：通过 token 登录。 （默认） false：通过密码登录。
handle	登录结果回调，详见 CallBack。

LoginWithAgoraToken()

void ChatSDK.SDKClient.LoginWithAgoraToken	(	string	username,
		string	token,
		CallBack	handle = null
	)

通过用户 ID 和声网 token 登录 chat 服务器。

通过用户 ID 和密码登录 chat 服务器，详见 )。

异步方法。

参数

username	用户 ID，必填。
token	声网 token，必填。
handle	登录结果回调，详见 CallBack。

RenewAgoraToken()

void ChatSDK.SDKClient.RenewAgoraToken

(

string

token

)

更新声网 token。

当用户通过声网 token 登录时，在 IConnectionDelegate 回调中收到 token 即将过期的通知时可更新 token，避免因 token 失效产生未知问题。

参数

token

新的声网 token。

Logout()

void ChatSDK.SDKClient.Logout	(	bool	unbindDeviceToken,
		CallBack	handle = null
	)

退出登录。

异步方法。

参数

unbindDeviceToken	登出时是否解绑 token。该参数仅对移动平台有效。 true：是。 false：否。
handle	退出结果回调，详见 CallBack。

属性说明

ChatManager

IChatManager ChatSDK.SDKClient.ChatManager

get

聊天管理器实例。

ContactManager

IContactManager ChatSDK.SDKClient.ContactManager

get

好友管理器实例。

GroupManager

IGroupManager ChatSDK.SDKClient.GroupManager

get

群组管理器实例。

RoomManager

IRoomManager ChatSDK.SDKClient.RoomManager

get

聊天室管理器实例。

UserInfoManager

IUserInfoManager ChatSDK.SDKClient.UserInfoManager

get

用户信息管理器实例。

PresenceManager

IPresenceManager ChatSDK.SDKClient.PresenceManager

get

在线状态管理器实例。

ThreadManager

IChatThreadManager ChatSDK.SDKClient.ThreadManager

get

子区管理器实例。

Options

Options ChatSDK.SDKClient.Options

get

SDK 选项。

SdkVersion

string ChatSDK.SDKClient.SdkVersion

get

SDK 版本号。

CurrentUsername

string ChatSDK.SDKClient.CurrentUsername

get

当前登录用户的 ID。

IsLoggedIn

bool ChatSDK.SDKClient.IsLoggedIn

get

是否已经登录。

• true: 已登录；
• false：未登录。

IsConnected

bool ChatSDK.SDKClient.IsConnected

get

SDK 是否连接到服务器。

• true: 已连接；
• false：未连接。

AccessToken

string ChatSDK.SDKClient.AccessToken

get

当前用户的 token。