AWSPinpoint Class Reference

Inherits from NSObject
Declared in AWSPinpointService.h
AWSPinpointService.m

Overview

Amazon Pinpoint

  targetingClient

Returns the AWSPinpointTargetingClient. The TargetingClient is the high level client to be used for updating the endpoint profile.

@property (nonatomic, readonly) AWSPinpointTargetingClient *targetingClient

Return Value

the AWSPinpointTargetingClient to update endpoint profile information.

Declared In

AWSPinpointService.h

  analyticsClient

Returns the AWSPinpointAnalyticsClient. The AnalyticsClient is the high level client to be used for recording and sending events.

@property (nonatomic, readonly) AWSPinpointAnalyticsClient *analyticsClient

Return Value

the AWSPinpointAnalyticsClient to create, record, and submit events.

Declared In

AWSPinpointService.h

  notificationManager

Returns the AWSPinpointNotificationManager. It contains callback interceptors that need to be called for campaign analytics to work.

@property (nonatomic, readonly) AWSPinpointNotificationManager *notificationManager

Return Value

the AWSPinpointNotificationManager used for targeting campaign analytics.

Declared In

AWSPinpointService.h

  sessionClient

Returns the AWSPinpointSessionClient. The session client should be used only if enableAutoSessionRecording is false.

@property (nonatomic, readonly) AWSPinpointSessionClient *sessionClient

Return Value

the AWSPinpointSessionClient used for recording session events.

Declared In

AWSPinpointService.h

  configuration

Returns the AWSPinpointConfiguration. The configuration passed in to initialize the SDK.

@property (nonatomic, readonly) AWSPinpointConfiguration *configuration

Return Value

the AWSPinpointConfiguration.

Declared In

AWSPinpointService.h

+ pinpointWithConfiguration:

Creates an AWSPinpoint instance with the specified configuration if the instance does not already exists for the configurations' appId. If an instance exists for the given appId, returns the existing instance. configuration are ignored if an instance exists for the given appId. The strong reference to the instance is maintained by AWSPinpoint, and the developer does not need to retain it manually.

+ (nonnull instancetype)pinpointWithConfiguration:(AWSPinpointConfiguration *)configuration

Parameters

configuration

A configuration object. By default, it uses [AWSServiceManager defaultServiceManager].defaultServiceConfiguration to access the service.

Return Value

The AWSPinpoint instance with the specified appId or nil if serviceConfiguration is invalid or appId is empty.

Discussion

This initializer should be called inside your AppDelegates' application:didFinishLaunchingWithOptions: method.

Declared In

AWSPinpointService.h