MessageBox (Cyclos 4.16.19 Scripting API Documentation)

java.lang.Object
- java.lang.Enum<MessageBox>
- - org.cyclos.model.messaging.messages.MessageBox

All Implemented Interfaces:: Serializable, Comparable<MessageBox>, HasMessageKey

public enum MessageBox
extends Enum<MessageBox>
implements HasMessageKey

Enum Constant Summary

Enum Constants
Enum Constant Description

INBOX

SENT_ITEMS

TRASH

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`MessageKey`	`getMessageKey()`
`static MessageBox`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static MessageBox[]`	`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
  - INBOX
```
public static final MessageBox INBOX
```
  - SENT_ITEMS
```
public static final MessageBox SENT_ITEMS
```
  - TRASH
```
public static final MessageBox TRASH
```
- Method Detail
  - values
```
public static MessageBox[] 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 (MessageBox c : MessageBox.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static MessageBox 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
  - getMessageKey
```
public MessageKey getMessageKey()
```
    Specified by:
    
    getMessageKey in interface HasMessageKey