com.mixer.interactive.resources.control

Enum InteractiveCanvasSize

java.lang.Object

java.lang.Enum<InteractiveCanvasSize>

com.mixer.interactive.resources.control.InteractiveCanvasSize

All Implemented Interfaces:

Serializable, Comparable<InteractiveCanvasSize>

public enum InteractiveCanvasSize
extends Enum<InteractiveCanvasSize>

Enum containing all the available control canvas sizes offered by the Interactive service.

Since:

1.0.0

Author:

Microsoft Corporation

See Also:

InteractiveControlPosition

Enum Constant Summary

Enum Constants

Enum Constant and Description
LARGE
MEDIUM
SMALL

Method Summary

Modifier and Type	Method and Description
static InteractiveCanvasSize	from(String layoutSize) Returns the associated InteractiveCanvasSize object for the provided canvas size (if there is one).
String	toString() Returns a String representation of this InteractiveCanvasSize.
static InteractiveCanvasSize	valueOf(String name) Returns the enum constant of this type with the specified name.
static InteractiveCanvasSize[]	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

SMALL

public static final InteractiveCanvasSize SMALL

MEDIUM

public static final InteractiveCanvasSize MEDIUM

LARGE

public static final InteractiveCanvasSize LARGE

Method Detail

values

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

Returns:

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

valueOf

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

from

public static InteractiveCanvasSize from(String layoutSize)

Returns the associated InteractiveCanvasSize object for the provided canvas size (if there is one).

Parameters:

layoutSize - Interactive controls canvas size

Returns:

The matching InteractiveCanvasSize for the provided canvas size. If a match is not found then null is returned.

Since:

1.0.0

toString

public String toString()

Returns a String representation of this InteractiveCanvasSize.

Overrides:

toString in class Enum<InteractiveCanvasSize>

Returns:

String representation of this InteractiveCanvasSize

Since:

1.0.0