AWSPinpointTargetingEndpointRequest Class Reference

Inherits from AWSModel : AWSMTLModel
Declared in AWSPinpointTargetingModel.h
AWSPinpointTargetingModel.m

Overview

Specifies the channel type and other settings for an endpoint.

  address

The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.

@property (nonatomic, strong) NSString *address

Declared In

AWSPinpointTargetingModel.h

  attributes

One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments.

When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values.

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

Declared In

AWSPinpointTargetingModel.h

  channelType

The channel to use when sending messages or push notifications to the endpoint.

@property (nonatomic, assign) AWSPinpointTargetingChannelType channelType

Declared In

AWSPinpointTargetingModel.h

  demographic

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

@property (nonatomic, strong) AWSPinpointTargetingEndpointDemographic *demographic

Declared In

AWSPinpointTargetingModel.h

  effectiveDate

The date and time, in ISO 8601 format, when the endpoint is updated.

@property (nonatomic, strong) NSString *effectiveDate

Declared In

AWSPinpointTargetingModel.h

  endpointStatus

Not used.

@property (nonatomic, strong) NSString *endpointStatus

Declared In

AWSPinpointTargetingModel.h

  location

The geographic information for the endpoint.

@property (nonatomic, strong) AWSPinpointTargetingEndpointLocation *location

Declared In

AWSPinpointTargetingModel.h

  metrics

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

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

Declared In

AWSPinpointTargetingModel.h

  optOut

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.

@property (nonatomic, strong) NSString *optOut

Declared In

AWSPinpointTargetingModel.h

  requestId

The unique identifier for the most recent request to update the endpoint.

@property (nonatomic, strong) NSString *requestId

Declared In

AWSPinpointTargetingModel.h

  user

One or more custom user attributes that describe the user who's associated with the endpoint.

@property (nonatomic, strong) AWSPinpointTargetingEndpointUser *user

Declared In

AWSPinpointTargetingModel.h