host.anzo.eossdk.eos.sdk.common.enums

Enum EOS_EApplicationStatus

java.lang.Object

java.lang.Enum<EOS_EApplicationStatus>

host.anzo.eossdk.eos.sdk.common.enums.EOS_EApplicationStatus

All Implemented Interfaces:

com.sun.jna.NativeMapped, java.io.Serializable, java.lang.Comparable<EOS_EApplicationStatus>

public enum EOS_EApplicationStatus
extends java.lang.Enum<EOS_EApplicationStatus>
implements com.sun.jna.NativeMapped

All possible states of the application

Since:

8/5/2023

Enum Constant Summary

Enum Constants

Enum Constant and Description
EOS_AS_BackgroundConstrained Xbox only.
EOS_AS_BackgroundSuspended Notifies the SDK that the application has been put into suspended state by the platform system.
EOS_AS_BackgroundUnconstrained Xbox only.
EOS_AS_Foreground Notifies the SDK that the application has been resumed from suspended state.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	fromNative(java.lang.Object nativeValue, com.sun.jna.FromNativeContext context)
java.lang.Class<?>	nativeType()
java.lang.Object	toNative()
java.lang.String	toString() Gets the string representation of an EOS_EApplicationStatus value.
static EOS_EApplicationStatus	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EOS_EApplicationStatus[]	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

EOS_AS_BackgroundConstrained

public static final EOS_EApplicationStatus EOS_AS_BackgroundConstrained

Xbox only.

Notifies the SDK that the application has entered constrained mode. While in constrained mode, the application has reduced access to reserved system resources.

EOS_AS_BackgroundUnconstrained

public static final EOS_EApplicationStatus EOS_AS_BackgroundUnconstrained

Xbox only.

Notifies the SDK that the application has returned from constrained mode, and is back to running in a regular state with full access to system resources.

The SDK will handle this state change and automatically transition its active state to EOS_AS_Foreground. As result, after the application has set the EOS_AS_BackgroundUnconstrained state, calling EOS_Platform_GetApplicationStatus will return EOS_AS_Foreground as the persisted active state.

EOS_AS_BackgroundSuspended

public static final EOS_EApplicationStatus EOS_AS_BackgroundSuspended

Notifies the SDK that the application has been put into suspended state by the platform system.

EOS_AS_Foreground

public static final EOS_EApplicationStatus EOS_AS_Foreground

Notifies the SDK that the application has been resumed from suspended state.

This is the default active state on all platforms.

Method Detail

values

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

Returns:

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

valueOf

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

fromNative

public java.lang.Object fromNative(java.lang.Object nativeValue,
                                   com.sun.jna.FromNativeContext context)

Specified by:

fromNative in interface com.sun.jna.NativeMapped

toNative

public java.lang.Object toNative()

Specified by:

toNative in interface com.sun.jna.NativeMapped

nativeType

public java.lang.Class<?> nativeType()

Specified by:

nativeType in interface com.sun.jna.NativeMapped

toString

public java.lang.String toString()

Gets the string representation of an EOS_EApplicationStatus value.

Example: EOS_EApplicationStatus_ToString(EOS_EApplicationStatus::EOS_AS_Foreground) returns "EOS_AS_Foreground".

Overrides:

toString in class java.lang.Enum<EOS_EApplicationStatus>

Returns:

Pointer to a static string representing the input enum value. The returned string is guaranteed to be non-null, and must not be freed by the application.