chimesdkidentity/aws.sdk.kotlin.services.chimesdkidentity.model/EndpointState

EndpointState

class EndpointState

A read-only field that represents the state of an AppInstanceUserEndpoint. Supported values:

  • ACTIVE: The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE, the EndpointStatusReason remains empty.

  • INACTIVE: The AppInstanceUserEndpoint is inactive and can't receive message. When INACTIVE, the corresponding reason will be conveyed through EndpointStatusReason.

  • INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to invalid device token

  • INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an invalid pinpoint ARN that was input through the ResourceArn field.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val status: EndpointStatus

Enum that indicates the Status of an AppInstanceUserEndpoint.

Link copied to clipboard
val statusReason: EndpointStatusReason?

The reason for the EndpointStatus.

Functions

Link copied to clipboard
inline fun copy(block: EndpointState.Builder.() -> Unit = {}): EndpointState
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String