io.straas.android.sdk.messaging.user

Enum UserType

java.lang.Object

java.lang.Enum<UserType>

io.straas.android.sdk.messaging.user.UserType

All Implemented Interfaces:

Serializable, Comparable<UserType>

public enum UserType
extends Enum<UserType>

User type, this categorizes User and could be used in ChatroomManager.getUsers(UserType).

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLOCKED Indicates the User whose role is Role.BLOCKED no matter whether he/she is online or not.
ONLINE_USER Indicates the User who is online no matter which Role he/she belongs to.
SUPERVISOR Indicates the User whose role is Role.GLOBAL_MANAGER, Role.LOCAL_MANAGER, Role.MASTER, or Role.MODERATOR no matter whether he/she is online or not.

Method Summary

Modifier and Type	Method and Description
static UserType	valueOf(String name) Returns the enum constant of this type with the specified name.
static UserType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

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

ONLINE_USER

public static final UserType ONLINE_USER

Indicates the User who is online no matter which Role he/she belongs to.

SUPERVISOR

public static final UserType SUPERVISOR

Indicates the User whose role is Role.GLOBAL_MANAGER, Role.LOCAL_MANAGER, Role.MASTER, or Role.MODERATOR no matter whether he/she is online or not.

BLOCKED

public static final UserType BLOCKED

Indicates the User whose role is Role.BLOCKED no matter whether he/she is online or not.

Method Detail

values

public static UserType[] 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 (UserType c : UserType.values())
    System.out.println(c);

Returns:

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

valueOf

public static UserType valueOf(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:

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

NullPointerException - if the argument is null