com.unity3d.ads

Enum UnityAds.PlacementState

java.lang.Object

java.lang.Enum<UnityAds.PlacementState>

com.unity3d.ads.UnityAds.PlacementState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<UnityAds.PlacementState>

Enclosing class:

UnityAds

public static enum UnityAds.PlacementState
extends java.lang.Enum<UnityAds.PlacementState>

Describes state of Unity Ads placements. All placement states other than READY imply that placement is not currently ready to show ads.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISABLED Placement is disabled.
NO_FILL Placement is properly configured but there are currently no ads available for the placement.
NOT_AVAILABLE Current placement state is not available.
READY Placement is ready to show ads.
WAITING Placement is not yet ready but it will be ready in the future.

Method Summary

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

READY

public static final UnityAds.PlacementState READY

Placement is ready to show ads. You can call show method and ad unit will open.

NOT_AVAILABLE

public static final UnityAds.PlacementState NOT_AVAILABLE

Current placement state is not available. SDK is not initialized or this placement has not been configured in Unity Ads admin tools.

DISABLED

public static final UnityAds.PlacementState DISABLED

Placement is disabled. Placement can be enabled via Unity Ads admin tools.

WAITING

public static final UnityAds.PlacementState WAITING

Placement is not yet ready but it will be ready in the future. Most likely reason is caching.

NO_FILL

public static final UnityAds.PlacementState NO_FILL

Placement is properly configured but there are currently no ads available for the placement.

Method Detail

values

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

Returns:

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

valueOf

public static UnityAds.PlacementState 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