com.netease.nimlib.sdk

Enum StatusCode

java.lang.Object

java.lang.Enum<StatusCode>

com.netease.nimlib.sdk.StatusCode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<StatusCode>

public enum StatusCode
extends java.lang.Enum<StatusCode>

The definitions of status codes for current users

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONNECTING Connecting
DATA_UPGRADE Data upgrade
FORBIDDEN The account is banned by the server
INVALID Undefined
KICK_BY_OTHER_CLIENT Kicked by concurrent logins on other clients
KICKOUT Login gets invalidated when another login using the same account succeeds on other devices
LOGINED Logged in
LOGINING Logging in
NET_BROKEN Disconnected
PWD_ERROR Incorrect username or password
SYNCING Syncing data
UNLOGIN Not logged in or login failed
VER_ERROR Client verison error

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDesc()
int	getValue()
void	setDesc(java.lang.String desc)
boolean	shouldReLogin()
static StatusCode	statusOfResCode(int resCode)
static StatusCode	typeOfValue(int value)
static StatusCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static StatusCode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
boolean	wontAutoLogin() Specify whether to continue reconnecting for login with the current status code.
boolean	wontAutoLoginForever() Specify whether to continue reconnecting for login with the current status code, even if the process is killed, automatic login will not resume.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INVALID

public static final StatusCode INVALID

Undefined

UNLOGIN

public static final StatusCode UNLOGIN

Not logged in or login failed

NET_BROKEN

public static final StatusCode NET_BROKEN

Disconnected

CONNECTING

public static final StatusCode CONNECTING

Connecting

LOGINING

public static final StatusCode LOGINING

Logging in

SYNCING

public static final StatusCode SYNCING

Syncing data

LOGINED

public static final StatusCode LOGINED

Logged in

KICKOUT

public static final StatusCode KICKOUT

Login gets invalidated when another login using the same account succeeds on other devices

KICK_BY_OTHER_CLIENT

public static final StatusCode KICK_BY_OTHER_CLIENT

Kicked by concurrent logins on other clients

FORBIDDEN

public static final StatusCode FORBIDDEN

The account is banned by the server

VER_ERROR

public static final StatusCode VER_ERROR

Client verison error

PWD_ERROR

public static final StatusCode PWD_ERROR

Incorrect username or password

DATA_UPGRADE

public static final StatusCode DATA_UPGRADE

Data upgrade

Method Detail

values

public static StatusCode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StatusCode c : StatusCode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static StatusCode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

wontAutoLogin

public boolean wontAutoLogin()

Specify whether to continue reconnecting for login with the current status code.

Returns:

If true is returned, the SDK will stop automatic login, and the upper-layer of the app requires a login call to continue login.

wontAutoLoginForever

public boolean wontAutoLoginForever()

Specify whether to continue reconnecting for login with the current status code, even if the process is killed, automatic login will not resume. If FORBIDDEN is returned, the account may be unbanned by the server. If PWD_ERROR is returned, the account is allowed to log in automatically when the process restarts.

Returns:

If true is returned, the SDK will stop automatic login. The app will not connect for login if the process is restarted by push schedule. The upper-layer of the app requires a login call to continue login.

shouldReLogin

public boolean shouldReLogin()

getValue

public int getValue()

getDesc

public java.lang.String getDesc()

setDesc

public void setDesc(java.lang.String desc)

typeOfValue

public static StatusCode typeOfValue(int value)

statusOfResCode

public static StatusCode statusOfResCode(int resCode)