AWSPinpoint Class Reference


                    
                    
                    targetingClient

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

@returns the AWSPinpointTargetingClient to update endpoint profile information.

Declaration

Objective-C

@property (nonatomic, readonly) AWSPinpointTargetingClient *_Nonnull targetingClient;

Swift

var targetingClient: AWSPinpointTargetingClient { get }


                    
                    
                    analyticsClient

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

@returns the AWSPinpointAnalyticsClient to create, record, and submit events.

Declaration

Objective-C

@property (nonatomic, readonly) AWSPinpointAnalyticsClient *_Nonnull analyticsClient;

Swift

var analyticsClient: AWSPinpointAnalyticsClient { get }


                    
                    
                    notificationManager

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

@returns the AWSPinpointNotificationManager used for targeting campaign analytics.

Declaration

Objective-C

@property (nonatomic, readonly) AWSPinpointNotificationManager *_Nonnull notificationManager;

Swift

var notificationManager: AWSPinpointNotificationManager { get }


                    
                    
                    sessionClient

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

@returns the AWSPinpointSessionClient used for recording session events.

Declaration

Objective-C

@property (nonatomic, readonly) AWSPinpointSessionClient *_Nonnull sessionClient;

Swift

var sessionClient: AWSPinpointSessionClient { get }


                    
                    
                    configuration

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

@returns the AWSPinpointConfiguration.

Declaration

Objective-C

@property (nonatomic, readonly) AWSPinpointConfiguration *_Nonnull configuration;

Swift

var configuration: AWSPinpointConfiguration { get }


                    
                    
                    +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.

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

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

Declaration

Objective-C

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

Swift

convenience init(configuration: AWSPinpointConfiguration)

Parameters


                                configuration

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