com.netease.nimlib.sdk.auth

Interface AuthService

public interface AuthService

Authentication service interface for login and logout.

Method Summary

Modifier and Type	Method and Description
void	exit()
java.lang.String	getDeviceID() Get the device ID that sent to the server during login.
int	getKickedClientType() If the current login is invalidated, the interface allows you to get the type of client that invalidates the current login.
int	getKickedCustomClientType() Get the type of clients that invalidate the current login.
InvocationFuture<java.lang.Void>	kickOtherClient(OnlineClient client) Invalidate logins on other devices.
void	killCore()
void	killUI()
AbortableFuture<LoginInfo>	login(LoginInfo info) Login interface.
void	logout() Logout interface
boolean	openLocalCache(java.lang.String account) Open the local cache when the client is offline.

Method Detail

login

AbortableFuture<LoginInfo> login(LoginInfo info)

Login interface. The SDK automatically connects to the server and transmit user information. And the response returns the result.
Abortable operation If no response is turned due to poor network or other reasons, app users can cancel the operation. The onFailed callback for AbortableFuture is triggered after 45 seconds.

Parameters:

info - The user infor used for login

Returns:

AbortableFuture

logout

void logout()

Logout interface

kickOtherClient

InvocationFuture<java.lang.Void> kickOtherClient(OnlineClient client)

Invalidate logins on other devices.

Parameters:

client - The client where the login is invalidated.

Returns:

InvocationFuture Set a callback for the operation result.

getKickedClientType

int getKickedClientType()

If the current login is invalidated, the interface allows you to get the type of client that invalidates the current login. Note: if the current login is not invalidated by login attempts from other devices or banned on the server, the return value of the interface is invalid. For example, the HTTP 417 Expectation Failed client error response code is returned.

Returns:

the type of client that invalidates the current login.

getKickedCustomClientType

int getKickedCustomClientType()

Get the type of clients that invalidate the current login. Note: if the current login is not invalidated by login attempts from other devices or banned on the server, the return value of the interface is invalid. For example, the HTTP 417 Expectation Failed client error response code is returned.

Returns:

the custom type of client that invalidates the current login.

openLocalCache

boolean openLocalCache(java.lang.String account)

Open the local cache when the client is offline. Use case: when manual login fails due to network troubles, the client can open the SDK local cache. Automatic login without calling this interface can also open the local cache.

Returns:

the result of the operation.

getDeviceID

java.lang.String getDeviceID()

Get the device ID that sent to the server during login. Note: The ID is not the identifier for a real device but a random uuid. If the app gets uninstalled and reinstalled, a new ID will be generated.

Returns:

deviceID

killUI

void killUI()

killCore

void killCore()

exit

void exit()