com.apptentive.android.sdk

Class Apptentive

java.lang.Object

com.apptentive.android.sdk.Apptentive

public class Apptentive
extends java.lang.Object

This class contains the complete public API for accessing Apptentive features from within your app.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Apptentive.AuthenticationFailedListener A Listener you can register globally for the app, that will be called when requests other than login fail for the active conversation.
static class	Apptentive.AuthenticationFailedReason A list of error codes you will encounter when a JWT failure for logged in conversations occurs.
static interface	Apptentive.BooleanCallback Allows certain Apptentive API methods to execute and return a boolean result asynchronously.
static class	Apptentive.DateTime
static interface	Apptentive.LoginCallback Callback interface login().
static interface	Apptentive.OnPreInteractionListener Represents a callback which will be invoked right before an interaction is engaged.
static interface	Apptentive.PendingIntentCallback
static class	Apptentive.Version This type represents a semantic version.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INTEGRATION_PUSH_TOKEN For internal use only.
static int	PUSH_PROVIDER_AMAZON_AWS_SNS Call setPushNotificationIntegration(int, String) with this value to allow Apptentive to send pushes to this device through your existing Amazon AWS SNS integration.
static int	PUSH_PROVIDER_APPTENTIVE Call setPushNotificationIntegration(int, String) with this value to allow Apptentive to send pushes to this device without a third party push provider.
static int	PUSH_PROVIDER_PARSE Call setPushNotificationIntegration(int, String) with this value to allow Apptentive to send pushes to this device through your existing Parse Push integration.
static int	PUSH_PROVIDER_URBAN_AIRSHIP Call setPushNotificationIntegration(int, String) with this value to allow Apptentive to send pushes to this device through your existing Urban Airship Push integration.

Constructor Summary

Constructors

Constructor and Description
Apptentive()

Method Summary

Modifier and Type	Method and Description
static void	addCustomDeviceData(java.lang.String key, java.lang.Boolean value) Add a custom data Boolean to the Device.
static void	addCustomDeviceData(java.lang.String key, java.lang.Number value) Add a custom data Number to the Device.
static void	addCustomDeviceData(java.lang.String key, java.lang.String value) Add a custom data String to the Device.
static void	addCustomPersonData(java.lang.String key, java.lang.Boolean value) Add a custom data Boolean to the Person.
static void	addCustomPersonData(java.lang.String key, java.lang.Number value) Add a custom data Number to the Person.
static void	addCustomPersonData(java.lang.String key, java.lang.String value) Add a custom data String to the Person.
static void	addUnreadMessagesListener(UnreadMessagesListener listener) Add a listener to be notified when the number of unread messages in the Message Center changes.
static void	buildPendingIntentFromPushNotification(Apptentive.PendingIntentCallback callback, android.os.Bundle bundle) Use this method in your push receiver to build a pending Intent when an Apptentive push notification is received.
static void	buildPendingIntentFromPushNotification(Apptentive.PendingIntentCallback callback, android.content.Intent intent) Use this method in your push receiver to build a pending Intent when an Apptentive push notification is received.
static void	buildPendingIntentFromPushNotification(Apptentive.PendingIntentCallback callback, java.util.Map<java.lang.String,java.lang.String> data) Use this method in your push receiver to build a pending Intent when an Apptentive push notification is received.
static void	canShowMessageCenter(Apptentive.BooleanCallback callback) Our SDK must connect to our server at least once to download initial configuration for Message Center.
static void	clearAuthenticationFailedListener()
static void	engage(android.content.Context context, java.lang.String event) This method takes a unique event string, stores a record of that event having been visited, determines if there is an interaction that is able to run for this event, and then runs it.
static void	engage(android.content.Context context, java.lang.String event, Apptentive.BooleanCallback callback) This method takes a unique event string, stores a record of that event having been visited, determines if there is an interaction that is able to run for this event, and then runs it.
static void	engage(android.content.Context context, java.lang.String event, Apptentive.BooleanCallback callback, java.util.Map<java.lang.String,java.lang.Object> customData) This method takes a unique event string, stores a record of that event having been visited, determines if there is an interaction that is able to run for this event, and then runs it.
static void	engage(android.content.Context context, java.lang.String event, Apptentive.BooleanCallback callback, java.util.Map<java.lang.String,java.lang.Object> customData, ExtendedData... extendedData) This method takes a unique event string, stores a record of that event having been visited, determines if there is an interaction that is able to run for this event, and then runs it.
static void	engage(android.content.Context context, java.lang.String event, java.util.Map<java.lang.String,java.lang.Object> customData) This method takes a unique event string, stores a record of that event having been visited, determines if there is an interaction that is able to run for this event, and then runs it.
static void	engage(android.content.Context context, java.lang.String event, java.util.Map<java.lang.String,java.lang.Object> customData, ExtendedData... extendedData) This method takes a unique event string, stores a record of that event having been visited, determines if there is an interaction that is able to run for this event, and then runs it.
static java.lang.String	getBodyFromApptentivePush(android.os.Bundle bundle) Use this method in your push receiver to get the notification body text you can use to construct a Notification object.
static java.lang.String	getBodyFromApptentivePush(android.content.Intent intent) Use this method in your push receiver to get the notification body text you can use to construct a Notification object.
static java.lang.String	getBodyFromApptentivePush(java.util.Map<java.lang.String,java.lang.String> data) Use this method in your push receiver to get the notification body text you can use to construct a Notification object.
static java.lang.String	getPersonEmail() Retrieves the user's email address.
static java.lang.String	getPersonName() Retrieves the user's name.
static java.lang.String	getTitleFromApptentivePush(android.os.Bundle bundle) Use this method in your push receiver to get the notification title you can use to construct a Notification object.
static java.lang.String	getTitleFromApptentivePush(android.content.Intent intent) Use this method in your push receiver to get the notification title you can use to construct a Notification object.
static java.lang.String	getTitleFromApptentivePush(java.util.Map<java.lang.String,java.lang.String> data) Use this method in your push receiver to get the notification title you can use to construct a Notification object.
static int	getUnreadMessageCount() Returns the number of unread messages in the Message Center.
static boolean	isApptentivePushNotification(android.os.Bundle bundle) Determines whether this Bundle came from an Apptentive push notification.
static boolean	isApptentivePushNotification(android.content.Intent intent) Determines whether this Intent is a push notification sent from Apptentive.
static boolean	isApptentivePushNotification(java.util.Map<java.lang.String,java.lang.String> data) Determines whether push payload data came from an Apptentive push notification.
static void	login(java.lang.String token, Apptentive.LoginCallback callback) Starts login process asynchronously.
static void	logout()
static void	onApptimizeExperimentRun(java.lang.String experimentName, java.lang.String variantName, boolean firstRun) Invoke this method from your Apptimize.OnExperimentRunListener when an A/B experiment is run.
static void	onApptimizeExperimentsProcessed() Invoke this method from your Apptimize.OnExperimentsProcessedListener when A/B experiment configuration is recalculated..
static void	putRatingProviderArg(java.lang.String key, java.lang.String value) If there are any properties that your IRatingProvider implementation requires, populate them here.
static void	queryCanShowInteraction(java.lang.String event, Apptentive.BooleanCallback callback) This method can be used to determine if a call to one of the engage() methods such as engage(Context, String) using the same event name will result in the display of an Interaction.
static void	register(android.app.Application application) Deprecated. Please, use register(Application, String, String) or register(Application, ApptentiveConfiguration) instead
static void	register(android.app.Application application, ApptentiveConfiguration configuration) Must be called from the Application.onCreate() method in the Application object defined in your app's manifest.
static void	register(android.app.Application application, java.lang.String apptentiveKey, java.lang.String apptentiveSignature) Must be called from the Application.onCreate() method in the Application object defined in your app's manifest.
static void	registerCallbacks(android.app.Application application) Register application callbacks.
static void	removeCustomDeviceData(java.lang.String key) Remove a piece of custom data from the device.
static void	removeCustomPersonData(java.lang.String key) Remove a piece of custom data from the Person.
static void	sendAttachmentFile(byte[] content, java.lang.String mimeType) Sends a file to the server.
static void	sendAttachmentFile(java.io.InputStream is, java.lang.String mimeType) Sends a file to the server.
static void	sendAttachmentFile(java.lang.String uri) Sends a file to the server.
static void	sendAttachmentText(java.lang.String text) Sends a text message to the server.
static void	setAuthenticationFailedListener(Apptentive.AuthenticationFailedListener listener) Registers your listener with Apptentive.
static void	setOnPreInteractionListener(Apptentive.OnPreInteractionListener onPreInteractionListener) Sets an optional engagement callback.
static void	setOnSurveyFinishedListener(OnSurveyFinishedListener listener) Pass in a listener.
static void	setPersonEmail(java.lang.String email) Sets the user's email address.
static void	setPersonName(java.lang.String name) Sets the user's name.
static void	setPushNotificationIntegration(int pushProvider, java.lang.String token) Sends push provider information to our server to allow us to send pushes to this device when you reply to your customers.
static void	setRatingProvider(IRatingProvider ratingProvider) Use this to choose where to send the user when they are prompted to rate the app.
static void	setUnreadMessagesListener(UnreadMessagesListener listener) Deprecated.
static void	showMessageCenter(android.content.Context context) Opens the Apptentive Message Center UI Activity.
static void	showMessageCenter(android.content.Context context, Apptentive.BooleanCallback callback) Opens the Apptentive Message Center UI Activity.
static void	showMessageCenter(android.content.Context context, Apptentive.BooleanCallback callback, java.util.Map<java.lang.String,java.lang.Object> customData) Opens the Apptentive Message Center UI Activity, and allows custom data to be sent with the next message the user sends.
static void	showMessageCenter(android.content.Context context, java.util.Map<java.lang.String,java.lang.Object> customData) Opens the Apptentive Message Center UI Activity, and allows custom data to be sent with the next message the user sends.

Methods inherited from class java.lang.Object

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

Field Detail

INTEGRATION_PUSH_TOKEN

public static final java.lang.String INTEGRATION_PUSH_TOKEN

For internal use only.

See Also:

Constant Field Values

PUSH_PROVIDER_APPTENTIVE

public static final int PUSH_PROVIDER_APPTENTIVE

Call setPushNotificationIntegration(int, String) with this value to allow Apptentive to send pushes to this device without a third party push provider. Requires a valid GCM configuration.

See Also:

Constant Field Values

PUSH_PROVIDER_PARSE

public static final int PUSH_PROVIDER_PARSE

Call setPushNotificationIntegration(int, String) with this value to allow Apptentive to send pushes to this device through your existing Parse Push integration. Requires a valid Parse integration.

See Also:

Constant Field Values

PUSH_PROVIDER_URBAN_AIRSHIP

public static final int PUSH_PROVIDER_URBAN_AIRSHIP

Call setPushNotificationIntegration(int, String) with this value to allow Apptentive to send pushes to this device through your existing Urban Airship Push integration. Requires a valid Urban Airship Push integration.

See Also:

Constant Field Values

PUSH_PROVIDER_AMAZON_AWS_SNS

public static final int PUSH_PROVIDER_AMAZON_AWS_SNS

Call setPushNotificationIntegration(int, String) with this value to allow Apptentive to send pushes to this device through your existing Amazon AWS SNS integration. Requires a valid Amazon AWS SNS integration.

See Also:

Constant Field Values

Constructor Detail

Apptentive

public Apptentive()

Method Detail

register

@Deprecated
public static void register(android.app.Application application)

Deprecated. Please, use register(Application, String, String) or register(Application, ApptentiveConfiguration) instead

Must be called from the Application.onCreate() method in the Application object defined in your app's manifest. Note: application key and signature would be resolved from the AndroidManifest.xml

Parameters:

application - The Application object for this app.

register

public static void register(android.app.Application application,
                            java.lang.String apptentiveKey,
                            java.lang.String apptentiveSignature)

Must be called from the Application.onCreate() method in the Application object defined in your app's manifest.

Parameters:

application - Application object.

apptentiveKey - Apptentive Key.

apptentiveSignature - Apptentive Signature.

register

public static void register(android.app.Application application,
                            ApptentiveConfiguration configuration)

Must be called from the Application.onCreate() method in the Application object defined in your app's manifest.

Parameters:

application - Application object.

configuration - Apptentive configuration containing SDK initialization data.

registerCallbacks

public static void registerCallbacks(android.app.Application application)

Register application callbacks. You only need to call this if you register Apptentive instance outside of your Application class.

setPersonEmail

public static void setPersonEmail(java.lang.String email)

Sets the user's email address. This email address will be sent to the Apptentive server to allow out of app communication, and to help provide more context about this user. This email will be the definitive email address for this user, unless one is provided directly by the user through an Apptentive UI. Calls to this method are idempotent. Calls to this method will overwrite any previously entered email, so if you don't want to overwrite the email provided by the user, make sure to check the value with getPersonEmail() before you call this method.

Parameters:

email - The user's email address.

getPersonEmail

public static java.lang.String getPersonEmail()

Retrieves the user's email address. This address may be set via setPersonEmail(String), or by the user through Message Center.

Returns:

The person's email if set, else null.

setPersonName

public static void setPersonName(java.lang.String name)

Sets the user's name. This name will be sent to the Apptentive server and displayed in conversations you have with this person. This name will be the definitive username for this user, unless one is provided directly by the user through an Apptentive UI. Calls to this method are idempotent. Calls to this method will overwrite any previously entered email, so if you don't want to overwrite the email provided by the user, make sure to check the value with getPersonName() before you call this method.

Parameters:

name - The user's name.

getPersonName

public static java.lang.String getPersonName()

Retrieves the user's name. This name may be set via setPersonName(String), or by the user through Message Center.

Returns:

The person's name if set, else null.

addCustomDeviceData

public static void addCustomDeviceData(java.lang.String key,
                                       java.lang.String value)

Add a custom data String to the Device. Custom data will be sent to the server, is displayed in the Conversation view, and can be used in Interaction targeting. Calls to this method are idempotent.

Parameters:

key - The key to store the data under.

value - A String value.

addCustomDeviceData

public static void addCustomDeviceData(java.lang.String key,
                                       java.lang.Number value)

Add a custom data Number to the Device. Custom data will be sent to the server, is displayed in the Conversation view, and can be used in Interaction targeting. Calls to this method are idempotent.

Parameters:

key - The key to store the data under.

value - A Number value.

addCustomDeviceData

public static void addCustomDeviceData(java.lang.String key,
                                       java.lang.Boolean value)

Add a custom data Boolean to the Device. Custom data will be sent to the server, is displayed in the Conversation view, and can be used in Interaction targeting. Calls to this method are idempotent.

Parameters:

key - The key to store the data under.

value - A Boolean value.

removeCustomDeviceData

public static void removeCustomDeviceData(java.lang.String key)

Remove a piece of custom data from the device. Calls to this method are idempotent.

Parameters:

key - The key to remove.

addCustomPersonData

public static void addCustomPersonData(java.lang.String key,
                                       java.lang.String value)

Add a custom data String to the Person. Custom data will be sent to the server, is displayed in the Conversation view, and can be used in Interaction targeting. Calls to this method are idempotent.

Parameters:

key - The key to store the data under.

value - A String value.

addCustomPersonData

public static void addCustomPersonData(java.lang.String key,
                                       java.lang.Number value)

Add a custom data Number to the Person. Custom data will be sent to the server, is displayed in the Conversation view, and can be used in Interaction targeting. Calls to this method are idempotent.

Parameters:

key - The key to store the data under.

value - A Number value.

addCustomPersonData

public static void addCustomPersonData(java.lang.String key,
                                       java.lang.Boolean value)

Add a custom data Boolean to the Person. Custom data will be sent to the server, is displayed in the Conversation view, and can be used in Interaction targeting. Calls to this method are idempotent.

Parameters:

key - The key to store the data under.

value - A Boolean value.

removeCustomPersonData

public static void removeCustomPersonData(java.lang.String key)

Remove a piece of custom data from the Person. Calls to this method are idempotent.

Parameters:

key - The key to remove.

setPushNotificationIntegration

public static void setPushNotificationIntegration(int pushProvider,
                                                  java.lang.String token)

Sends push provider information to our server to allow us to send pushes to this device when you reply to your customers. Only one push provider is allowed to be active at a time, so you should only call this method once. Please see our integration guide for instructions.

Parameters:

pushProvider - One of the following:

• PUSH_PROVIDER_APPTENTIVE
• PUSH_PROVIDER_PARSE
• PUSH_PROVIDER_URBAN_AIRSHIP
• PUSH_PROVIDER_AMAZON_AWS_SNS

token - The push provider token you receive from your push provider. The format is push provider specific.

Apptentive

If you are using Apptentive to send pushes directly to GCM or FCM, pass in the GCM/FCM Registration ID, which you can access like this.

Parse

The Parse deviceToken

Urban Airship

The Urban Airship Channel ID, which you can access like this.

Amazon AWS SNS

The GCM Registration ID, which you can access like this.

isApptentivePushNotification

public static boolean isApptentivePushNotification(android.content.Intent intent)

Determines whether this Intent is a push notification sent from Apptentive.

Parameters:

intent - The received Intent you received in your BroadcastReceiver.

Returns:

True if the Intent came from, and should be handled by Apptentive.

isApptentivePushNotification

public static boolean isApptentivePushNotification(android.os.Bundle bundle)

Determines whether this Bundle came from an Apptentive push notification. This method is used with Urban Airship integrations.

Parameters:

bundle - The push payload bundle passed to GCM onMessageReceived() callback

Returns:

True if the push came from, and should be handled by Apptentive.

isApptentivePushNotification

public static boolean isApptentivePushNotification(java.util.Map<java.lang.String,java.lang.String> data)

Determines whether push payload data came from an Apptentive push notification.

Parameters:

data - The push payload data obtained through FCM's RemoteMessage.getData(), when using FCM

Returns:

True if the push came from, and should be handled by Apptentive.

buildPendingIntentFromPushNotification

public static void buildPendingIntentFromPushNotification(@NonNull
                                                          Apptentive.PendingIntentCallback callback,
                                                          @NonNull
                                                          android.content.Intent intent)

Use this method in your push receiver to build a pending Intent when an Apptentive push notification is received. Pass the generated PendingIntent to NotificationCompat.Builder.setContentIntent(android.app.PendingIntent) to allow Apptentive to display Interactions such as Message Center. Calling this method for a push Intent that did not come from Apptentive will return a null object. If you receive a null object, your app will need to handle this notification itself.

This task is performed asynchronously.

This is the method you will likely need if you integrated using:

• GCM
• AWS SNS
• Parse

Parameters:

callback - Called after we check to see Apptentive can launch an Interaction from this push. Called with a PendingIntent to launch an Apptentive Interaction if the push data came from Apptentive, and an Interaction can be shown, or null.

intent - An Intent containing the Apptentive Push data. Pass in what you receive in the Service or BroadcastReceiver that is used by your chosen push provider.

buildPendingIntentFromPushNotification

public static void buildPendingIntentFromPushNotification(@NonNull
                                                          Apptentive.PendingIntentCallback callback,
                                                          @NonNull
                                                          android.os.Bundle bundle)

Use this method in your push receiver to build a pending Intent when an Apptentive push notification is received. Pass the generated PendingIntent to NotificationCompat.Builder.setContentIntent(android.app.PendingIntent) to allow Apptentive to display Interactions such as Message Center. Calling this method for a push Bundle that did not come from Apptentive will return a null object. If you receive a null object, your app will need to handle this notification itself.

This task is performed asynchronously.

This is the method you will likely need if you integrated using:

• Urban Airship

Parameters:

callback - Called after we check to see Apptentive can launch an Interaction from this push. Called with a PendingIntent to launch an Apptentive Interaction if the push data came from Apptentive, and an Interaction can be shown, or null.

bundle - A Bundle containing the Apptentive Push data. Pass in what you receive in the the Service or BroadcastReceiver that is used by your chosen push provider.

buildPendingIntentFromPushNotification

public static void buildPendingIntentFromPushNotification(Apptentive.PendingIntentCallback callback,
                                                          @NonNull
                                                          java.util.Map<java.lang.String,java.lang.String> data)

Use this method in your push receiver to build a pending Intent when an Apptentive push notification is received. Pass the generated PendingIntent to NotificationCompat.Builder.setContentIntent(android.app.PendingIntent) to allow Apptentive to display Interactions such as Message Center. Calling this method for a push Bundle that did not come from Apptentive will return a null object. If you receive a null object, your app will need to handle this notification itself.

This task is performed asynchronously.

This is the method you will likely need if you integrated using:

• Firebase Cloud Messaging (FCM)

Parameters:

callback - Called after we check to see Apptentive can launch an Interaction from this push. Called with a PendingIntent to launch an Apptentive Interaction if the push data came from Apptentive, and an Interaction can be shown, or null.

data - A Map<String,String> containing the Apptentive Push data. Pass in what you receive in the the Service or BroadcastReceiver that is used by your chosen push provider.

getTitleFromApptentivePush

public static java.lang.String getTitleFromApptentivePush(android.content.Intent intent)

Use this method in your push receiver to get the notification title you can use to construct a Notification object.

Parameters:

intent - An Intent containing the Apptentive Push data. Pass in what you receive in the Service or BroadcastReceiver that is used by your chosen push provider.

Returns:

a String value, or null.

getBodyFromApptentivePush

public static java.lang.String getBodyFromApptentivePush(android.content.Intent intent)

Use this method in your push receiver to get the notification body text you can use to construct a Notification object.

Parameters:

intent - An Intent containing the Apptentive Push data. Pass in what you receive in the Service or BroadcastReceiver that is used by your chosen push provider.

Returns:

a String value, or null.

getTitleFromApptentivePush

public static java.lang.String getTitleFromApptentivePush(android.os.Bundle bundle)

Use this method in your push receiver to get the notification title you can use to construct a Notification object.

Parameters:

bundle - A Bundle containing the Apptentive Push data. Pass in what you receive in the the Service or BroadcastReceiver that is used by your chosen push provider.

Returns:

a String value, or null.

getBodyFromApptentivePush

public static java.lang.String getBodyFromApptentivePush(android.os.Bundle bundle)

Use this method in your push receiver to get the notification body text you can use to construct a Notification object.

Parameters:

bundle - A Bundle containing the Apptentive Push data. Pass in what you receive in the the Service or BroadcastReceiver that is used by your chosen push provider.

Returns:

a String value, or null.

getTitleFromApptentivePush

public static java.lang.String getTitleFromApptentivePush(java.util.Map<java.lang.String,java.lang.String> data)

Use this method in your push receiver to get the notification title you can use to construct a Notification object.

Parameters:

data - A Map<String,String> containing the Apptentive Push data. Pass in what you receive in the the Service or BroadcastReceiver that is used by your chosen push provider.

Returns:

a String value, or null.

getBodyFromApptentivePush

public static java.lang.String getBodyFromApptentivePush(java.util.Map<java.lang.String,java.lang.String> data)

Use this method in your push receiver to get the notification body text you can use to construct a Notification object.

Parameters:

data - A Map<String,String> containing the Apptentive Push data. Pass in what you receive in the the Service or BroadcastReceiver that is used by your chosen push provider.

Returns:

a String value, or null.

setRatingProvider

public static void setRatingProvider(IRatingProvider ratingProvider)

Use this to choose where to send the user when they are prompted to rate the app. This should be the same place that the app was downloaded from.

Parameters:

ratingProvider - A IRatingProvider value.

putRatingProviderArg

public static void putRatingProviderArg(java.lang.String key,
                                        java.lang.String value)

If there are any properties that your IRatingProvider implementation requires, populate them here. This is not currently needed with the Google Play and Amazon Appstore IRatingProviders.

Parameters:

key - A String

value - A String

showMessageCenter

public static void showMessageCenter(android.content.Context context)

Opens the Apptentive Message Center UI Activity. This task is performed asynchronously. Message Center configuration may not have been downloaded yet when this is called. If you would like to know whether this method was able to launch Message Center, use showMessageCenter(Context, BooleanCallback).

Parameters:

context - The context from which to launch the Message Center

showMessageCenter

public static void showMessageCenter(android.content.Context context,
                                     Apptentive.BooleanCallback callback)

Opens the Apptentive Message Center UI Activity. This task is performed asynchronously. Message Center configuration may not have been downloaded yet when this is called.

Parameters:

context - The context from which to launch the Message Center

callback - Called after we check to see if Message Center can be displayed, but before it is displayed. Called with true if an Interaction will be displayed, else false.

showMessageCenter

public static void showMessageCenter(android.content.Context context,
                                     java.util.Map<java.lang.String,java.lang.Object> customData)

Opens the Apptentive Message Center UI Activity, and allows custom data to be sent with the next message the user sends. If the user sends multiple messages, this data will only be sent with the first message sent after this method is invoked. Additional invocations of this method with custom data will repeat this process. If Message Center is closed without a message being sent, the custom data is cleared. This task is performed asynchronously. Message Center configuration may not have been downloaded yet when this is called. If you would like to know whether this method was able to launch Message Center, use showMessageCenter(Context, BooleanCallback, Map).

Parameters:

context - The context from which to launch the Message Center. This should be an Activity, except in rare cases where you don't have access to one, in which case Apptentive Message Center will launch in a new task.

customData - A Map of String keys to Object values. Objects may be Strings, Numbers, or Booleans. If any message is sent by the Person, this data is sent with it, and then cleared. If no message is sent, this data is discarded.

showMessageCenter

public static void showMessageCenter(android.content.Context context,
                                     Apptentive.BooleanCallback callback,
                                     java.util.Map<java.lang.String,java.lang.Object> customData)

Opens the Apptentive Message Center UI Activity, and allows custom data to be sent with the next message the user sends. If the user sends multiple messages, this data will only be sent with the first message sent after this method is invoked. Additional invocations of this method with custom data will repeat this process. If Message Center is closed without a message being sent, the custom data is cleared. This task is performed asynchronously. Message Center configuration may not have been downloaded yet when this is called.

Parameters:

context - The context from which to launch the Message Center. This should be an Activity, except in rare cases where you don't have access to one, in which case Apptentive Message Center will launch in a new task.

callback - Called after we check to see if Message Center can be displayed, but before it is displayed. Called with true if an Interaction will be displayed, else false.

customData - A Map of String keys to Object values. Objects may be Strings, Numbers, or Booleans. If any message is sent by the Person, this data is sent with it, and then cleared. If no message is sent, this data is discarded.

canShowMessageCenter

public static void canShowMessageCenter(Apptentive.BooleanCallback callback)

Our SDK must connect to our server at least once to download initial configuration for Message Center. Call this method to see whether or not Message Center can be displayed. This task is performed asynchronously.

Parameters:

callback - Called after we check to see if Message Center can be displayed, but before it is displayed. Called with true if an Interaction will be displayed, else false.

setUnreadMessagesListener

@Deprecated
public static void setUnreadMessagesListener(UnreadMessagesListener listener)

Deprecated.

Set one and only listener to be notified when the number of unread messages in the Message Center changes. if the app calls this method to set up a custom listener, the apptentive unread message badge, also an UnreadMessagesListener, won't get notification. Please use addUnreadMessagesListener(UnreadMessagesListener) instead.

Parameters:

listener - An UnreadMessagesListener that you instantiate. Pass null to remove existing listener. Do not pass in an anonymous class, such as setUnreadMessagesListener(new UnreadMessagesListener() {...}). Instead, create your listener as an instance variable and pass that in. This allows us to keep a weak reference to avoid memory leaks.

addUnreadMessagesListener

public static void addUnreadMessagesListener(UnreadMessagesListener listener)

Add a listener to be notified when the number of unread messages in the Message Center changes.

Parameters:

listener - An UnreadMessagesListener that you instantiate. Do not pass in an anonymous class. Instead, create your listener as an instance variable and pass that in. This allows us to keep a weak reference to avoid memory leaks.

getUnreadMessageCount

public static int getUnreadMessageCount()

Returns the number of unread messages in the Message Center.

Returns:

The number of unread messages.

sendAttachmentText

public static void sendAttachmentText(java.lang.String text)

Sends a text message to the server. This message will be visible in the conversation view on the server, but will not be shown in the client's Message Center.

Parameters:

text - The message you wish to send.

sendAttachmentFile

public static void sendAttachmentFile(java.lang.String uri)

Sends a file to the server. This file will be visible in the conversation view on the server, but will not be shown in the client's Message Center. A local copy of this file will be made until the message is transmitted, at which point the temporary file will be deleted.

Parameters:

uri - The URI of the local resource file.

sendAttachmentFile

public static void sendAttachmentFile(byte[] content,
                                      java.lang.String mimeType)

Sends a file to the server. This file will be visible in the conversation view on the server, but will not be shown in the client's Message Center. A local copy of this file will be made until the message is transmitted, at which point the temporary file will be deleted.

Parameters:

content - A byte array of the file contents.

mimeType - The mime type of the file.

sendAttachmentFile

public static void sendAttachmentFile(java.io.InputStream is,
                                      java.lang.String mimeType)

Sends a file to the server. This file will be visible in the conversation view on the server, but will not be shown in the client's Message Center. A local copy of this file will be made until the message is transmitted, at which point the temporary file will be deleted.

Parameters:

is - An InputStream from the desired file.

mimeType - The mime type of the file.

engage

public static void engage(android.content.Context context,
                          java.lang.String event)

This method takes a unique event string, stores a record of that event having been visited, determines if there is an interaction that is able to run for this event, and then runs it. If more than one interaction can run, then the most appropriate interaction takes precedence. Only one interaction at most will run per invocation of this method. This task is performed asynchronously. If you would like to know whether this method will launch an Apptentive Interaction, use engage(Context, String, BooleanCallback)

Parameters:

context - The context from which to launch the Interaction. This should be an Activity, except in rare cases where you don't have access to one, in which case Apptentive Interactions will launch in a new task.

event - A unique String representing the line this method is called on. For instance, you may want to have the ability to target interactions to run after the user uploads a file in your app. You may then call engage(context, "finished_upload");

engage

public static void engage(android.content.Context context,
                          java.lang.String event,
                          Apptentive.BooleanCallback callback)

This method takes a unique event string, stores a record of that event having been visited, determines if there is an interaction that is able to run for this event, and then runs it. If more than one interaction can run, then the most appropriate interaction takes precedence. Only one interaction at most will run per invocation of this method. This task is performed asynchronously.

Parameters:

context - The context from which to launch the Interaction. This should be an Activity, except in rare cases where you don't have access to one, in which case Apptentive Interactions will launch in a new task.

event - A unique String representing the line this method is called on. For instance, you may want to have the ability to target interactions to run after the user uploads a file in your app. You may then call engage(context, "finished_upload");

callback - Called after we check to see if an Interaction should be displayed. Called with true if an Interaction will be displayed, else false.

engage

public static void engage(android.content.Context context,
                          java.lang.String event,
                          java.util.Map<java.lang.String,java.lang.Object> customData)

This method takes a unique event string, stores a record of that event having been visited, determines if there is an interaction that is able to run for this event, and then runs it. If more than one interaction can run, then the most appropriate interaction takes precedence. Only one interaction at most will run per invocation of this method. This task is performed asynchronously. If you would like to know whether this method will launch an Apptentive Interaction, use engage(Context, String, BooleanCallback, Map).

Parameters:

context - The context from which to launch the Interaction. This should be an Activity, except in rare cases where you don't have access to one, in which case Apptentive Interactions will launch in a new task.

event - A unique String representing the line this method is called on. For instance, you may want to have the ability to target interactions to run after the user uploads a file in your app. You may then call engage(context, "finished_upload");

customData - A Map of String keys to Object values. Objects may be Strings, Numbers, or Booleans. This data is sent to the server for tracking information in the context of the engaged Event.

engage

public static void engage(android.content.Context context,
                          java.lang.String event,
                          Apptentive.BooleanCallback callback,
                          java.util.Map<java.lang.String,java.lang.Object> customData)

This method takes a unique event string, stores a record of that event having been visited, determines if there is an interaction that is able to run for this event, and then runs it. If more than one interaction can run, then the most appropriate interaction takes precedence. Only one interaction at most will run per invocation of this method. This task is performed asynchronously.

Parameters:

context - The context from which to launch the Interaction. This should be an Activity, except in rare cases where you don't have access to one, in which case Apptentive Interactions will launch in a new task.

event - A unique String representing the line this method is called on. For instance, you may want to have the ability to target interactions to run after the user uploads a file in your app. You may then call engage(context, "finished_upload");

callback - Called after we check to see if an Interaction should be displayed. Called with true if an Interaction will be displayed, else false.

customData - A Map of String keys to Object values. Objects may be Strings, Numbers, or Booleans. This data is sent to the server for tracking information in the context of the engaged Event.

engage

public static void engage(android.content.Context context,
                          java.lang.String event,
                          java.util.Map<java.lang.String,java.lang.Object> customData,
                          ExtendedData... extendedData)

This method takes a unique event string, stores a record of that event having been visited, determines if there is an interaction that is able to run for this event, and then runs it. If more than one interaction can run, then the most appropriate interaction takes precedence. Only one interaction at most will run per invocation of this method. This task is performed asynchronously. If you would like to know whether this method will launch an Apptentive Interaction, use engage(Context, String, BooleanCallback, Map, ExtendedData...).

Parameters:

context - The context from which to launch the Interaction. This should be an Activity, except in rare cases where you don't have access to one, in which case Apptentive Interactions will launch in a new task.

event - A unique String representing the line this method is called on. For instance, you may want to have the ability to target interactions to run after the user uploads a file in your app. You may then call engage(context, "finished_upload");

customData - A Map of String keys to Object values. Objects may be Strings, Numbers, or Booleans. This data is sent to the server for tracking information in the context of the engaged Event.

extendedData - An array of ExtendedData objects. ExtendedData objects used to send structured data that has specific meaning to the server. By using an ExtendedData object instead of arbitrary customData, special meaning can be derived. Supported objects include TimeExtendedData, LocationExtendedData, and CommerceExtendedData. Include each type only once.

engage

public static void engage(android.content.Context context,
                          java.lang.String event,
                          Apptentive.BooleanCallback callback,
                          java.util.Map<java.lang.String,java.lang.Object> customData,
                          ExtendedData... extendedData)

This method takes a unique event string, stores a record of that event having been visited, determines if there is an interaction that is able to run for this event, and then runs it. If more than one interaction can run, then the most appropriate interaction takes precedence. Only one interaction at most will run per invocation of this method.

Parameters:

context - The context from which to launch the Interaction. This should be an Activity, except in rare cases where you don't have access to one, in which case Apptentive Interactions will launch in a new task.

event - A unique String representing the line this method is called on. For instance, you may want to have the ability to target interactions to run after the user uploads a file in your app. You may then call engage(context, "finished_upload");

callback - Called after we check to see if an Interaction should be displayed. Called with true if an Interaction will be displayed, else false.

customData - A Map of String keys to Object values. Objects may be Strings, Numbers, or Booleans. This data is sent to the server for tracking information in the context of the engaged Event.

extendedData - An array of ExtendedData objects. ExtendedData objects used to send structured data that has specific meaning to the server. By using an ExtendedData object instead of arbitrary customData, special meaning can be derived. Supported objects include TimeExtendedData, LocationExtendedData, and CommerceExtendedData. Include each type only once.

queryCanShowInteraction

public static void queryCanShowInteraction(java.lang.String event,
                                           Apptentive.BooleanCallback callback)

This method can be used to determine if a call to one of the engage() methods such as engage(Context, String) using the same event name will result in the display of an Interaction. This is useful if you need to know whether an Interaction will be displayed before you create a UI Button, etc.

Parameters:

event - A unique String representing the line this method is called on. For instance, you may want to have the ability to target interactions to run after the user uploads a file in your app. You may then call engage(activity, "finished_upload");

setOnPreInteractionListener

public static void setOnPreInteractionListener(@Nullable
                                               Apptentive.OnPreInteractionListener onPreInteractionListener)

Sets an optional engagement callback.

setOnSurveyFinishedListener

public static void setOnSurveyFinishedListener(OnSurveyFinishedListener listener)

Pass in a listener. The listener will be called whenever a survey is finished. Do not pass in an anonymous class, such as setOnSurveyFinishedListener(new OnSurveyFinishedListener() {...}). Instead, create your listener as an instance variable and pass that in. This allows us to keep a weak reference to avoid memory leaks.

Parameters:

listener - The OnSurveyFinishedListener listener to call when the survey is finished.

login

public static void login(java.lang.String token,
                         Apptentive.LoginCallback callback)

Starts login process asynchronously. This call returns immediately. Using this method requires you to implement JWT generation on your server. Please read about it in Apptentive's Android Integration Reference Guide.

Parameters:

token - A JWT signed by your server using the secret from your app's Apptentive settings.

callback - A LoginCallback, which will be called asynchronously when the login succeeds or fails.

logout

public static void logout()

setAuthenticationFailedListener

public static void setAuthenticationFailedListener(Apptentive.AuthenticationFailedListener listener)

Registers your listener with Apptentive. This listener is stored with a WeakReference, which means that you must store a static reference to the listener as long as you want it to live. One possible way to do this is to implement this listener with your Application class, or store one on your Application.

This listener will alert you to authentication failures, so that you can either recover from expired or revoked JWTs, or fix your authentication implementation.

Parameters:

listener - A listener that will be called when there is an authentication failure other for the current logged in conversation. If the failure is for another conversation, or there is no active conversation, the listener is not called.

clearAuthenticationFailedListener

public static void clearAuthenticationFailedListener()

onApptimizeExperimentRun

public static void onApptimizeExperimentRun(java.lang.String experimentName,
                                            java.lang.String variantName,
                                            boolean firstRun)

Invoke this method from your Apptimize.OnExperimentRunListener when an A/B experiment is run.

onApptimizeExperimentsProcessed

public static void onApptimizeExperimentsProcessed()

Invoke this method from your Apptimize.OnExperimentsProcessedListener when A/B experiment configuration is recalculated..