im-rel-pack  unspecified
Public 成员函数 | 所有成员列表
com.netease.nimlib.sdk.auth.AuthService接口 参考

用户认证服务接口,提供用户登录登出业务接口。 更多...

Public 成员函数

AbortableFuture< LoginInfologin (LoginInfo info)
 登录接口。sdk会自动连接服务器,传递用户信息,返回登录结果。
该操作中途可取消。如果因为网络比较差,或其他原因导致服务器迟迟没有返回,用户也没有主动取消, 在45秒后AbortableFuture的onFailed会被调用到。 更多...
 
void logout ()
 注销接口 更多...
 
InvocationFuture< Void > kickOtherClient (OnlineClient client)
 踢掉多端同时在线的其他端 更多...
 
int getKickedClientType ()
 如果自己被其他断踢掉, 通过该接口获取踢掉你的客户端类型。 注意:如果当前状态不是被其他端踢出(包含服务端禁用并踢出),比如自动登录监听到417,则该接口返回值无效。 更多...
 
int getKickedCustomClientType ()
 如果自己被其他断踢掉, 通过该接口获取踢掉你的客户端自定义类型。 注意:如果当前状态不是被其他端踢出(包含服务端禁用并踢出),比如自动登录监听到417,则该接口返回值无效。 更多...
 
boolean openLocalCache (String account)
 离线时打开本地数据 适用场景:在手动登录没有成功前(可能由于网络问题,登录时间较长),可以访问SDK本地数据。 此外,不调用本接口,采用自动登录也能达到同样的效果。 更多...
 
String getDeviceID ()
 获取登录时传给服务端的设备id 说明: 这个id 并不是真正意义上的设备id ,是生成的随机uuid ,如果应用卸载重装,可能会重新生成 更多...
 
void killUI ()
 
void killCore ()
 
void exit ()
 

详细描述

用户认证服务接口,提供用户登录登出业务接口。

在文件 AuthService.java11 行定义.

成员函数说明

◆ exit()

void com.netease.nimlib.sdk.auth.AuthService.exit ( )

◆ getDeviceID()

String com.netease.nimlib.sdk.auth.AuthService.getDeviceID ( )

获取登录时传给服务端的设备id 说明: 这个id 并不是真正意义上的设备id ,是生成的随机uuid ,如果应用卸载重装,可能会重新生成

返回
deviceID

◆ getKickedClientType()

int com.netease.nimlib.sdk.auth.AuthService.getKickedClientType ( )

如果自己被其他断踢掉, 通过该接口获取踢掉你的客户端类型。 注意:如果当前状态不是被其他端踢出(包含服务端禁用并踢出),比如自动登录监听到417,则该接口返回值无效。

返回
踢掉你的客户端类型

◆ getKickedCustomClientType()

int com.netease.nimlib.sdk.auth.AuthService.getKickedCustomClientType ( )

如果自己被其他断踢掉, 通过该接口获取踢掉你的客户端自定义类型。 注意:如果当前状态不是被其他端踢出(包含服务端禁用并踢出),比如自动登录监听到417,则该接口返回值无效。

返回
踢掉你的客户端自定义类型

◆ kickOtherClient()

InvocationFuture<Void> com.netease.nimlib.sdk.auth.AuthService.kickOtherClient ( OnlineClient  client)

踢掉多端同时在线的其他端

参数
client被踢端信息
返回
InvocationFuture 可设置回调函数,监听操作结果。

◆ killCore()

void com.netease.nimlib.sdk.auth.AuthService.killCore ( )

◆ killUI()

void com.netease.nimlib.sdk.auth.AuthService.killUI ( )

◆ login()

AbortableFuture<LoginInfo> com.netease.nimlib.sdk.auth.AuthService.login ( LoginInfo  info)

登录接口。sdk会自动连接服务器,传递用户信息,返回登录结果。
该操作中途可取消。如果因为网络比较差,或其他原因导致服务器迟迟没有返回,用户也没有主动取消, 在45秒后AbortableFuture的onFailed会被调用到。

参数
info登录的用户信息
返回
AbortableFuture

◆ logout()

void com.netease.nimlib.sdk.auth.AuthService.logout ( )

注销接口

◆ openLocalCache()

boolean com.netease.nimlib.sdk.auth.AuthService.openLocalCache ( String  account)

离线时打开本地数据 适用场景:在手动登录没有成功前(可能由于网络问题,登录时间较长),可以访问SDK本地数据。 此外,不调用本接口,采用自动登录也能达到同样的效果。

返回
是否成功打开SDK本地数据

该接口的文档由以下文件生成: