Package zendesk.chat.client

Enum ChatLog.UserRole

java.lang.Object

java.lang.Enum<ChatLog.UserRole>

zendesk.chat.client.ChatLog.UserRole

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ChatLog.UserRole>

Enclosing class:

ChatLog

public static enum ChatLog.UserRole
extends java.lang.Enum<ChatLog.UserRole>

Describes the role of the user. Used to distinguish the author of the ChatLog.

See Also:

ChatLog.getUserRole()

Enum Constant Summary

Enum Constants

Enum Constant and Description
AGENT Chat log was sent by the agent.
SYSTEM Chat log was sent by the system.
TRIGGER Chat log was sent by the trigger.
VISITOR Chat log was sent by the visitor.

Method Summary

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

SYSTEM

public static final ChatLog.UserRole SYSTEM

Chat log was sent by the system.

AGENT

public static final ChatLog.UserRole AGENT

Chat log was sent by the agent.

See Also:

Agent

TRIGGER

public static final ChatLog.UserRole TRIGGER

Chat log was sent by the trigger.

VISITOR

public static final ChatLog.UserRole VISITOR

Chat log was sent by the visitor.

Method Detail

values

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

Returns:

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

valueOf

public static ChatLog.UserRole 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