AWSMobileAnalytics Class Reference


                    
                    
                    eventClient

Returns the AWSMobileAnalyticsEventClient. @returns the AWSMobileAnalyticsEventClient to create, record, and submit events.

Declaration

Objective-C

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

Swift

var eventClient: AWSMobileAnalyticsEventClient! { get }


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

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

Declaration

Objective-C

+ (instancetype)defaultMobileAnalytics;

Swift

class func `default`() -> Self!


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

Declaration

Objective-C

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

Swift

convenience init!(forAppId appId: String!)

Parameters


                                appId

AppId from Amazon Mobile Analytics Management Console. @returns The AWSMobileAnalytics instance with the specified appId or nil if serviceConfiguration is invalid or appId is empty.


                    
                    
                    +mobileAnalyticsForAppId:identityPoolId:

Deprecated

please use mobileAnalyticsForAppId:(NSString *)appId configuration:(AWSMobileAnalyticsConfiguration *)configuration

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.

Declaration

Objective-C

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

Swift

convenience init!(forAppId appId: String!, identityPoolId: String!)

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. @returns The AWSMobileAnalytics instance with the specified appId or nil if serviceConfiguration is invalid or appId is empty.


                    
                    
                    +mobileAnalyticsForAppId:identityPoolId:completionBlock:

Deprecated

please use mobileAnalyticsForAppId:(NSString *)appId configuration:(AWSMobileAnalyticsConfiguration *)configuration completionBlock:(AWSInitializationCompletionBlock)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.

Declaration

Objective-C

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

Swift

convenience init!(forAppId appId: String!, identityPoolId: String!, completionBlock: AWSInitializationCompletionBlock!)

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. @returns The AWSMobileAnalytics instance with the specified appId or nil if serviceConfiguration is invalid or appId is empty.


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

Declaration

Objective-C

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

Swift

convenience init!(forAppId appId: String!, configuration: AWSMobileAnalyticsConfiguration!)

Parameters

`appId`	AppId from Amazon Mobile Analytics Management Console.
`configuration`	A configuraiton object. By default, it uses [AWSServiceManager defaultServiceManager].defaultServiceConfiguration to access the service. @returns The AWSMobileAnalytics instance with the specified appId or nil if serviceConfiguration is invalid or appId is empty.


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

Declaration

Objective-C

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

Swift

convenience init!(forAppId appId: String!, configuration: AWSMobileAnalyticsConfiguration!, completionBlock: AWSInitializationCompletionBlock!)

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. @returns The AWSMobileAnalytics instance with the specified appId or nil if serviceConfiguration is invalid or appId is empty.


                    
                    
                    +mobileAnalyticsForAppId:insightsPrivateKey:

Deprecated

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.

Declaration

Objective-C

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

Swift

convenience init!(forAppId appId: String!, insightsPrivateKey: String!)

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. @returns The AWSMobileAnalytics instance with the specified appId or nil if serviceConfiguration is invalid or appId is empty.


                    
                    
                    +mobileAnalyticsForAppId:insightsPrivateKey:configuration:completionBlock:

Deprecated

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.

Declaration

Objective-C

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

Swift

convenience init!(forAppId appId: String!, insightsPrivateKey: String!, configuration: AWSMobileAnalyticsConfiguration!, completionBlock: AWSInitializationCompletionBlock!)

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. @returns The AWSMobileAnalytics instance with the specified appId or nil if serviceConfiguration is invalid or appId is empty.