co.aurasphere.botmill.fb.model.outcoming.action

Enum TypingAction

java.lang.Object

java.lang.Enum<TypingAction>

co.aurasphere.botmill.fb.model.outcoming.action.TypingAction

All Implemented Interfaces:

Serializable, Comparable<TypingAction>

public enum TypingAction
extends Enum<TypingAction>

Enum that represents the non-message actions that a bot can perform. They are used in conjunction with FbBotMillActionResponse.

Author:

Donato Rimenti, Alvin Reyes

Enum Constant Summary

Enum Constants

Enum Constant and Description
MARK_SEEN Marks the message as seen.
TYPING_OFF Removes the "is writing..." label if present.
TYPING_ON Brings up the "is writing..." label.

Method Summary

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

MARK_SEEN

public static final TypingAction MARK_SEEN

Marks the message as seen.

TYPING_ON

public static final TypingAction TYPING_ON

Brings up the "is writing..." label. This label is turned off automatically after 20 seconds or when a TYPING_OFF action is sent.

TYPING_OFF

public static final TypingAction TYPING_OFF

Removes the "is writing..." label if present.

Method Detail

values

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

Returns:

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

valueOf

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