com.opentok

Enum ArchiveMode

java.lang.Object

java.lang.Enum<ArchiveMode>

com.opentok.ArchiveMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ArchiveMode>

public enum ArchiveMode
extends java.lang.Enum<ArchiveMode>

Defines values for the archiveMode parameter of the SessionProperties.Builder.archiveMode(ArchiveMode archiveMode) method.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS The session is archived automatically (as soon as there are clients connected to the session).
MANUAL The session is not archived automatically.

Method Summary

Modifier and Type	Method and Description
java.lang.String	toString()
static ArchiveMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ArchiveMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MANUAL

public static final ArchiveMode MANUAL

The session is not archived automatically. To archive the session, you can call the OpenTok.StartArchive() method.

ALWAYS

public static final ArchiveMode ALWAYS

The session is archived automatically (as soon as there are clients connected to the session).

Method Detail

values

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

Returns:

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

valueOf

public static ArchiveMode 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()

Overrides:

toString in class java.lang.Enum<ArchiveMode>