/AWS1/CL_CHIENDPOINTSTATE¶
A read-only field that represents the state of an AppInstanceUserEndpoint. Supported values:
-
ACTIVE: TheAppInstanceUserEndpointis active and able to receive messages. WhenACTIVE, theEndpointStatusReasonremains empty. -
INACTIVE: TheAppInstanceUserEndpointis inactive and can't receive message. When INACTIVE, the corresponding reason will be conveyed through EndpointStatusReason. -
INVALID_DEVICE_TOKENindicates that anAppInstanceUserEndpointisINACTIVEdue to invalid device token -
INVALID_PINPOINT_ARNindicates that anAppInstanceUserEndpointisINACTIVEdue to an invalid pinpoint ARN that was input through theResourceArnfield.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_status TYPE /AWS1/CHIENDPOINTSTATUS /AWS1/CHIENDPOINTSTATUS¶
Enum that indicates the Status of an
AppInstanceUserEndpoint.
Optional arguments:¶
iv_statusreason TYPE /AWS1/CHIENDPOINTSTATUSREASON /AWS1/CHIENDPOINTSTATUSREASON¶
The reason for the
EndpointStatus.
Queryable Attributes¶
Status¶
Enum that indicates the Status of an
AppInstanceUserEndpoint.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
StatusReason¶
The reason for the
EndpointStatus.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUSREASON() |
Getter for STATUSREASON, with configurable default |
ASK_STATUSREASON() |
Getter for STATUSREASON w/ exceptions if field has no value |
HAS_STATUSREASON() |
Determine if STATUSREASON has a value |