platform_vpa_api_common_vpa/com.tomtom.ivi.platform.vpa.api.common.vpa/VpaAvailabilityState

VpaAvailabilityState

enum VpaAvailabilityState : Enum<VpaAvailabilityState>

Describes whether a VPA is available to clients for use. When a VPA is available, clients can make API calls to it. This does not necessarily mean that the end-user can speak to the VPA yet.

Entries

INITIALIZING

The VPA is initializing itself. This could mean that it is busy loading language information or performing some other start-up process. The client should wait until the VPA is AVAILABLE before trying to use it.

AVAILABLE

The VPA is in a state where it can service API calls from the client.

NOT_AVAILABLE

The VPA is not in a state where it can service API calls from the client. Therefore, the end-user also cannot speak to it. It needs to be initialized before it can be used.

Inherited properties

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): VpaAvailabilityState

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.)

values

fun values(): Array<VpaAvailabilityState>

Returns an array containing the constants of this enum type, in the order they're declared.