AWSPinpointEndpointProfile Class Reference

Inherits from NSObject
Declared in AWSPinpointEndpointProfile.h
AWSPinpointEndpointProfile.m

Overview

The Endpoint profile contains information about the device/user to be target for messaging.

  applicationId

The Pinpoint Application ID

@property (nonatomic, readwrite) NSString *applicationId

Return Value

applicationId

Declared In

AWSPinpointEndpointProfile.h

  endpointId

The Endpoint ID is the unique identifier of this device

@property (nonatomic, readonly) NSString *endpointId

Return Value

endpointId

Declared In

AWSPinpointEndpointProfile.h

  channelType

The Channel type defaults to APNS

@property (nonatomic, readonly) NSString *channelType

Return Value

channelType

Declared In

AWSPinpointEndpointProfile.h

  address

The address is the token returned from APNS to be used to send push notifications

@property (nonatomic, readwrite) NSString *address

Return Value

address

Declared In

AWSPinpointEndpointProfile.h

  optOut

A string representing the opt out option of the endpoint profile. It defaults to ALL or NONE depending on if the user has allowed remote push notifications.

@property (nonatomic, readwrite) NSString *optOut

Return Value

optOut

Declared In

AWSPinpointEndpointProfile.h

  effectiveDate

The effectiveDate of the profile Defaults to current time

@property (nonatomic, readonly) UTCTimeMillis effectiveDate

Return Value

effectiveDate

Declared In

AWSPinpointEndpointProfile.h

  location

The AWSPinpointEndpointProfileLocation facet of the endpoint profile

@property (nonatomic, readwrite) AWSPinpointEndpointProfileLocation *location

Return Value

location

Declared In

AWSPinpointEndpointProfile.h

  demographic

The AWSPinpointEndpointProfileDemographic facet of the endpoint profile

@property (nonatomic, readwrite) AWSPinpointEndpointProfileDemographic *demographic

Return Value

demographic

Declared In

AWSPinpointEndpointProfile.h

  user

The AWSPinpointEndpointProfileUser facet of the endpoint profile

@property (nonatomic, readwrite) AWSPinpointEndpointProfileUser *user

Return Value

user

Declared In

AWSPinpointEndpointProfile.h

– initWithApplicationId:endpointId:

An AWSPinpointEndpointProfile object with the specified applicationId and endpointId

- (instancetype)initWithApplicationId:(NSString *)applicationId endpointId:(NSString *)endpointId

Return Value

AWSPinpointEndpointProfile

Declared In

AWSPinpointEndpointProfile.h

– initWithContext:

An AWSPinpointEndpointProfile object with the specified context

- (instancetype)initWithContext:(AWSPinpointContext *)context

Return Value

AWSPinpointEndpointProfile

Declared In

AWSPinpointEndpointProfile.h

– addAttribute:forKey:

Adds an attribute to this AWSPinpointEndpointProfile with the specified key. Only 40 attributes/metrics are allowed to be added to an AWSPinpointEndpointProfile. If 40 attributes/metrics already exist on this AWSPinpointEndpointProfile, the call is ignored.

- (void)addAttribute:(NSArray *)theValue forKey:(NSString *)theKey

Parameters

theValue

The value of the attribute. The value will be truncated if it exceeds 200 characters.

theKey

The key of the attribute. The key will be truncated if it exceeds 50 characters.

Declared In

AWSPinpointEndpointProfile.h

– attributeForKey:

Returns the value of the attribute with the specified key.

- (NSArray *)attributeForKey:(NSString *)theKey

Parameters

theKey

The key of the attribute to return

Return Value

The attribute with the specified key, or null if attribute does not exist

Declared In

AWSPinpointEndpointProfile.h

– hasAttributeForKey:

Determines if this AWSPinpointEndpointProfile contains a specific attribute

- (BOOL)hasAttributeForKey:(NSString *)theKey

Parameters

theKey

The key of the attribute

Return Value

YES if this AWSPinpointEndpointProfile has an attribute with the specified key, NO otherwise

Declared In

AWSPinpointEndpointProfile.h

– allAttributes

Returns an Dictionary of all attributes contained within this AWSPinpointEndpointProfile

- (NSDictionary *)allAttributes

Return Value

an Dictionary of all attributes, where the attribute keys are the keys and the attribute values are the values

Declared In

AWSPinpointEndpointProfile.h

– addMetric:forKey:

Adds a metric to this AWSPinpointEndpointProfile with the specified key. Only 40 attributes/metrics are allowed to be added to an AWSPinpointEndpointProfile. If 40 attribute/metrics already exist on this AWSPinpointEndpointProfile, the call is ignored.

- (void)addMetric:(NSNumber *)theValue forKey:(NSString *)theKey

Parameters

theValue

The value of the metric.

theKey

The key of the metric. The key will be truncated if it exceeds 50 characters.

Declared In

AWSPinpointEndpointProfile.h

– metricForKey:

Returns the value of the metric with the specified key.

- (NSNumber *)metricForKey:(NSString *)theKey

Parameters

theKey

The key of the metric to return

Return Value

The metric with the specified key, or null if metric does not exist

Declared In

AWSPinpointEndpointProfile.h

– hasMetricForKey:

Determines if this AWSPinpointEndpointProfile contains a specific metric

- (BOOL)hasMetricForKey:(NSString *)theKey

Parameters

theKey

The key of the metric

Return Value

YES if this AWSPinpointEndpointProfile has a metric with the specified key, NO otherwise

Declared In

AWSPinpointEndpointProfile.h

– allMetrics

Returns an Dictionary of all metrics contained within this AWSPinpointEndpointProfile

- (NSDictionary *)allMetrics

Return Value

an Dictionary of all metrics, where the metric keys are the keys and the metric values are the values

Declared In

AWSPinpointEndpointProfile.h

– toDictionary

Returns an Dictionary representation of this object.

- (NSDictionary *)toDictionary

Return Value

an Dictionary representation of this AWSPinpointEndpointProfile object.

Declared In

AWSPinpointEndpointProfile.h