AWSChimeSDKIdentityAppInstanceUserEndpoint

Objective-C

@interface AWSChimeSDKIdentityAppInstanceUserEndpoint

Swift

class AWSChimeSDKIdentityAppInstanceUserEndpoint

An endpoint under an Amazon Chime AppInstanceUser that receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.

  • Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.

    Declaration

    Objective-C

    @property (nonatomic) AWSChimeSDKIdentityAllowMessages allowMessages;

    Swift

    var allowMessages: AWSChimeSDKIdentityAllowMessages { get set }

  • The ARN of the AppInstanceUser.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable appInstanceUserArn;

    Swift

    var appInstanceUserArn: String? { get set }

  • The time at which an AppInstanceUserEndpoint was created.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable createdTimestamp;

    Swift

    var createdTimestamp: Date? { get set }

  • The attributes of an Endpoint.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSChimeSDKIdentityEndpointAttributes *_Nullable endpointAttributes;

    Swift

    var endpointAttributes: AWSChimeSDKIdentityEndpointAttributes? { get set }

  • The unique identifier of the AppInstanceUserEndpoint.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable endpointId;

    Swift

    var endpointId: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSChimeSDKIdentityEndpointState *_Nullable endpointState;

    Swift

    var endpointState: AWSChimeSDKIdentityEndpointState? { get set }

  • The time at which an AppInstanceUserEndpoint was last updated.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable lastUpdatedTimestamp;

    Swift

    var lastUpdatedTimestamp: Date? { get set }

  • The name of the AppInstanceUserEndpoint.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable name;

    Swift

    var name: String? { get set }

  • The ARN of the resource to which the endpoint belongs.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable resourceArn;

    Swift

    var resourceArn: String? { get set }

  • The type of the AppInstanceUserEndpoint.

    Declaration

    Objective-C

    @property (nonatomic) AWSChimeSDKIdentityAppInstanceUserEndpointType types;

    Swift

    var types: AWSChimeSDKIdentityAppInstanceUserEndpointType { get set }