NIM.ClientAPI类 参考

NIM SDK提供的Client接口，主要包括SDK初始化/清理、客户端登录/退出/重连/掉线/被踢等流程 更多...

Public 成员函数
delegate void	KickOtherClientResultHandler (NIMKickOtherResult result)
delegate void	MultiSpotLoginNotifyResultHandler (NIMMultiSpotLoginNotifyResult result)
delegate void	KickoutResultHandler (NIMKickoutResult result)
delegate void	LogoutResultDelegate (NIMLogoutResult result)
delegate void	LoginResultDelegate (NIMLoginResult result)
delegate void	DndConfigureDelegate (ResponseCode resCode, DndConfigParam config)

静态 Public 成员函数
static bool	Init (string appDataDir, string appInstallDir="", NimUtility.NimConfig config=null)
	NIM SDK初始化 更多...
static void	RegisterSdkCallbacks ()
	注册全局回调函数，在切换账号都需要重新注册 更多...
static void	Cleanup ()
	NIM SDK清理 更多...
static void	Login (string appKey, string account, string token, LoginResultDelegate handler=null)
	NIM客户端登录 更多...
static void	Relogin (string jsonExtension=null)
	NIM客户端手动重连（注意 APP需要统一处理自动重连/手动重连的回调，因为如果处于某次自动重连的过程中调用手动重连接口，不起作用！） . 更多...
static void	Logout (NIMLogoutType logoutType, LogoutResultDelegate @delegate)
	NIM客户端注销/退出，异步方法，回调函数中报告执行结果 更多...
static void	Logout (NIMLogoutType logoutType, int waitSeconds=10)
	NIM客户端注销/退出，同步方法 更多...
static void	KickOtherClients (NIMKickoutOtherDeviceInfo devices)
	将本帐号的其他端踢下线.通过注册RegKickOtherClientCb回调得到结果 更多...
static void	RegAutoReloginCb (LoginResultDelegate handler, string jsonExtension=null)
	注册NIM客户端自动重连回调。重连失败时，如果不是网络错误引起的（网络相关的错误号为kNIMResTimeoutError和kNIMResConnectionError），而是服务器返回了非kNIMResSuccess的错误号, 则说明重连的机制已经失效，需要APP层调用Logout执行注销操作并退回到登录界面后进行重新登录. 更多...
static void	RegKickoutCb (KickoutResultHandler handler)
	注册NIM客户端被踢回调. 更多...
static void	RegDisconnectedCb (Action handler)
	注册NIM客户端掉线回调. 更多...
static void	RegMultiSpotLoginNotifyCb (MultiSpotLoginNotifyResultHandler handler)
	注册NIM客户端多点登录通知回调. 更多...
static void	RegKickOtherClientCb (KickOtherClientResultHandler handler)
	注册NIM客户端将本帐号的其他端踢下线结果回调. 更多...
static void	EnableMultiportPush (ConfigMultiportPushDelegate cb)
	开启多端推送 更多...
static void	DisableMultiportPush (ConfigMultiportPushDelegate cb)
	禁止多端推送 更多...
static void	IsMultiportPushEnabled (ConfigMultiportPushDelegate cb)
	获取多端推送控制开关 更多...
static void	RegMulitiportPushEnableChangedCb (ConfigMultiportPushDelegate cb)
	注册多端推送设置同步回调 更多...
static void	UpdateApnsToken (string token)
	更新ios推送token 更多...
static void	SetDndConfig (DndConfigParam param, DndConfigureDelegate cb)
	ios 免打扰设置 更多...
static void	GetDndConfig (DndConfigureDelegate cb)
	获取ios 免打扰设置 更多...
static NIMLoginState	GetLoginState (string jsonExt=null)
	获取NIM客户端登录状态 更多...

静态 Public 属性
static EventHandler< LoginResultEventArgs >	LoginResultHandler

属性
static bool	SdkInitialized [get]
	SDK是否已经初始化 更多...

详细描述

NIM SDK提供的Client接口，主要包括SDK初始化/清理、客户端登录/退出/重连/掉线/被踢等流程

成员函数说明

Init()

static bool NIM.ClientAPI.Init ( string  appDataDir, string  appInstallDir = "", NimUtility.NimConfig  config = null  )

inlinestatic

NIM SDK初始化

参数

appDataDir	使用默认路径时只需传入单个目录名（不以反斜杠结尾)，使用自定义路径时需传入完整路径（以反斜杠结尾，并确保有正确的读写权限！）.
appInstallDir	目前不需要传入（SDK可以自动获取）.
config	The config.

返回

true 成功, false 失败

RegisterSdkCallbacks()

static void NIM.ClientAPI.RegisterSdkCallbacks ( )

inlinestatic

注册全局回调函数，在切换账号都需要重新注册

Cleanup()

static void NIM.ClientAPI.Cleanup ( )

inlinestatic

NIM SDK清理

Login()

static void NIM.ClientAPI.Login ( string  appKey, string  account, string  token, LoginResultDelegate  handler = null  )

inlinestatic

NIM客户端登录

参数

appKey	The app key.
account	The account.
token	令牌 (在后台绑定的登录token).
handler	登录流程的回调函数

Relogin()

static void NIM.ClientAPI.Relogin ( string  jsonExtension = null )

inlinestatic

NIM客户端手动重连（注意 APP需要统一处理自动重连/手动重连的回调，因为如果处于某次自动重连的过程中调用手动重连接口，不起作用！） .

参数

jsonExtension

json扩展参数（备用，目前不需要）.

Logout() [1/2]

static void NIM.ClientAPI.Logout ( NIMLogoutType  logoutType, LogoutResultDelegate @  delegate  )

inlinestatic

NIM客户端注销/退出，异步方法，回调函数中报告执行结果

参数

logoutType	Logout操作类型
delegate	注销/退出的回调函数.

Logout() [2/2]

static void NIM.ClientAPI.Logout ( NIMLogoutType  logoutType, int  waitSeconds = 10  )

inlinestatic

NIM客户端注销/退出，同步方法

参数

logoutType
waitSeconds

KickOtherClients()

static void NIM.ClientAPI.KickOtherClients ( NIMKickoutOtherDeviceInfo  devices )

inlinestatic

将本帐号的其他端踢下线.通过注册RegKickOtherClientCb回调得到结果

参数

devices

设备标识

RegAutoReloginCb()

static void NIM.ClientAPI.RegAutoReloginCb ( LoginResultDelegate  handler, string  jsonExtension = null  )

inlinestatic

注册NIM客户端自动重连回调。重连失败时，如果不是网络错误引起的（网络相关的错误号为kNIMResTimeoutError和kNIMResConnectionError），而是服务器返回了非kNIMResSuccess的错误号, 则说明重连的机制已经失效，需要APP层调用Logout执行注销操作并退回到登录界面后进行重新登录.

参数

jsonExtension	json扩展参数（备用，目前不需要）
handler	自动重连的回调函数 如果返回错误号kNIMResExist，说明无法继续重连，App层必须调用Logout退出到登录界面，以便用户重新进行登录.

RegKickoutCb()

static void NIM.ClientAPI.RegKickoutCb ( KickoutResultHandler  handler )

inlinestatic

注册NIM客户端被踢回调.

参数

handler

被踢回调

RegDisconnectedCb()

static void NIM.ClientAPI.RegDisconnectedCb ( Action  handler )

inlinestatic

注册NIM客户端掉线回调.

参数

handler

掉线的回调函数.

RegMultiSpotLoginNotifyCb()

static void NIM.ClientAPI.RegMultiSpotLoginNotifyCb ( MultiSpotLoginNotifyResultHandler  handler )

inlinestatic

注册NIM客户端多点登录通知回调.

参数

handler

多点登录通知的回调函数.

RegKickOtherClientCb()

static void NIM.ClientAPI.RegKickOtherClientCb ( KickOtherClientResultHandler  handler )

inlinestatic

注册NIM客户端将本帐号的其他端踢下线结果回调.

参数

handler

操作结果的回调函数.

EnableMultiportPush()

static void NIM.ClientAPI.EnableMultiportPush ( ConfigMultiportPushDelegate  cb )

inlinestatic

开启多端推送

参数

cb

操作结果委托

DisableMultiportPush()

static void NIM.ClientAPI.DisableMultiportPush ( ConfigMultiportPushDelegate  cb )

inlinestatic

禁止多端推送

参数

cb

操作结果委托

IsMultiportPushEnabled()

static void NIM.ClientAPI.IsMultiportPushEnabled ( ConfigMultiportPushDelegate  cb )

inlinestatic

获取多端推送控制开关

参数

cb

RegMulitiportPushEnableChangedCb()

static void NIM.ClientAPI.RegMulitiportPushEnableChangedCb ( ConfigMultiportPushDelegate  cb )

inlinestatic

注册多端推送设置同步回调

参数

cb

UpdateApnsToken()

static void NIM.ClientAPI.UpdateApnsToken ( string  token )

inlinestatic

更新ios推送token

参数

token

SetDndConfig()

static void NIM.ClientAPI.SetDndConfig ( DndConfigParam  param, DndConfigureDelegate  cb  )

inlinestatic

ios 免打扰设置

参数

param
cb

GetDndConfig()

static void NIM.ClientAPI.GetDndConfig ( DndConfigureDelegate  cb )

inlinestatic

获取ios 免打扰设置

参数

cb

GetLoginState()

static NIMLoginState NIM.ClientAPI.GetLoginState ( string  jsonExt = null )

inlinestatic

获取NIM客户端登录状态

参数

jsonExt

返回

属性说明

SdkInitialized

bool NIM.ClientAPI.SdkInitialized

staticget

SDK是否已经初始化

---

该类的文档由以下文件生成:

• NIMClientAPI.cs