AWSMobileAnalyticsERS Class Reference


                    
                    
                    configuration

The service configuration used to instantiate this service client.

Warning

Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors.

Declaration

Objective-C

@property (nonatomic, strong, readonly) AWSServiceConfiguration *_Nonnull configuration;

Swift

var configuration: UnsafeMutablePointer<Int32> { get }


                    
                    
                    +defaultMobileAnalyticsERS

Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with defaultServiceConfiguration from [AWSServiceManager defaultServiceManager]. The reference to this object is maintained by the SDK, and you do not need to retain it manually.

For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

Swift

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
   let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
   let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider)
   AWSServiceManager.default().defaultServiceConfiguration = configuration

   return true

}

Objective-C

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
     AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                     identityPoolId:@"YourIdentityPoolId"];
     AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1
                                                                          credentialsProvider:credentialsProvider];
     [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration;

     return YES;
 }

Then call the following to get the default service client:

Swift

let MobileAnalyticsERS = AWSMobileAnalyticsERS.default()

Objective-C

AWSMobileAnalyticsERS *MobileAnalyticsERS = [AWSMobileAnalyticsERS defaultMobileAnalyticsERS];

Declaration

Objective-C

+ (nonnull instancetype)defaultMobileAnalyticsERS;

Swift

class func `default`() -> Self

Return Value

The default service client.


                    
                    
                    +registerMobileAnalyticsERSWithConfiguration:forKey:

Creates a service client with the given service configuration and registers it for the key.

For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

Swift

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
   let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
   let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
   AWSMobileAnalyticsERS.register(with: configuration!, forKey: "USWest2MobileAnalyticsERS")

   return true

}

Objective-C

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                    identityPoolId:@"YourIdentityPoolId"];
    AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                         credentialsProvider:credentialsProvider];

    [AWSMobileAnalyticsERS registerMobileAnalyticsERSWithConfiguration:configuration forKey:@"USWest2MobileAnalyticsERS"];

    return YES;
}

Then call the following to get the service client:

Swift

let MobileAnalyticsERS = AWSMobileAnalyticsERS(forKey: "USWest2MobileAnalyticsERS")

Objective-C

AWSMobileAnalyticsERS *MobileAnalyticsERS = [AWSMobileAnalyticsERS MobileAnalyticsERSForKey:@"USWest2MobileAnalyticsERS"];

Warning

After calling this method, do not modify the configuration object. It may cause unspecified behaviors.

Declaration

Objective-C

+ (void)registerMobileAnalyticsERSWithConfiguration:
            (nonnull AWSServiceConfiguration *)configuration
                                             forKey:(nonnull NSString *)key;

Swift

class func register(withConfiguration configuration: Any!, forKey key: String)

Parameters

`configuration`	A service configuration object.
`key`	A string to identify the service client.


                    
                    
                    +MobileAnalyticsERSForKey:

Retrieves the service client associated with the key. You need to call + registerMobileAnalyticsERSWithConfiguration:forKey: before invoking this method.

For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

Swift

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
   let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
   let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
   AWSMobileAnalyticsERS.register(with: configuration!, forKey: "USWest2MobileAnalyticsERS")

   return true

}

Objective-C

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                    identityPoolId:@"YourIdentityPoolId"];
    AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                         credentialsProvider:credentialsProvider];

    [AWSMobileAnalyticsERS registerMobileAnalyticsERSWithConfiguration:configuration forKey:@"USWest2MobileAnalyticsERS"];

    return YES;
}

Then call the following to get the service client:

Swift

let MobileAnalyticsERS = AWSMobileAnalyticsERS(forKey: "USWest2MobileAnalyticsERS")

Objective-C

AWSMobileAnalyticsERS *MobileAnalyticsERS = [AWSMobileAnalyticsERS MobileAnalyticsERSForKey:@"USWest2MobileAnalyticsERS"];

Declaration

Objective-C

+ (nonnull instancetype)MobileAnalyticsERSForKey:(nonnull NSString *)key;

Swift

convenience init(forKey key: String)

Parameters

key

A string to identify the service client.

Return Value

An instance of the service client.


                    
                    
                    +removeMobileAnalyticsERSForKey:

Removes the service client associated with the key and release it.

Warning

Before calling this method, make sure no method is running on this client.

Declaration

Objective-C

+ (void)removeMobileAnalyticsERSForKey:(nonnull NSString *)key;

Swift

class func remove(forKey key: String)

Parameters

key

A string to identify the service client.


                    
                    
                    -putEvents:

Record a batch of events

See

AWSMobileAnalyticsERSPutEventsInput

Declaration

Objective-C

- (id)putEvents:(nonnull AWSMobileAnalyticsERSPutEventsInput *)request;

Swift

func putEvents(_ request: AWSMobileAnalyticsERSPutEventsInput) -> Any!

Parameters


                                request

A container for the necessary parameters to execute the PutEvents service method.

Return Value

An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSMobileAnalyticsERSErrorDomain domain and the following error code: AWSMobileAnalyticsERSErrorBadRequest.


                    
                    
                    -putEvents:completionHandler:

Record a batch of events

See

AWSMobileAnalyticsERSPutEventsInput

Declaration

Objective-C

- (void)putEvents:(nonnull AWSMobileAnalyticsERSPutEventsInput *)request
    completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

Swift

func putEvents(_ request: AWSMobileAnalyticsERSPutEventsInput, completionHandler: ((Error?) -> Void)? = nil)

Parameters

`request`	A container for the necessary parameters to execute the PutEvents service method.
`completionHandler`	The completion handler to call when the load request is complete. `error` - An error object that indicates why the request failed, or `nil` if the request was successful. On failed execution, `error` may contain an `NSError` with `AWSMobileAnalyticsERSErrorDomain` domain and the following error code: `AWSMobileAnalyticsERSErrorBadRequest`.