io.straas.android.sdk.messaging

Enum Role

java.lang.Object

java.lang.Enum<Role>

io.straas.android.sdk.messaging.Role

All Implemented Interfaces:

Serializable, Comparable<Role>

public enum Role
extends Enum<Role>

Role means a user's status in a chatroom. This determine what a user can do in a chatroom. See Roles of Messaging Service

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLOCKED User who is blocked in a chatroom, see Roles of Messaging Service
GLOBAL_MANAGER GLOBAL_MANAGER, see Roles of Messaging Service.
LOCAL_MANAGER LOCAL_MANAGER, see Roles of Messaging Service
MASTER MASTER of a chatroom, see Roles of Messaging Service
MODERATOR MODERATOR in a chatroom, see Roles of Messaging Service
NORMAL Normal user in a chatroom, see Roles of Messaging Service
UNKNOWN Unknown Role.

Method Summary

Modifier and Type	Method and Description
static Role	parse(String role)
static Role	valueOf(String name) Returns the enum constant of this type with the specified name.
static Role[]	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

GLOBAL_MANAGER

public static final Role GLOBAL_MANAGER

GLOBAL_MANAGER, see Roles of Messaging Service.

LOCAL_MANAGER

public static final Role LOCAL_MANAGER

LOCAL_MANAGER, see Roles of Messaging Service

MASTER

public static final Role MASTER

MASTER of a chatroom, see Roles of Messaging Service

MODERATOR

public static final Role MODERATOR

MODERATOR in a chatroom, see Roles of Messaging Service

NORMAL

public static final Role NORMAL

Normal user in a chatroom, see Roles of Messaging Service

BLOCKED

public static final Role BLOCKED

User who is blocked in a chatroom, see Roles of Messaging Service

UNKNOWN

public static final Role UNKNOWN

Unknown Role.

Method Detail

values

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

Returns:

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

valueOf

public static Role 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

parse

public static Role parse(String role)