com.amazonaws.mobile.config

Interface AWSConfigurable

public interface AWSConfigurable

The AWSConfigurable interface defines the methods in the lifecycle of any SDK Client object that uses AWSConfiguration.

Any SDK client that need to be configurable will implement this interface by overriding these methods. com.amazonaws.mobile.client.AWSMobileClient will use these methods to control the creation and initialization of a SDK client.

Method Summary

Modifier and Type	Method and Description
AWSConfigurable	initialize(android.content.Context context) Initialize the SDK Client.
AWSConfigurable	initialize(android.content.Context context, AWSConfiguration configuration) Initialize the SDK Client.
AWSConfigurable	initialize(android.content.Context context, AWSConfiguration configuration, ClientConfiguration clientConfiguration) Initialize the SDK Client.

Method Detail

initialize

AWSConfigurable initialize(android.content.Context context)
                    throws java.lang.Exception

Initialize the SDK Client. This method will construct the instance of the client and perform basic initialization. The AWSConfiguration will be constructed based on awsconfiguration.json file.

Parameters:

context - Reference to the application context.

Returns:

the client instance that conforms to AWSConfigurable

Throws:

java.lang.Exception

initialize

AWSConfigurable initialize(android.content.Context context,
                           AWSConfiguration configuration)
                    throws java.lang.Exception

Initialize the SDK Client. This method will construct the instance of the client and perform basic initialization.

Parameters:

context - Reference to the application context.

configuration - Instance of AWSConfiguration

Returns:

the client instance that conforms to AWSConfigurable

Throws:

java.lang.Exception

initialize

AWSConfigurable initialize(android.content.Context context,
                           AWSConfiguration configuration,
                           ClientConfiguration clientConfiguration)
                    throws java.lang.Exception

Initialize the SDK Client. This method will construct the instance of the client and perform basic initialization.

Parameters:

context - Reference to the application context.

configuration - Instance of AWSConfiguration

clientConfiguration - Instance of ClientConfiguration

Returns:

the client instance that conforms to AWSConfigurable

Throws:

java.lang.Exception