AWSPinpointTargetingEndpointResponse Class Reference

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

Overview

Provides information about 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 example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.

@property (nonatomic, strong) NSString *address

Declared In

AWSPinpointTargetingModel.h

  applicationId

The unique identifier for the application that's associated with the endpoint.

@property (nonatomic, strong) NSString *applicationId

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.

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

Declared In

AWSPinpointTargetingModel.h

  channelType

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

@property (nonatomic, assign) AWSPinpointTargetingChannelType channelType

Declared In

AWSPinpointTargetingModel.h

  cohortId

A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.

@property (nonatomic, strong) NSString *cohortId

Declared In

AWSPinpointTargetingModel.h

  creationDate

The date and time, in ISO 8601 format, when the endpoint was created.

@property (nonatomic, strong) NSString *creationDate

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 was last updated.

@property (nonatomic, strong) NSString *effectiveDate

Declared In

AWSPinpointTargetingModel.h

  endpointStatus

Not used.

@property (nonatomic, strong) NSString *endpointStatus

Declared In

AWSPinpointTargetingModel.h

  identifier

The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.

@property (nonatomic, strong) NSString *identifier

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 your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

@property (nonatomic, strong) AWSPinpointTargetingEndpointUser *user

Declared In

AWSPinpointTargetingModel.h