Public 成员函数
int	InitWithOptions (Options options)

void	CreateAccount (string userId, string password, CallBack callback=null)

void	Login (string userId, string pwdOrToken, bool isToken=false, CallBack callback=null)

void	LoginWithToken (string userId, string token, CallBack callback=null)

void	Logout (bool unbindDeviceToken=true, CallBack callback=null)

void	LoginWithAgoraToken (string userId, string token, CallBack callback=null)

void	RenewAgoraToken (string token)

void	RenewToken (string token)

void	GetLoggedInDevicesFromServer (string userId, string password, ValueCallBack< List< DeviceInfo > > callback=null)

void	GetLoggedInDevicesFromServerWithToken (string userId, string token, ValueCallBack< List< DeviceInfo > > callback=null)

void	KickDevice (string userId, string password, string resource, CallBack callback=null)

void	KickDeviceWithToken (string userId, string token, string resource, CallBack callback=null)

void	KickAllDevices (string userId, string password, CallBack callback=null)

void	KickAllDevicesWithToken (string userId, string token, CallBack callback=null)

void	AddConnectionDelegate (IConnectionDelegate connectionDelegate)

void	DeleteConnectionDelegate (IConnectionDelegate connectionDelegate)

void	AddMultiDeviceDelegate (IMultiDeviceDelegate multiDeviceDelegate)

void	DeleteMultiDeviceDelegate (IMultiDeviceDelegate multiDeviceDelegate)

void	DeInit ()

属性
static SDKClient	Instance `[get]`

ChatManager	ChatManager `[get]`

ContactManager	ContactManager `[get]`

GroupManager	GroupManager `[get]`

RoomManager	RoomManager `[get]`

UserInfoManager	UserInfoManager `[get]`

PresenceManager	PresenceManager `[get]`

ChatThreadManager	ThreadManager `[get]`

string	SdkVersion `[get]`

string	CurrentUsername `[get]`

bool	IsLoggedIn `[get]`

bool	IsConnected `[get]`

string	AccessToken `[get]`

详细描述

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

成员函数说明

◆ InitWithOptions()

int AgoraChat.SDKClient.InitWithOptions ( Options options )

初始化 SDK。

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

参数

options SDK 初始化选项，必填，详见 Options。

返回

返回初始化结果：

0：成功；
100：App Key 不合法。

◆ CreateAccount()

void AgoraChat.SDKClient.CreateAccount	(	string	userId,
		string	password,
		CallBack	callback = `null`
	)

创建账号。

该方法不推荐使用，建议调用相应的 RESTful 方法。

异步方法。

参数

userId

用户 ID。该参数必填。用户 ID 不能超过 64 个字符，支持以下类型的字符：

26 个小写英文字母 a-z
26 个大写英文字母 A-Z
10 个数字 0-9
"_", "-", "."

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

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

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

参数

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

◆ Login()

void AgoraChat.SDKClient.Login	(	string	userId,
		string	pwdOrToken,
		bool	isToken = `false`,
		CallBack	callback = `null`
	)

使用密码或 token 登录服务器。

异步方法。

参数

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

◆ LoginWithToken()

void AgoraChat.SDKClient.LoginWithToken	(	string	userId,
		string	token,
		CallBack	callback = `null`
	)

使用密码或 token 登录服务器。

异步方法。

参数

userId	用户 ID，必填。
token	token。该参数必填。
callback	登录结果回调，详见 `CallBack`。

◆ Logout()

void AgoraChat.SDKClient.Logout	(	bool	unbindDeviceToken = `true`,
		CallBack	callback = `null`
	)

退出登录。

异步方法。

参数

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

◆ LoginWithAgoraToken()

void AgoraChat.SDKClient.LoginWithAgoraToken	(	string	userId,
		string	token,
		CallBack	callback = `null`
	)

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

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

异步方法。

此方法已过时，建议使用Login方法

参数

userId	用户 ID，必填。
token	声网 token，必填。
callback	登录结果回调，详见 `CallBack`。

◆ RenewAgoraToken()

void AgoraChat.SDKClient.RenewAgoraToken ( string token )

更新声网 token。

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

此方法已过时，建议使用 RenewToken 方法

参数

token 新的声网 token。

◆ RenewToken()

void AgoraChat.SDKClient.RenewToken ( string token )

更新token。

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

参数

token 新的 token。

◆ GetLoggedInDevicesFromServer()

void AgoraChat.SDKClient.GetLoggedInDevicesFromServer	(	string	userId,
		string	password,
		ValueCallBack< List< DeviceInfo > >	callback = `null`
	)

获取指定账号下登录的在线设备列表。

异步方法。

参数

userId	用户 ID。
password	密码。
callBack	结果回调，成功时回调 `ValueCallBack#OnSuccessValue(Object)`，返回设备信息列表；失败时回调 `ValueCallBack#onError(int, String)`。

◆ GetLoggedInDevicesFromServerWithToken()

void AgoraChat.SDKClient.GetLoggedInDevicesFromServerWithToken	(	string	userId,
		string	token,
		ValueCallBack< List< DeviceInfo > >	callback = `null`
	)

获取指定账号下登录的在线设备列表。

异步方法。

参数

userId	用户 ID。
token	Token。
callBack	结果回调，成功时回调 `ValueCallBack#OnSuccessValue(Object)`，返回设备信息列表；失败时回调 `ValueCallBack#onError(int, String)`。

◆ KickDevice()

void AgoraChat.SDKClient.KickDevice	(	string	userId,
		string	password,
		string	resource,
		CallBack	callback = `null`
	)

将指定账号登录的指定设备踢下线。

可通过 GetLoggedInDevicesFromServer() 方法获取设备信息 DeviceInfo。

异步方法。

参数

userId	用户 ID。
password	用户的密码。
resource	设备 ID, 见 `DeviceInfo#Resource`。

◆ KickDeviceWithToken()

void AgoraChat.SDKClient.KickDeviceWithToken	(	string	userId,
		string	token,
		string	resource,
		CallBack	callback = `null`
	)

将指定账号登录的指定设备踢下线。

可通过 GetLoggedInDevicesFromServer() 方法获取设备信息 DeviceInfo。

异步方法。

参数

userId	用户 ID。
token	Token。
resource	设备 ID, 见 `DeviceInfo#Resource`。

◆ KickAllDevices()

void AgoraChat.SDKClient.KickAllDevices	(	string	userId,
		string	password,
		CallBack	callback = `null`
	)

将指定账号登录的所有设备都踢下线。

异步方法。

参数

userId	用户 ID。
password	密码。
callback	操作结果回调，详见 `CallBack`。

◆ KickAllDevicesWithToken()

void AgoraChat.SDKClient.KickAllDevicesWithToken	(	string	userId,
		string	token,
		CallBack	callback = `null`
	)

将指定账号登录的所有设备都踢下线。

异步方法。

参数

userId	用户 ID。
token	Token。
callback	操作结果回调，详见 `CallBack`。

◆ AddConnectionDelegate()

void AgoraChat.SDKClient.AddConnectionDelegate ( IConnectionDelegate connectionDelegate )

注册连接状态监听器。

参数

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

◆ DeleteConnectionDelegate()

void AgoraChat.SDKClient.DeleteConnectionDelegate ( IConnectionDelegate connectionDelegate )

移除添加连接状态监听器。

参数

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

◆ AddMultiDeviceDelegate()

void AgoraChat.SDKClient.AddMultiDeviceDelegate ( IMultiDeviceDelegate multiDeviceDelegate )

注册多设备监听器。

参数

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

◆ DeleteMultiDeviceDelegate()

void AgoraChat.SDKClient.DeleteMultiDeviceDelegate ( IMultiDeviceDelegate multiDeviceDelegate )

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

参数

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

属性说明

◆ ChatManager

ChatManager AgoraChat.SDKClient.ChatManager

get

聊天管理器实例。

◆ ContactManager

ContactManager AgoraChat.SDKClient.ContactManager

get

好友管理器实例。

◆ GroupManager

GroupManager AgoraChat.SDKClient.GroupManager

get

群组管理器实例。

◆ RoomManager

RoomManager AgoraChat.SDKClient.RoomManager

get

聊天室管理器实例。

◆ UserInfoManager

UserInfoManager AgoraChat.SDKClient.UserInfoManager

get

用户信息管理器实例。

◆ PresenceManager

PresenceManager AgoraChat.SDKClient.PresenceManager

get

在线状态管理器实例。

◆ ThreadManager

ChatThreadManager AgoraChat.SDKClient.ThreadManager

get

子区管理器实例。

◆ SdkVersion

string AgoraChat.SDKClient.SdkVersion

get

SDK 版本号。

◆ CurrentUsername

string AgoraChat.SDKClient.CurrentUsername

get

当前登录用户的 ID。

◆ IsLoggedIn

bool AgoraChat.SDKClient.IsLoggedIn

get

是否已经登录。

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

◆ IsConnected

bool AgoraChat.SDKClient.IsConnected

get

SDK 是否连接到服务器。

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

◆ AccessToken

string AgoraChat.SDKClient.AccessToken

get

当前用户的 token。

Public 成员函数

属性

详细描述

成员函数说明

◆ InitWithOptions()

◆ CreateAccount()

◆ Login()

◆ LoginWithToken()

◆ Logout()

◆ LoginWithAgoraToken()

◆ RenewAgoraToken()

◆ RenewToken()

◆ GetLoggedInDevicesFromServer()

◆ GetLoggedInDevicesFromServerWithToken()

◆ KickDevice()

◆ KickDeviceWithToken()

◆ KickAllDevices()

◆ KickAllDevicesWithToken()

◆ AddConnectionDelegate()

◆ DeleteConnectionDelegate()

◆ AddMultiDeviceDelegate()

◆ DeleteMultiDeviceDelegate()

属性说明

◆ ChatManager

◆ ContactManager

◆ GroupManager

◆ RoomManager

◆ UserInfoManager

◆ PresenceManager

◆ ThreadManager

◆ SdkVersion

◆ CurrentUsername

◆ IsLoggedIn

◆ IsConnected

◆ AccessToken