AWSMobileAnalytics Class Reference

Inherits from NSObject
Declared in AWSMobileAnalyticsService.h
AWSMobileAnalyticsService.m

Overview

Amazon Mobile Analytics client.

  eventClient

Returns the AWSMobileAnalyticsEventClient.

@property (nonatomic, strong, readonly) id<AWSMobileAnalyticsEventClient> eventClient

Return Value

the AWSMobileAnalyticsEventClient to create, record, and submit events.

Declared In

AWSMobileAnalyticsService.h

+ defaultMobileAnalytics

Creates an AWSMobileAnalytics instance with the specified appId in the Info.plist if the instance does not already exists for the appId. If an instance exists for the given appId, returns the existing instance. The strong reference to the instance is maintained by AWSMobileAnalytics, and the developer does not need to retain it manually.

+ (instancetype)defaultMobileAnalytics

Return Value

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

Declared In

AWSMobileAnalyticsService.h

+ mobileAnalyticsForAppId:

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

+ (instancetype)mobileAnalyticsForAppId:(NSString *)appId

Parameters

appId

AppId from Amazon Mobile Analytics Management Console.

Return Value

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

Declared In

AWSMobileAnalyticsService.h

+ mobileAnalyticsForAppId:identityPoolId:

Creates an AWSMobileAnalytics instance with the specified appId if the instance does not already exists for the appId. If an instance exists for the given appId, returns the existing instance. identityPoolId is ignored if an instance exists for the given appId. The strong reference to the instance is maintained by AWSMobileAnalytics, and the developer does not need to retain it manually. This method defaults to initialize both mobile analytics and cognito in the AWSUSEast1 region.

+ (instancetype)mobileAnalyticsForAppId:(NSString *)appId identityPoolId:(NSString *)identityPoolId

Parameters

appId

AppId from Amazon Mobile Analytics Management Console.

identityPoolId

The identity pool id for this provider. Value is used to communicate with Amazon Cognito as well as namespace values stored in the keychain.

Return Value

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

Declared In

AWSMobileAnalyticsService.h

+ mobileAnalyticsForAppId:identityPoolId:completionBlock:

Creates an AWSMobileAnalytics instance with the specified appId if the instance does not already exists for the appId. If an instance exists for the given appId, returns the existing instance. identityPoolId and completionBlock are ignored if an instance exists for the given appId. The strong reference to the instance is maintained by AWSMobileAnalytics, and the developer does not need to retain it manually. This method defaults to initialize both mobile analytics and cognito in the AWSUSEast1 region.

+ (instancetype)mobileAnalyticsForAppId:(NSString *)appId identityPoolId:(NSString *)identityPoolId completionBlock:(AWSInitializationCompletionBlock)completionBlock

Parameters

appId

AppId from Amazon Mobile Analytics Management Console.

identityPoolId

The identity pool id for this provider. Value is used to communicate with Amazon Cognito as well as namespace values stored in the keychain.

completionBlock

A AWSInitializationCompletionBlock that allows developers to handle custom logic after initialization but before the session begins.

Return Value

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

Declared In

AWSMobileAnalyticsService.h

+ mobileAnalyticsForAppId:configuration:

Creates an AWSMobileAnalytics instance with the specified appId using provided configuration if the instance does not already exists for the 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 AWSMobileAnalytics, and the developer does not need to retain it manually.

+ (instancetype)mobileAnalyticsForAppId:(NSString *)appId configuration:(AWSMobileAnalyticsConfiguration *)configuration

Parameters

appId

AppId from Amazon Mobile Analytics Management Console.

configuration

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

Return Value

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

Declared In

AWSMobileAnalyticsService.h

+ mobileAnalyticsForAppId:configuration:completionBlock:

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

+ (instancetype)mobileAnalyticsForAppId:(NSString *)appId configuration:(AWSMobileAnalyticsConfiguration *)configuration completionBlock:(AWSInitializationCompletionBlock)completionBlock

Parameters

appId

AppId from Amazon Mobile Analytics Management Console.

configuration

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

completionBlock

A AWSInitializationCompletionBlock that allows developers to handle custom logic after initialization but before the session begins.

Return Value

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

Declared In

AWSMobileAnalyticsService.h

+ mobileAnalyticsForAppId:insightsPrivateKey:

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

+ (instancetype)mobileAnalyticsForAppId:(NSString *)appId insightsPrivateKey:(NSString *)insightsPrivateKey

Parameters

appId

AppId from Amazon Mobile Analytics Management Console.

insightsPrivateKey

Private Key from the Amazon Insights SDK. Pass Private Key to migrate from the Insights SDK.

Return Value

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

Declared In

AWSMobileAnalyticsService.h

+ mobileAnalyticsForAppId:insightsPrivateKey:configuration:completionBlock:

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

+ (instancetype)mobileAnalyticsForAppId:(NSString *)appId insightsPrivateKey:(NSString *)insightsPrivateKey configuration:(AWSMobileAnalyticsConfiguration *)configuration completionBlock:(AWSInitializationCompletionBlock)completionBlock

Parameters

appId

AppId from Amazon Mobile Analytics Management Console.

insightsPrivateKey

Private Key from the Amazon Insights SDK. Pass Private Key to migrate from the Insights SDK.

configuration

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

completionBlock

A AWSInitializationCompletionBlock that allows developers to handle custom logic after initialization but before the session begins.

Return Value

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

Declared In

AWSMobileAnalyticsService.h