com.amazonaws.mobileconnectors.pinpoint

Class PinpointConfiguration

java.lang.Object

com.amazonaws.mobileconnectors.pinpoint.PinpointConfiguration

public class PinpointConfiguration
extends Object

The PinpointConfiguration class allows developers to configure the Pinpoint SDK.

Constructor Summary

Constructors

Constructor and Description
PinpointConfiguration(android.content.Context context, AWSCredentialsProvider credentialsProvider, AWSConfiguration awsConfiguration) Create an PinpointConfiguration object with the specified parameters.
PinpointConfiguration(android.content.Context context, String appId, Regions region, AWSCredentialsProvider credentialsProvider) Deprecated.
PinpointConfiguration(android.content.Context context, String appId, Regions region, ChannelType channelType, AWSCredentialsProvider credentialsProvider) Create an PinpointConfiguration object with the specified parameters.

Method Summary

Modifier and Type	Method and Description
android.content.Context	getAppContext() The Android Context.
String	getAppId() The Pinpoint AppId
AppLevelOptOutProvider	getAppLevelOptOutProvider() The provider to call to check app-level opt out
ChannelType	getChannelType() The channel type supported by this configuration.
ClientConfiguration	getClientConfiguration() Gets the client configuration this client will use when making requests.
AWSCredentialsProvider	getCredentialsProvider() The credentials provider used in order to authenticate.
boolean	getEnableEvents() Indicates whether or not event collection is enabled for the SDK.
boolean	getEnableTargeting() Indicates whether or not endpoint registration for Pinpoint is enabled for the SDK.
ExecutorService	getExecutor() The custom executor used for handlers in the TargetingClient.
PinpointCallback<PinpointManager>	getInitCompletionCallback() The callback to be called after initialization is complete
Regions	getRegion() The AWS Region configured
boolean	getShouldPostNotificationsInForeground()
PinpointConfiguration	withAllowsEventCollection(boolean allowEventCollection) Sets whether or not event collection is enabled for the SDK.
PinpointConfiguration	withAppContext(android.content.Context context) The Android Context.
PinpointConfiguration	withAppId(String appId) The Pinpoint AppId
PinpointConfiguration	withAppLevelOptOutProvider(AppLevelOptOutProvider appLevelOptOutProvider) The provider to call to check app-level opt out
PinpointConfiguration	withChannelType(ChannelType channelType) The channel type configured.
PinpointConfiguration	withClientConfiguration(ClientConfiguration clientConfig) Sets the client configuration this client will use when making request
PinpointConfiguration	withCredentialsProvider(AWSCredentialsProvider credentialsProvider) Please provide a CognitoCredentialsProvider in order to authenticate.
PinpointConfiguration	withEnablePinpoint(boolean enablePinpoint) Enables pinpoint and endpoint registration.
PinpointConfiguration	withExecutor(ExecutorService executorService) Custom executor to use for handlers in the TargetingClient.
PinpointConfiguration	withInitCompletionCallback(PinpointCallback<PinpointManager> initCompletionCallback) The callback to be called after initialization is complete
PinpointConfiguration	withPostNotificationsInForeground(boolean shouldPostNotificationsInForeground) Configuration option to post notifications even if the app is in the foreground.
PinpointConfiguration	withRegion(Regions region) The AWS Region for Pinpoint

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PinpointConfiguration

public PinpointConfiguration(android.content.Context context,
                             String appId,
                             Regions region,
                             ChannelType channelType,
                             AWSCredentialsProvider credentialsProvider)

Create an PinpointConfiguration object with the specified parameters.

Parameters:

context - the android context object.

appId - the Pinpoint Application Id.

region - the AWS Regions for the Pinpoint service.

channelType - the Pinpoint Channel type.

credentialsProvider - The AWSCredentialsProvider to be used for the service.

PinpointConfiguration

@Deprecated
public PinpointConfiguration(android.content.Context context,
                                         String appId,
                                         Regions region,
                                         AWSCredentialsProvider credentialsProvider)

Deprecated.

Create an PinpointConfiguration object with the specified parameters.

Parameters:

context - the android context object.

appId - the Pinpoint Application Id.

region - the AWS Regions for the Pinpoint service.

credentialsProvider - The AWSCredentialsProvider to be used for the service.

PinpointConfiguration

public PinpointConfiguration(android.content.Context context,
                             AWSCredentialsProvider credentialsProvider,
                             AWSConfiguration awsConfiguration)

Create an PinpointConfiguration object with the specified parameters.

Parameters:

context - the android context object.

credentialsProvider - The AWSCredentialsProvider to be used for the service.

awsConfiguration - the aws configuration.

Method Detail

withClientConfiguration

public PinpointConfiguration withClientConfiguration(ClientConfiguration clientConfig)

Sets the client configuration this client will use when making request

Parameters:

clientConfig - The ClientConfiguration of the service.

Returns:

the current PinpointConfiguration instance

getClientConfiguration

public ClientConfiguration getClientConfiguration()

Gets the client configuration this client will use when making requests. If none was supplied to the constructor this will return the default client configuration.

Returns:

The ClientConfiguration used for making requests.

withAllowsEventCollection

public PinpointConfiguration withAllowsEventCollection(boolean allowEventCollection)

Sets whether or not event collection is enabled for the SDK.

Parameters:

allowEventCollection - true if event collection should be allowed, otherwise false.

Returns:

the current PinpointConfiguration instance

getEnableEvents

public boolean getEnableEvents()

Indicates whether or not event collection is enabled for the SDK.

Returns:

true/false indicating if event collection is enabled

getEnableTargeting

public boolean getEnableTargeting()

Indicates whether or not endpoint registration for Pinpoint is enabled for the SDK.

Returns:

true/false indicating if Pinpoint is enabled

withEnablePinpoint

public PinpointConfiguration withEnablePinpoint(boolean enablePinpoint)

Enables pinpoint and endpoint registration.

Parameters:

enablePinpoint - true if Pinpoint to be enabled. Defaults to true.

Returns:

the current PinpointConfiguration instance

getCredentialsProvider

public AWSCredentialsProvider getCredentialsProvider()

The credentials provider used in order to authenticate.

Returns:

the AWSCredentialsProvider

withCredentialsProvider

public PinpointConfiguration withCredentialsProvider(AWSCredentialsProvider credentialsProvider)

Please provide a CognitoCredentialsProvider in order to authenticate.

Parameters:

credentialsProvider - The AWSCredentialsProvider to be used for the service

Returns:

the current PinpointConfiguration instance

getAppContext

public android.content.Context getAppContext()

The Android Context. Interface to global information about an application environment. This is an abstract class whose implementation is provided by the Android system. It allows access to application-specific resources and classes, as well as up-calls for application-level operations such as launching activities, broadcasting and receiving intents, etc.

Returns:

the Android Context object

withAppContext

public PinpointConfiguration withAppContext(android.content.Context context)

The Android Context. See https://developer.android.com/reference/android/content/Context.html

Parameters:

context - The android context object

Returns:

the current PinpointConfiguration instance

getAppId

public String getAppId()

The Pinpoint AppId

Returns:

the Pinpoint AppId

withAppId

public PinpointConfiguration withAppId(String appId)

The Pinpoint AppId

Parameters:

appId - The Pinpoint Application Id.

Returns:

the current PinpointConfiguration instance

getRegion

public Regions getRegion()

The AWS Region configured

Returns:

the Region

withRegion

public PinpointConfiguration withRegion(Regions region)

The AWS Region for Pinpoint

Parameters:

region - The AWS Regions for the Pinpoint service.

Returns:

the current PinpointConfiguration instance

getInitCompletionCallback

public PinpointCallback<PinpointManager> getInitCompletionCallback()

The callback to be called after initialization is complete

Returns:

the callback

withInitCompletionCallback

public PinpointConfiguration withInitCompletionCallback(PinpointCallback<PinpointManager> initCompletionCallback)

The callback to be called after initialization is complete

Parameters:

initCompletionCallback - A callback that is called after initialization of the SDK.

Returns:

the current PinpointConfiguration instance

getAppLevelOptOutProvider

public AppLevelOptOutProvider getAppLevelOptOutProvider()

The provider to call to check app-level opt out

Returns:

the provider

withAppLevelOptOutProvider

public PinpointConfiguration withAppLevelOptOutProvider(AppLevelOptOutProvider appLevelOptOutProvider)

The provider to call to check app-level opt out

Parameters:

appLevelOptOutProvider - A provider that returns a boolean indicating whether the app is opted out of notifications at the application level.

Returns:

the current PinpointConfiguration instance

getChannelType

public ChannelType getChannelType()

The channel type supported by this configuration.

Returns:

The channel type.

withChannelType

public PinpointConfiguration withChannelType(ChannelType channelType)

The channel type configured.

Parameters:

channelType - The ChannelType for this service.

Returns:

the current PinpointConfiguration instance.

withPostNotificationsInForeground

public PinpointConfiguration withPostNotificationsInForeground(boolean shouldPostNotificationsInForeground)

Configuration option to post notifications even if the app is in the foreground. By default notifications are not posted when the app is in the foreground.

Parameters:

shouldPostNotificationsInForeground - true to indicate to post app notifications in the foreground.

Returns:

the current PinpointConfiguration instance.

getExecutor

public ExecutorService getExecutor()

The custom executor used for handlers in the TargetingClient.

Returns:

The custom executor.

withExecutor

public PinpointConfiguration withExecutor(ExecutorService executorService)

Custom executor to use for handlers in the TargetingClient.

Parameters:

executorService - the executor to use.

Returns:

the current PinpointConfiguration instance.

getShouldPostNotificationsInForeground

public boolean getShouldPostNotificationsInForeground()

Returns:

true if notifications should be posted while the app is in the foreground, otherwise false.