AWSPinpointTargetingPublicEndpoint

Objective-C

@interface AWSPinpointTargetingPublicEndpoint

Swift

class AWSPinpointTargetingPublicEndpoint

Specifies the properties and attributes of an endpoint that’s associated with an event.

  • The unique identifier for the recipient, such as a device token, email address, or mobile phone number.

    Declaration

    Objective-C

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

    Swift

    var address: String? { get set }

  • One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, NSArray<NSString *> *> *_Nullable attributes;

    Swift

    var attributes: [String : [String]]? { get set }

  • The channel that’s used when sending messages or push notifications to the endpoint.

    Declaration

    Objective-C

    @property (nonatomic) AWSPinpointTargetingChannelType channelType;

    Swift

    var channelType: AWSPinpointTargetingChannelType { get set }

  • The demographic information for the endpoint, such as the time zone and platform.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSPinpointTargetingEndpointDemographic *_Nullable demographic;

    Swift

    var demographic: AWSPinpointTargetingEndpointDemographic? { get set }

  • The date and time, in ISO 8601 format, when the endpoint was last updated.

    Declaration

    Objective-C

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

    Swift

    var effectiveDate: String? { get set }

  • Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

    Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

    Declaration

    Objective-C

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

    Swift

    var endpointStatus: String? { get set }

  • The geographic information for the endpoint.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSPinpointTargetingEndpointLocation *_Nullable location;

    Swift

    var location: AWSPinpointTargetingEndpointLocation? { get set }

  • One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, NSNumber *> *_Nullable metrics;

    Swift

    var metrics: [String : NSNumber]? { get set }

  • Specifies whether the user who’s associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn’t want to receive any messages or push notifications; and, NONE, the user hasn’t opted out and wants to receive all messages and push notifications.

    Declaration

    Objective-C

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

    Swift

    var optOut: String? { get set }

  • A unique identifier that’s generated each time the endpoint is updated.

    Declaration

    Objective-C

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

    Swift

    var requestId: String? { get set }

  • One or more custom user attributes that your app reports to Amazon Pinpoint for the user who’s associated with the endpoint.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSPinpointTargetingEndpointUser *_Nullable user;

    Swift

    var user: AWSPinpointTargetingEndpointUser? { get set }