com.microstrategy.ushersdk

Enum MessageEntity.Purpose

java.lang.Object

java.lang.Enum<MessageEntity.Purpose>

com.microstrategy.ushersdk.MessageEntity.Purpose

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MessageEntity.Purpose>

Enclosing class:

MessageEntity

public static enum MessageEntity.Purpose
extends java.lang.Enum<MessageEntity.Purpose>

Enumerations of MessageEntity.Purpose.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INVITATION A invitation message

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INVITATION

public static final MessageEntity.Purpose INVITATION

A invitation message

Method Detail

values

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

Returns:

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

valueOf

public static MessageEntity.Purpose 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

toString

public java.lang.String toString()

Returns a String of the type of message.

Overrides:

toString in class java.lang.Enum<MessageEntity.Purpose>

Returns:

the type of message.