Index (Batch Android SDK 1.21.1)

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

accumulate(String, Object) - Method in class com.batch.android.json.JSONObject: Appends value to the array already mapped to name.
ACTION_PERMISSION_RESULT - Static variable in class com.batch.android.BatchPermissionActivity
ACTION_REGISTRATION_IDENTIFIER_OBTAINED - Static variable in class com.batch.android.Batch: Intent broadcasted locally by the SDK when a push registration identifier has been retrieved (also called "Push Token").
actionArguments - Variable in class com.batch.android.BatchNotificationAction: Action
actionIdentifier - Variable in class com.batch.android.BatchNotificationAction: Action identifier.
addDispatcher(BatchEventDispatcher) - Static method in class com.batch.android.Batch.EventDispatcher: Add an event dispatcher.
addDrawableAlias(String, int) - Static method in class com.batch.android.Batch.Actions: Add an alias to a drawable that can be referenced remotely.
addTag(String) - Method in class com.batch.android.BatchEventData: Add a tag
addTag(String, String) - Method in class com.batch.android.BatchUserDataEditor: Add a tag in the specified collection.
AdsIdentifierProvider - Interface in com.batch.android: Deprecated.
Batch doesn't collects the Android Advertising Identifier anymore.
AdsIdentifierProvider.AdsIdentifierListener - Interface in com.batch.android: Deprecated.
Batch doesn't collects the Android Advertising Identifier anymore.
AdsIdentifierProviderAvailabilityException - Exception in com.batch.android: Deprecated.
Batch doesn't collects the Android Advertising Identifier anymore.
AdsIdentifierProviderAvailabilityException(String) - Constructor for exception com.batch.android.AdsIdentifierProviderAvailabilityException: Deprecated.
ALERT - Enum constant in enum class com.batch.android.BatchMessage.Format: ALERT is simple a system alert
ALERT - Enum constant in enum class com.batch.android.PushNotificationType: Display a notification
ALERT_KEY - Static variable in class com.batch.android.Batch.Push: Key to retrieve the Alert message
appendBatchData(Intent, Intent) - Static method in class com.batch.android.Batch.Push: Append Batch data to your open intent so that opens from this push will be tracked by Batch and displayed into your dashboard.
appendBatchData(Bundle, Intent) - Static method in class com.batch.android.Batch.Push: Append Batch data to your open intent so that opens from this push will be tracked by Batch and displayed into your dashboard.
appendBatchData(RemoteMessage, Intent) - Static method in class com.batch.android.Batch.Push: Append Batch data to your open intent so that opens from this push will be tracked by Batch and displayed into your dashboard.
array() - Method in class com.batch.android.json.JSONStringer: Begins encoding a new array.

B

back() - Method in class com.batch.android.json.JSONTokener: Unreads the most recent character of input.
BANNER - Enum constant in enum class com.batch.android.BatchMessage.Format: BANNER is a banner that can be attached on top or bottom of your screen
Batch - Class in com.batch.android: Entry point of the Batch library
Batch.Actions - Class in com.batch.android: Batch Action manager
Batch.Debug - Class in com.batch.android: Batch Debug module
Batch.EventDispatcher - Class in com.batch.android: Batch EventDispatcher module
Batch.EventDispatcher.Payload - Interface in com.batch.android: Accessor to the payload of the dispatched event in BatchEventDispatcher#dispatchEvent(Type, Payload).
Batch.EventDispatcher.Type - Enum Class in com.batch.android: Represents the type of the dispatched event in BatchEventDispatcher#dispatchEvent(Type, Payload).
Batch.Inbox - Class in com.batch.android: Batch Inbox module
Batch.Messaging - Class in com.batch.android: Batch Messaging module
Batch.Messaging.DisplayHint - Class in com.batch.android
Batch.Messaging.DisplayHintProvider - Interface in com.batch.android
Batch.Messaging.LifecycleListener - Interface in com.batch.android: Listener interface for messaging views lifecycle events.
Batch.Messaging.LifecycleListener2 - Interface in com.batch.android: Listener interface for messaging events.
Batch.Push - Class in com.batch.android: Batch Push module
Batch.User - Class in com.batch.android: Batch User module
BatchActionActivity - Class in com.batch.android: Dummy activity that starts BatchActionService or opens a deeplink
BatchActionActivity() - Constructor for class com.batch.android.BatchActionActivity
BatchActionService - Class in com.batch.android: Service that Batch uses to respond to actions when not in an activity
BatchActionService() - Constructor for class com.batch.android.BatchActionService
BatchActivityLifecycleHelper - Class in com.batch.android: Implementation of Application.ActivityLifecycleCallbacks for managing Batch's lifecycle
BatchActivityLifecycleHelper() - Constructor for class com.batch.android.BatchActivityLifecycleHelper
BatchAlertContent - Class in com.batch.android: Model for the content of an Alert In-App/Landing message
BatchAlertContent.CTA - Class in com.batch.android
BatchAttributesFetchListener - Interface in com.batch.android: Listener used when fetching attributes using Batch.User#fetchAttributes(Context, BatchAttributesFetchListener).
BatchBannerContent - Class in com.batch.android: Model for the content of a Banner In-App/Landing message
BatchBannerContent.Action - Class in com.batch.android
BatchBannerContent.CTA - Class in com.batch.android
BatchBannerView - Class in com.batch.android: BatchBannerView handles operations related to a Batch In-App Messaging banner, when used in manual mode.
BatchDeeplinkInterceptor - Interface in com.batch.android: Abstract class describing a deeplink interceptor.
BatchDisplayReceiptJobService - Class in com.batch.android: JobService implementation of Batch Display Receipt
BatchDisplayReceiptJobService() - Constructor for class com.batch.android.BatchDisplayReceiptJobService
BatchEmailSubscriptionState - Enum Class in com.batch.android: Enum defining the state of an email subscription
BatchEventData - Class in com.batch.android: Object holding data to be associated to an event Keys should be made of letters, numbers or underscores ([a-z0-9_]) and can't be longer than 30 characters.
BatchEventData() - Constructor for class com.batch.android.BatchEventData
BatchEventDispatcher - Interface in com.batch.android: Interface used when listening for event to dispatch.
BatchImageContent - Class in com.batch.android: Model for the content of an image-only message
BatchImageContent.Action - Class in com.batch.android
BatchInAppMessage - Class in com.batch.android: A subclass of BatchMessage that represents an In-App message
BatchInAppMessage(String, String, JSONObject, JSONObject, JSONObject) - Constructor for class com.batch.android.BatchInAppMessage
BatchInAppMessage.Content - Interface in com.batch.android: Interface defining a BatchInAppMessage content model object.
BatchInboxFetcher - Class in com.batch.android: BatchInboxFetcher allows you to fetch notifications that have been sent to a user (or installation, more on that later) in their raw form, allowing you to display them in a list, for example.
BatchInboxFetcher.OnNewNotificationsFetchedListener - Interface in com.batch.android
BatchInboxFetcher.OnNextPageFetchedListener - Interface in com.batch.android
BatchInboxNotificationContent - Class in com.batch.android: BatchInboxNotificationContent is a model representing the content of an inbox notification
BatchInterstitialContent - Class in com.batch.android: Model for the content of an Interstitial In-App/Landing message
BatchInterstitialContent.CTA - Class in com.batch.android
BatchLandingMessage - Class in com.batch.android: A subclass of BatchMessage that represents a push landing message
BatchLandingMessage(Bundle, JSONObject) - Constructor for class com.batch.android.BatchLandingMessage
BatchMessage - Class in com.batch.android: Model representing a Batch Messaging message.
BatchMessage() - Constructor for class com.batch.android.BatchMessage
BatchMessage.Format - Enum Class in com.batch.android: Formats that can be contained into a BatchMessage.
BatchMessageAction - Class in com.batch.android: Represents a BatchAction triggerable by a messaging component
BatchMessageCTA - Class in com.batch.android: Represents a BatchAction triggerable by a basic CTA messaging component
BatchMessagingException - Exception in com.batch.android: Batch Messaging Exception.
BatchMessagingException() - Constructor for exception com.batch.android.BatchMessagingException
BatchMessagingException(String) - Constructor for exception com.batch.android.BatchMessagingException
BatchMessagingException(String, Throwable) - Constructor for exception com.batch.android.BatchMessagingException
BatchMessagingException(Throwable) - Constructor for exception com.batch.android.BatchMessagingException
BatchMessagingWebViewJavascriptBridge - Class in com.batch.android: Class providing method implementation for the In-App Webview javascript SDK.
BatchModalContent - Class in com.batch.android: Model for the content of a modal message
BatchModalContent.Action - Class in com.batch.android
BatchModalContent.CTA - Class in com.batch.android
BatchNotificationAction - Class in com.batch.android: Represents a Notification Action button
BatchNotificationAction() - Constructor for class com.batch.android.BatchNotificationAction
BatchNotificationChannelsManager - Class in com.batch.android: BatchNotificationChannelsManager manages how Batch interacts with Android 8.0 (API 26).
BatchNotificationChannelsManager.ChannelNameProvider - Interface in com.batch.android: Interface describing a channel name provider.
BatchNotificationChannelsManager.NotificationChannelIdInterceptor - Interface in com.batch.android: Interface describing a channel ID interceptor for notifications displayed by Batch
BatchNotificationChannelsManager.StringResChannelNameProvider - Class in com.batch.android: Implementation of ChannelNameProvider using a String resource to automatically fetch the right translation.
BatchNotificationInterceptor - Class in com.batch.android: Abstract class describing a notification interceptor.
BatchNotificationInterceptor() - Constructor for class com.batch.android.BatchNotificationInterceptor
BatchNotificationSource - Enum Class in com.batch.android: BatchNotificationSource represents how the push was sent from Batch: via the Transactional API, or using a Push Campaign The value might be unknown for forward compatibility, or if the information was missing.
BatchOptOutResultListener - Interface in com.batch.android: Interface describing a listener for server-side Opt-Out/Opt-Out and wipe acknowledgment
BatchOptOutResultListener.ErrorPolicy - Enum Class in com.batch.android
BatchPermissionActivity - Class in com.batch.android: Dummy activity that ask a runtime permission to the user
BatchPermissionActivity() - Constructor for class com.batch.android.BatchPermissionActivity
BatchPushData - Class in com.batch.android: Deprecated.
Use BatchPushPayload
BatchPushData(Context, Intent) - Constructor for class com.batch.android.BatchPushData: Deprecated.
BatchPushInstanceIDService - Class in com.batch.android: Batch's service for handling Google's Instance ID token refresh
BatchPushInstanceIDService() - Constructor for class com.batch.android.BatchPushInstanceIDService
BatchPushJobService - Class in com.batch.android: JobService implementation of Batch Push
BatchPushJobService() - Constructor for class com.batch.android.BatchPushJobService
BatchPushMessageDismissReceiver - Class in com.batch.android: Batch's implementation of dismiss intent of push notification
BatchPushMessageDismissReceiver() - Constructor for class com.batch.android.BatchPushMessageDismissReceiver
BatchPushMessageReceiver - Class in com.batch.android: Batch's implementation of FCM's Push BroadcastReceiver
BatchPushMessageReceiver() - Constructor for class com.batch.android.BatchPushMessageReceiver
BatchPushPayload - Class in com.batch.android: Convenience object to retrieve standardized Batch data out of a Batch Push intent.
This class does not have a public constructor.
BatchPushPayload.ParsingException - Exception in com.batch.android: Represents a payload parsing exception.
BatchPushReceiver - Class in com.batch.android: Batch's legacy implementation of GCM's Push BroadcastReceiver
BatchPushReceiver() - Constructor for class com.batch.android.BatchPushReceiver
BatchPushService - Class in com.batch.android: Batch's service for handling the push messages and show a notification
BatchPushService() - Constructor for class com.batch.android.BatchPushService
BatchTagCollectionsFetchListener - Interface in com.batch.android: Listener used when fetching tag collections using Batch.User#fetchTagCollections(Context, BatchTagCollectionsFetchListener).
BatchUserAttribute - Class in com.batch.android
BatchUserAttribute(Object, BatchUserAttribute.Type) - Constructor for class com.batch.android.BatchUserAttribute
BatchUserAttribute.Type - Enum Class in com.batch.android
BatchUserDataEditor - Class in com.batch.android: Batch User data editor
BatchUserProfile - Class in com.batch.android: Deprecated.
Please use Batch.User methods instead
BatchWebViewContent - Class in com.batch.android: Model for the content of an WebView message
BODY_KEY - Static variable in class com.batch.android.Batch.Push: Key to retrieve the body of a push message
BOOL - Enum constant in enum class com.batch.android.BatchUserAttribute.Type
BROADCAST_PERMISSION_SUFFIX - Static variable in class com.batch.android.Batch: Permission suffix for broadcasts triggered by Batch.

C

CAMPAIGN - Enum constant in enum class com.batch.android.BatchNotificationSource
CANCEL - Enum constant in enum class com.batch.android.BatchOptOutResultListener.ErrorPolicy: Cancel the opt-out: please call the opt-out method again to retry.
canLog(LoggerLevel) - Method in enum class com.batch.android.LoggerLevel
checkAvailability() - Method in interface com.batch.android.AdsIdentifierProvider: Deprecated.
checkLibraryAvailability() - Method in interface com.batch.android.PushRegistrationProvider: Is this provider implemented in the app? This is the place to check if the libraries are here at runtime and if the user enabled/disabled your provider.
checkServiceAvailability() - Method in interface com.batch.android.PushRegistrationProvider: Is this provider installed on the device? This is the place to check if the service is installed on the device and if its version match the feature we need.
clearAttributes() - Method in class com.batch.android.BatchUserDataEditor: Removes all attributes.
clearTagCollection(String) - Method in class com.batch.android.BatchUserDataEditor: Removes all tags from a collection.
clearTags() - Method in class com.batch.android.BatchUserDataEditor: Removes all tags.
com.batch.android - package com.batch.android
com.batch.android.json - package com.batch.android.json
completeWakefulIntent(Intent) - Static method in class com.batch.android.BatchPushMessageDismissReceiver: Finish the execution from a previous BatchPushMessageDismissReceiver.startWakefulService(android.content.Context, android.content.Intent).
completeWakefulIntent(Intent) - Static method in class com.batch.android.BatchPushMessageReceiver: Finish the execution from a previous BatchPushMessageReceiver.startWakefulService(android.content.Context, android.content.Intent).
completeWakefulIntent(Intent) - Static method in class com.batch.android.BatchPushReceiver: Finish the execution from a previous BatchPushReceiver.startWakefulService(android.content.Context, android.content.Intent).
Config - Class in com.batch.android: Class to build a configuration for Batch SDK
Config(String) - Constructor for class com.batch.android.Config
copyBatchExtras(Intent, Intent) - Static method in class com.batch.android.Batch: Copy Batch's internal data from an intent to another.
copyBatchExtras(Bundle, Bundle) - Static method in class com.batch.android.Batch: Copy Batch's internal data from intent extras to another bundle.

D

DATE - Enum constant in enum class com.batch.android.BatchUserAttribute.Type
DEACTIVATED_API_KEY - Enum constant in enum class com.batch.android.FailReason: Your API key has been deactivated
debug(String, String, Throwable) - Method in interface com.batch.android.LoggerDelegate: Send a Log.DEBUG log message.
DEFAULT_CHANNEL_ID - Static variable in class com.batch.android.BatchNotificationChannelsManager
DEFAULT_PLACEMENT - Static variable in class com.batch.android.Batch: Default placement
dehexchar(char) - Static method in class com.batch.android.json.JSONTokener: Returns the integer [0..15] value for the given hex character, or -1 for non-hex input.
dismiss(boolean) - Method in class com.batch.android.BatchBannerView: Dismiss the banner if it's still on screen.
dismissNotifications() - Static method in class com.batch.android.Batch.Push: Dismiss all notifications shown by the application.

You should call this method after have other notifications in your app.
dispatchEvent(Batch.EventDispatcher.Type, Batch.EventDispatcher.Payload) - Method in interface com.batch.android.BatchEventDispatcher: Callback when a new events just happened in the Batch SDK
displayLandingMessage(Context) - Method in class com.batch.android.BatchInboxNotificationContent: Display the landing message attached to a BatchInboxNotificationContent.
displayNotification(Context, Intent) - Static method in class com.batch.android.Batch.Push: Call this method to display the notification for this intent.
displayNotification(Context, Intent, boolean) - Static method in class com.batch.android.Batch.Push: Call this method to display the notification for this intent.
displayNotification(Context, Intent, BatchNotificationInterceptor) - Static method in class com.batch.android.Batch.Push: Call this method to display the notification for this intent.
displayNotification(Context, Intent, BatchNotificationInterceptor, boolean) - Static method in class com.batch.android.Batch.Push: Call this method to display the notification for this intent.
displayNotification(Context, RemoteMessage) - Static method in class com.batch.android.Batch.Push: Call this method to display the notification for this message.
displayNotification(Context, RemoteMessage, BatchNotificationInterceptor) - Static method in class com.batch.android.Batch.Push: Call this method to display the notification for this message.
DOUBLE - Enum constant in enum class com.batch.android.BatchUserAttribute.Type
drawableName - Variable in class com.batch.android.BatchNotificationAction: CTA Drawable name.

E

editor() - Static method in class com.batch.android.Batch.User: Get the user data editor.
embed(FrameLayout) - Static method in class com.batch.android.Batch.Messaging.DisplayHint: Embed display hint: Batch will embed the banner in the given FrameLayout, no questions asked.
embed(FrameLayout) - Method in class com.batch.android.BatchBannerView: Shows the banner in the given layout.
endArray() - Method in class com.batch.android.json.JSONStringer: Ends encoding the current array.
endObject() - Method in class com.batch.android.json.JSONStringer: Ends encoding the current object.
equals(Object) - Method in class com.batch.android.json.JSONArray
error(String, String, Throwable) - Method in interface com.batch.android.LoggerDelegate: Send a Log.ERROR log message.
ERROR - Enum constant in enum class com.batch.android.LoggerLevel
EXTRA_DEEPLINK_KEY - Static variable in class com.batch.android.BatchActionActivity
EXTRA_PERMISSION - Static variable in class com.batch.android.BatchPermissionActivity
EXTRA_REDIRECT_SETTINGS - Static variable in class com.batch.android.BatchPermissionActivity
EXTRA_REGISTRATION_IDENTIFIER - Static variable in class com.batch.android.Batch: Extra containing the Registration Identifier for a Batch.ACTION_REGISTRATION_IDENTIFIER_OBTAINED broadcast
EXTRA_REGISTRATION_PROVIDER_NAME - Static variable in class com.batch.android.Batch: Extra containing the Registration Provider name for a Batch.ACTION_REGISTRATION_IDENTIFIER_OBTAINED broadcast
EXTRA_REGISTRATION_SENDER_ID - Static variable in class com.batch.android.Batch: Extra containing the Sender ID (if any) for a Batch.ACTION_REGISTRATION_IDENTIFIER_OBTAINED broadcast
EXTRA_RESULT - Static variable in class com.batch.android.BatchPermissionActivity

F

FailReason - Enum Class in com.batch.android: Reason for Batch failure
fetchAttributes(Context, BatchAttributesFetchListener) - Static method in class com.batch.android.Batch.User: Read the saved attributes.
fetchNewNotifications(BatchInboxFetcher.OnNewNotificationsFetchedListener) - Method in class com.batch.android.BatchInboxFetcher: Fetch new notifications.
While BatchInboxFetcher.fetchNextPage(com.batch.android.BatchInboxFetcher.OnNextPageFetchedListener) is used to fetch older notifications than the ones currently loaded, this method checks for new notifications.
fetchNextPage(BatchInboxFetcher.OnNextPageFetchedListener) - Method in class com.batch.android.BatchInboxFetcher: Fetch a page of notifications.
Calling this method when no messages have been loaded will be equivalent to calling BatchInboxFetcher.fetchNewNotifications(com.batch.android.BatchInboxFetcher.OnNewNotificationsFetchedListener)
Warning: callbacks might not be called on the thread you're expecting.
fetchTagCollections(Context, BatchTagCollectionsFetchListener) - Static method in class com.batch.android.Batch.User: Read the saved tag collections.
findUsingView(View) - Static method in class com.batch.android.Batch.Messaging.DisplayHint: Automatically find an appropriate container: Batch will use the given view as a base to walk up the view tree until it reaches the window's content view, or a CoordinatorLayout.
finish() - Method in class com.batch.android.MessagingActivity
fromValue(int) - Static method in enum class com.batch.android.PushNotificationType
FULLSCREEN - Enum constant in enum class com.batch.android.BatchMessage.Format: FULLSCREEN is the fullscreen format

G

get(int) - Method in class com.batch.android.json.JSONArray

Returns the value at index.

get(String) - Method in class com.batch.android.json.JSONObject

Returns the value mapped by name, or throws if no such mapping exists.

getAcceptCTA() - Method in class com.batch.android.BatchAlertContent

getAction() - Method in class com.batch.android.BatchAlertContent.CTA

getAction() - Method in class com.batch.android.BatchBannerContent.Action

getAction() - Method in class com.batch.android.BatchImageContent.Action

getAction() - Method in class com.batch.android.BatchInterstitialContent.CTA

getAction() - Method in class com.batch.android.BatchMessageAction

getAction() - Method in class com.batch.android.BatchModalContent.Action

getActions() - Method in class com.batch.android.BatchPushPayload

Get the actions associated with this push, if any.

getAdsIdentifier(AdsIdentifierProvider.AdsIdentifierListener) - Method in interface com.batch.android.AdsIdentifierProvider

Deprecated.

getAPIKey() - Static method in class com.batch.android.Batch

Return the api key
If you call this method before calling setConfig, it will return null

getArgs() - Method in class com.batch.android.BatchAlertContent.CTA

getArgs() - Method in class com.batch.android.BatchBannerContent.Action

getArgs() - Method in class com.batch.android.BatchImageContent.Action

getArgs() - Method in class com.batch.android.BatchInterstitialContent.CTA

getArgs() - Method in class com.batch.android.BatchMessageAction

getArgs() - Method in class com.batch.android.BatchModalContent.Action

getAutoCloseDelay() - Method in class com.batch.android.BatchImageContent

getAutoCloseTimeMillis() - Method in class com.batch.android.BatchBannerContent

getAutoCloseTimeMillis() - Method in class com.batch.android.BatchModalContent

getBatchMessageDisplayHint(BatchMessage) - Method in interface com.batch.android.Batch.Messaging.DisplayHintProvider

getBigPictureURL() - Method in class com.batch.android.BatchPushData

Deprecated.

getBigPictureURL(Context) - Method in class com.batch.android.BatchPushPayload

Get the big picture url contained in this push.
You should always check if the push contains a big picture using BatchPushPayload.hasBigPicture().

The url returned by this method is already optimized for the device, you have to download the image and use it in the notification

getBody() - Method in class com.batch.android.BatchAlertContent

getBody() - Method in class com.batch.android.BatchBannerContent

getBody() - Method in class com.batch.android.BatchInboxNotificationContent

getBody() - Method in class com.batch.android.BatchInterstitialContent

getBody() - Method in class com.batch.android.BatchModalContent

getBoolean(int) - Method in class com.batch.android.json.JSONArray

Returns the value at index if it exists and is a boolean or can be coerced to a boolean.

getBoolean(String) - Method in class com.batch.android.json.JSONObject

Returns the value mapped by name if it exists and is a boolean or can be coerced to a boolean, or throws otherwise.

getBooleanValue() - Method in class com.batch.android.BatchUserAttribute

getBroadcastPermissionName(Context) - Static method in class com.batch.android.Batch

Get the broadcast permission name.

getBundleRepresentation() - Method in class com.batch.android.BatchInAppMessage

getBundleRepresentation() - Method in class com.batch.android.BatchLandingMessage

getBundleRepresentation() - Method in class com.batch.android.BatchMessage

getCampaignToken() - Method in class com.batch.android.BatchInAppMessage

Get the campaign token.

getCancelLabel() - Method in class com.batch.android.BatchAlertContent

getChannel() - Method in class com.batch.android.BatchPushPayload

Get the desired notification channel.

getChannelId(BatchPushPayload, String) - Method in interface com.batch.android.BatchNotificationChannelsManager.NotificationChannelIdInterceptor

Method that should return the notification channel id that should be Note that it might be called on any API level, even ones lower than Build.VERSION_CODES.O.

getChannelsManager() - Static method in class com.batch.android.Batch.Push

Get the channels manager, allowing you to tweak how notifications will behave regarding the channels feature introduced in Android 8.0 (API 26)

getContent() - Method in class com.batch.android.BatchInAppMessage

Get an In-App Message's visual contents.

getCtas() - Method in class com.batch.android.BatchBannerContent

getCtas() - Method in class com.batch.android.BatchInterstitialContent

getCtas() - Method in class com.batch.android.BatchModalContent

getCustomID() - Method in class com.batch.android.BatchUserProfile

Deprecated.
Please use Batch.User methods instead

getCustomLargeIconURL() - Method in class com.batch.android.BatchPushData

Deprecated.

getCustomLargeIconURL(Context) - Method in class com.batch.android.BatchPushPayload

Get the custom large icon url contained in this push.
You should always check if the push contains a custom large icon using BatchPushPayload.hasCustomLargeIcon().

The url returned by this method is already optimized for the device, you have to download the image and use it in the notification

getCustomPayload() - Method in class com.batch.android.BatchInAppMessage

getCustomPayload() - Method in interface com.batch.android.InAppMessageUserActionSource

getCustomValue(String) - Method in interface com.batch.android.Batch.EventDispatcher.Payload

Get a value from a key within the custom payload associated with the event.

getDate() - Method in class com.batch.android.BatchInboxNotificationContent

getDateValue() - Method in class com.batch.android.BatchUserAttribute

getDeeplink() - Method in interface com.batch.android.Batch.EventDispatcher.Payload

Get the deeplink url associated with the event.

getDeeplink() - Method in class com.batch.android.BatchPushData

Deprecated.

getDeeplink() - Method in class com.batch.android.BatchPushPayload

Get the deeplink url contained in this push.
You should always check if the push contains a deeplink using BatchPushPayload.hasDeeplink()

getDefaultChannelName() - Method in interface com.batch.android.BatchNotificationChannelsManager.ChannelNameProvider

The user-facing channel name to return to the system.
If this method throws an exception, Batch will use its default name.

getDefaultChannelName() - Method in class com.batch.android.BatchNotificationChannelsManager.StringResChannelNameProvider

getDouble(int) - Method in class com.batch.android.json.JSONArray

Returns the value at index if it exists and is a double or can be coerced to a double.

getDouble(String) - Method in class com.batch.android.json.JSONObject

Returns the value mapped by name if it exists and is a double or can be coerced to a double, or throws otherwise.

getEditor() - Static method in class com.batch.android.Batch.User

Deprecated.
Use Batch.User.editor()

getFallbackIntent(Context) - Method in interface com.batch.android.BatchDeeplinkInterceptor

Called as a fallback when a previous task stack builder or intent could not be launched.

getFetchedNotifications() - Method in class com.batch.android.BatchInboxFetcher

Returns a copy of all notifications that have been fetched until now, ordered by reverse chronological order (meaning that the first message is the newest one, and the last one the oldest).

getFetcher(Context) - Static method in class com.batch.android.Batch.Inbox

Get an inbox fetcher based on the current installation ID.

getFetcher(Context, String, String) - Static method in class com.batch.android.Batch.Inbox

Get an inbox fetcher for the specified user identifier.

getFetcher(String, String) - Static method in class com.batch.android.Batch.Inbox

Deprecated.
Use getFetcher(Context,String,String), which is more reliable

getFormat() - Method in class com.batch.android.BatchMessage

Returns the format of the displayable message, if any.

getGCPProjectID() - Method in interface com.batch.android.PushRegistrationProvider

Returns the GCP Project ID.

getGlobalTapAction() - Method in class com.batch.android.BatchBannerContent

getGlobalTapAction() - Method in class com.batch.android.BatchImageContent

getGlobalTapAction() - Method in class com.batch.android.BatchModalContent

getGlobalTapDelay() - Method in class com.batch.android.BatchImageContent

getGroup() - Method in class com.batch.android.BatchPushPayload

Get the notification group name.

getHeader() - Method in class com.batch.android.BatchInterstitialContent

getIdentifier() - Method in class com.batch.android.UserAction

getIdentifier(Context) - Static method in class com.batch.android.Batch.User

Read the custom identifier.

getImageDescription() - Method in class com.batch.android.BatchImageContent

getImageSize() - Method in class com.batch.android.BatchImageContent

getImageURL() - Method in class com.batch.android.BatchImageContent

getInstallationID() - Static method in class com.batch.android.Batch.User

Get the unique installation ID, generated by Batch.

getInt(int) - Method in class com.batch.android.json.JSONArray

Returns the value at index if it exists and is an int or can be coerced to an int.

getInt(String) - Method in class com.batch.android.json.JSONObject

Returns the value mapped by name if it exists and is an int or can be coerced to an int, or throws otherwise.

getIntent(Context, String) - Method in interface com.batch.android.BatchDeeplinkInterceptor

Called when a deeplink is triggered by Batch (could be from a push notification or an in-app message).

getJSON() - Method in class com.batch.android.BatchInAppMessage

getJSON() - Method in class com.batch.android.BatchLandingMessage

getJSON() - Method in class com.batch.android.BatchMessage

getJSONArray(int) - Method in class com.batch.android.json.JSONArray

Returns the value at index if it exists and is a JSONArray.

getJSONArray(String) - Method in class com.batch.android.json.JSONObject

Returns the value mapped by name if it exists and is a JSONArray, or throws otherwise.

getJSONObject(int) - Method in class com.batch.android.json.JSONArray

Returns the value at index if it exists and is a JSONObject.

getJSONObject(String) - Method in class com.batch.android.json.JSONObject

Returns the value mapped by name if it exists and is a JSONObject, or throws otherwise.

getKind() - Method in class com.batch.android.BatchInAppMessage

getKind() - Method in class com.batch.android.BatchLandingMessage

getKind() - Method in class com.batch.android.BatchMessage

getLabel() - Method in class com.batch.android.BatchAlertContent.CTA

getLabel() - Method in class com.batch.android.BatchBannerContent.CTA

getLabel() - Method in class com.batch.android.BatchInterstitialContent.CTA

getLabel() - Method in class com.batch.android.BatchMessageCTA

getLabel() - Method in class com.batch.android.BatchModalContent.CTA

getLandingMessage() - Method in class com.batch.android.BatchPushPayload

Returns the landing message that's in this payload if there is one.

getLanguage() - Method in class com.batch.android.BatchUserProfile

Deprecated.
Please use Batch.User methods instead

getLanguage(Context) - Static method in class com.batch.android.Batch.User

Read the language.

getLastKnownPushToken() - Static method in class com.batch.android.Batch.Push

Get the last known push token.

getLoggerLevel() - Static method in class com.batch.android.Batch

Get the current logger level

getLong(int) - Method in class com.batch.android.json.JSONArray

Returns the value at index if it exists and is a long or can be coerced to a long.

getLong(String) - Method in class com.batch.android.json.JSONObject

Returns the value mapped by name if it exists and is a long or can be coerced to a long, or throws otherwise.

getMediaAccessibilityDescription() - Method in class com.batch.android.BatchBannerContent

getMediaAccessibilityDescription() - Method in class com.batch.android.BatchInterstitialContent

getMediaAccessibilityDescription() - Method in class com.batch.android.BatchModalContent

getMediaURL() - Method in class com.batch.android.BatchBannerContent

getMediaURL() - Method in class com.batch.android.BatchInterstitialContent

getMediaURL() - Method in class com.batch.android.BatchModalContent

getMessageForBundle(Bundle) - Static method in class com.batch.android.BatchMessage

getMessagingPayload() - Method in interface com.batch.android.Batch.EventDispatcher.Payload

Get the raw payload associated with the event

getName() - Method in interface com.batch.android.BatchEventDispatcher

Get the name of the dispatcher This information is only used for analytics /!\ `default` method can lead to an AbstractMethodError if java 8 language features are not available (api < 24).

getNotificationIdentifier() - Method in class com.batch.android.BatchInboxNotificationContent

Unique identifier for this notification.

getNotificationsType(Context) - Static method in class com.batch.android.Batch.Push

Get the enabled notification types
Matches what you've set in setNotificationsType.

getNumberValue() - Method in class com.batch.android.BatchUserAttribute

getPriority() - Method in class com.batch.android.BatchPushPayload

Deprecated.
Since Android 8.0, "priority" became "importance", and is now set on the channel itself. You should infer the priority from the channel, using BatchPushPayload.getChannel()

getPushBundle() - Method in class com.batch.android.BatchLandingMessage

getPushBundle() - Method in class com.batch.android.BatchPushPayload

Get the raw push bundle

getPushBundle() - Method in interface com.batch.android.PushUserActionSource

getPushNotificationCompatBuilder(Context, NotificationCompat.Builder, Bundle, int) - Method in class com.batch.android.BatchNotificationInterceptor

Get the builder instance used to generate the notification.
If you're basing your builder on defaultBuilder, some methods might have undefined behaviour as Batch already calls many of them.
Likewise, returning another instance of the builder than defaultBuilder's might result in loss of functionality if not reimplemented.

getPushNotificationId(Context, int, Bundle) - Method in class com.batch.android.BatchNotificationInterceptor

Notification Id to use when posting the notification to the system.

getPushPayload() - Method in interface com.batch.android.Batch.EventDispatcher.Payload

Get the raw payload associated with the event

getPushPayload() - Method in class com.batch.android.BatchInboxNotificationContent

Get BatchPushPayload instance, property initialized with the notification's original push payload

getRawPayload() - Method in class com.batch.android.BatchInboxNotificationContent

Get the payload in its raw JSON form.

getRegion() - Method in class com.batch.android.BatchUserProfile

Deprecated.
Please use Batch.User methods instead

getRegion(Context) - Static method in class com.batch.android.Batch.User

Read the region.

getRegistration() - Method in interface com.batch.android.PushRegistrationProvider

Returns the registration if possible.

getRunnable() - Method in class com.batch.android.UserAction

getSenderID() - Method in interface com.batch.android.PushRegistrationProvider

Returns the Sender ID of the provider, or equivalent.

getSessionID() - Static method in class com.batch.android.Batch

Get the id of the current session, random uuid used internaly by Batch to identify the app session.

getShortname() - Method in interface com.batch.android.PushRegistrationProvider

Returns the short name of the provider.

getSource() - Method in class com.batch.android.BatchInboxNotificationContent

getString(int) - Method in class com.batch.android.json.JSONArray

Returns the value at index if it exists, coercing it if necessary.

getString(String) - Method in class com.batch.android.json.JSONObject

Returns the value mapped by name if it exists, coercing it if necessary, or throws if no such mapping exists.

getStringValue() - Method in class com.batch.android.BatchUserAttribute

getSupportActions(Context, List<BatchNotificationAction>, BatchPushPayload, Integer) - Static method in class com.batch.android.BatchNotificationAction

Converts BatchNotificationAction instances to NotificationCompat.Action, allowing you to add actions to a Notification the same way the SDK internally does it, taking care of all the boilerplate.

getTaskStackBuilder(Context, String) - Method in interface com.batch.android.BatchDeeplinkInterceptor

Called when a deeplink is triggered by Batch (only called from a push notification).

getTitle() - Method in class com.batch.android.BatchAlertContent

getTitle() - Method in class com.batch.android.BatchBannerContent

getTitle() - Method in class com.batch.android.BatchInboxNotificationContent

getTitle() - Method in class com.batch.android.BatchInterstitialContent

getTitle() - Method in class com.batch.android.BatchModalContent

getTrackingId() - Method in interface com.batch.android.Batch.EventDispatcher.Payload

Get the tracking ID associated with the event.

getTrackingIdentifier() - Method in class com.batch.android.BatchAlertContent

getTrackingIdentifier() - Method in class com.batch.android.BatchBannerContent

getTrackingIdentifier() - Method in class com.batch.android.BatchInterstitialContent

getTrackingIdentifier() - Method in class com.batch.android.BatchModalContent

getUriValue() - Method in class com.batch.android.BatchUserAttribute

getURL() - Method in class com.batch.android.BatchWebViewContent

getUserProfile() - Static method in class com.batch.android.Batch

Deprecated.
Please use Batch.User methods instead

getVersion() - Method in interface com.batch.android.BatchEventDispatcher

Get the version of the dispatcher This information is only used for analytics /!\ `default` method can lead to an AbstractMethodError if java 8 language features are not available (api < 24).

getWebserviceIdsAsJson(Context) - Static method in class com.batch.android.WebserviceParameterUtils

Get webservice ids parameters as json object

getWebserviceIdsAsMap(Context) - Static method in class com.batch.android.WebserviceParameterUtils

Get webservice ids parameters as map

getWebViewAnalyticsID() - Method in interface com.batch.android.Batch.EventDispatcher.Payload

Get the button analytics ID associated with the event.

GLOBAL_TAP_ACTION_INDEX - Static variable in class com.batch.android.Batch.Messaging

CTA Index representing a global tap action

H

has(String) - Method in class com.batch.android.json.JSONObject

Returns true if this object has a mapping for name.

hasBigPicture() - Method in class com.batch.android.BatchPushData

Deprecated.

hasBigPicture() - Method in class com.batch.android.BatchPushPayload

Does this push contains a big picture

hasCustomLargeIcon() - Method in class com.batch.android.BatchPushData

Deprecated.

hasCustomLargeIcon() - Method in class com.batch.android.BatchPushPayload

Does this push contains a custom large icon

hasDeeplink() - Method in class com.batch.android.BatchPushData

Deprecated.

hasDeeplink() - Method in class com.batch.android.BatchPushPayload

Does this push contains a deeplink

hashCode() - Method in class com.batch.android.json.JSONArray

hasLandingMessage() - Method in class com.batch.android.BatchInboxNotificationContent

Whether the notification content has a landing message attached

hasLandingMessage() - Method in class com.batch.android.BatchPushPayload

Whether the payload contains a landing message or not

hasMore() - Method in class com.batch.android.BatchInboxFetcher

Returns whether all of the user or installation's notifications have been fetched.

hasNonNull(String) - Method in class com.batch.android.json.JSONObject

Returns true if this object has a mapping for name.

hasPendingMessage() - Static method in class com.batch.android.Batch.Messaging

Check if Batch currently has a pending message, without forgetting it.

hasUserInterface - Variable in class com.batch.android.BatchNotificationAction

Does this action imply showing any UI or will it act in the background? An action that has no UI should not close the notification drawer, but should still dismiss the notification itself (if asked to).

I

IGNORE - Enum constant in enum class com.batch.android.BatchOptOutResultListener.ErrorPolicy

Ignore the error and proceed with the opt-out.

IMAGE - Enum constant in enum class com.batch.android.BatchMessage.Format

IMAGE is a modal popup that simply shows an image in an alert (detached) or fullscreen (attached) style

InAppMessageUserActionSource - Interface in com.batch.android

Represents an In-App Message user action source.

info(String, String, Throwable) - Method in interface com.batch.android.LoggerDelegate

Send a Log.INFO log message.

INFO - Enum constant in enum class com.batch.android.LoggerLevel

INTERNAL - Enum constant in enum class com.batch.android.LoggerLevel

INVALID_API_KEY - Enum constant in enum class com.batch.android.FailReason

Your API key is invalid

isAllowSwipeToDismiss() - Method in class com.batch.android.BatchImageContent

isBatchPush(Intent) - Static method in class com.batch.android.Batch.Push

Check if the received push is a Batch one.

isBatchPush(RemoteMessage) - Static method in class com.batch.android.Batch.Push

Check if the received push is a Batch one.

isDeleted() - Method in class com.batch.android.BatchInboxNotificationContent

Deprecated.
You should refresh your copy of the data with getFetchedNotifications() after using markAsDeleted.

isDismissAction() - Method in class com.batch.android.BatchMessageAction

isDisplayedFromInbox() - Method in class com.batch.android.BatchLandingMessage

Whether this landing message has been triggered from an inbox notification through the method BatchInboxNotificationContent#displayLandingMessage.

isDoNotDisturbEnabled() - Static method in class com.batch.android.Batch.Messaging

Check if Batch Messaging is currently in Do Not Disturb mode

isFullscreen() - Method in class com.batch.android.BatchImageContent

isGroupSummary() - Method in class com.batch.android.BatchPushPayload

Get the notification group name.

isManualDisplayModeActivated() - Static method in class com.batch.android.Batch.Push

Get manual display mode for push notifications.

isMessagingEvent() - Method in enum class com.batch.android.Batch.EventDispatcher.Type

isNotificationEvent() - Method in enum class com.batch.android.Batch.EventDispatcher.Type

isNull(int) - Method in class com.batch.android.json.JSONArray

Returns true if this array has no value at index, or if its value is the null reference or JSONObject#NULL.

isNull(String) - Method in class com.batch.android.json.JSONObject

Returns true if this object has no mapping for name or if it has a mapping whose value is JSONObject.NULL.

isOptedOut(Context) - Static method in class com.batch.android.Batch

Returns whether Batch has been opted out from or not

isPositiveAction() - Method in interface com.batch.android.Batch.EventDispatcher.Payload

Indicate if the action associated with the event is positive.

isRunningInDevMode() - Static method in class com.batch.android.Batch

Deprecated.
This method is not needed, since all DEV API Keys start with "DEV".

isShowCloseButton() - Method in class com.batch.android.BatchBannerContent

isShowCloseButton() - Method in class com.batch.android.BatchModalContent

isSilent() - Method in class com.batch.android.BatchInboxNotificationContent

Returns whether Batch considers this a silent notification.

isUnread() - Method in class com.batch.android.BatchInboxNotificationContent

J

JOB_EXTRA_PUSH_DATA_KEY - Static variable in class com.batch.android.BatchPushJobService

join(String) - Method in class com.batch.android.json.JSONArray

Returns a new string by alternating this array's values with separator.

JSONArray - Class in com.batch.android.json

A dense indexed sequence of values.

JSONArray() - Constructor for class com.batch.android.json.JSONArray

Creates a JSONArray with no values.

JSONArray(JSONTokener) - Constructor for class com.batch.android.json.JSONArray

Creates a new JSONArray with values from the next array in the tokener.

JSONArray(Object) - Constructor for class com.batch.android.json.JSONArray

Creates a new JSONArray with values from the given primitive array.

JSONArray(String) - Constructor for class com.batch.android.json.JSONArray

Creates a new JSONArray with values from the JSON string.

JSONArray(Collection) - Constructor for class com.batch.android.json.JSONArray

Creates a new JSONArray by copying all values from the given collection.

jsonArrayToArray(JSONArray) - Static method in class com.batch.android.json.JSONHelper

JSONException - Exception in com.batch.android.json

Thrown to indicate a problem with the JSON API.

JSONException(String) - Constructor for exception com.batch.android.json.JSONException

JSONHelper - Class in com.batch.android.json

Helper json methods that don't belong in JSON

JSONObject - Class in com.batch.android.json

A modifiable set of name/value mappings.

JSONObject() - Constructor for class com.batch.android.json.JSONObject

Creates a JSONObject with no name/value mappings.

JSONObject(JSONObject) - Constructor for class com.batch.android.json.JSONObject

Creates a new JSONObject by copying mappings for given object

JSONObject(JSONObject, String[]) - Constructor for class com.batch.android.json.JSONObject

Creates a new JSONObject by copying mappings for the listed names from the given object.

JSONObject(JSONTokener) - Constructor for class com.batch.android.json.JSONObject

Creates a new JSONObject with name/value mappings from the next object in the tokener.

JSONObject(String) - Constructor for class com.batch.android.json.JSONObject

Creates a new JSONObject with name/value mappings from the JSON string.

JSONObject(Map) - Constructor for class com.batch.android.json.JSONObject

Creates a new JSONObject by copying all name/value mappings from the given map.

jsonObjectToMap(JSONObject) - Static method in class com.batch.android.json.JSONHelper

jsonObjectToObject(Object) - Static method in class com.batch.android.json.JSONHelper

Transforms JSONObject and JSONArray to Map and Iterable If transformation is not needed, returns the original object.

JSONStringer - Class in com.batch.android.json

Implements JSONObject#toString and JSONArray#toString.

JSONStringer() - Constructor for class com.batch.android.json.JSONStringer

JSONTokener - Class in com.batch.android.json

Parses a JSON (RFC 4627) encoded string into the corresponding object.

JSONTokener(String) - Constructor for class com.batch.android.json.JSONTokener

K

key(String) - Method in class com.batch.android.json.JSONStringer

Encodes the key (property name) to this stringer.

keys() - Method in class com.batch.android.json.JSONObject

Returns an iterator of the String names in this object.

KIND - Static variable in class com.batch.android.BatchInAppMessage

KIND - Static variable in class com.batch.android.BatchLandingMessage

L

label - Variable in class com.batch.android.BatchNotificationAction

CTA label text

length() - Method in class com.batch.android.json.JSONArray

Returns the number of values in this array.

length() - Method in class com.batch.android.json.JSONObject

Returns the number of name/value mappings in this object.

LIGHTS - Enum constant in enum class com.batch.android.PushNotificationType

Add lights to the notification (if available on the device)

loadBanner(Context, BatchMessage) - Static method in class com.batch.android.Batch.Messaging

Load the BatchBannerView corresponding to the message payload.

loadFragment(Context, BatchMessage) - Static method in class com.batch.android.Batch.Messaging

Load the Fragment corresponding to the message payload.

LoggerDelegate - Interface in com.batch.android

Interface declaring methods that needs to be implemented for a Logger delegate.

LoggerLevel - Enum Class in com.batch.android

LONGLONG - Enum constant in enum class com.batch.android.BatchUserAttribute.Type

M

makePendingIntent(Context, Intent, Bundle) - Static method in class com.batch.android.Batch.Push

Make a PendingIntent suitable for notifications from a given Intent.

makePendingIntent(Context, Intent, RemoteMessage) - Static method in class com.batch.android.Batch.Push

Make a PendingIntent suitable for notifications from a given Intent.

makePendingIntentForDeeplink(Context, String, Bundle) - Static method in class com.batch.android.Batch.Push

Make a PendingIntent suitable for notifications from a given deeplink.

makePendingIntentForDeeplink(Context, String, RemoteMessage) - Static method in class com.batch.android.Batch.Push

Make a PendingIntent suitable for notifications from a given deeplink.

markAllAsRead() - Method in class com.batch.android.BatchInboxFetcher

Marks all notifications as read.

markAsDeleted(BatchInboxNotificationContent) - Method in class com.batch.android.BatchInboxFetcher

Mark a specific notification as deleted.

markAsRead(BatchInboxNotificationContent) - Method in class com.batch.android.BatchInboxFetcher

Mark a specific notification as read.

MESSAGING_AUTO_CLOSE - Enum constant in enum class com.batch.android.Batch.EventDispatcher.Type

MESSAGING_CLICK - Enum constant in enum class com.batch.android.Batch.EventDispatcher.Type

MESSAGING_CLOSE - Enum constant in enum class com.batch.android.Batch.EventDispatcher.Type

MESSAGING_CLOSE_ERROR - Enum constant in enum class com.batch.android.Batch.EventDispatcher.Type

MESSAGING_EXTRA_PAYLOAD_KEY - Static variable in class com.batch.android.BatchMessage

Key to retrieve the messaging payload (if applicable) from an extra

MESSAGING_SHOW - Enum constant in enum class com.batch.android.Batch.EventDispatcher.Type

MESSAGING_WEBVIEW_CLICK - Enum constant in enum class com.batch.android.Batch.EventDispatcher.Type

MessagingActivity - Class in com.batch.android

Activity that only lives to display a messaging fragment

MessagingActivity() - Constructor for class com.batch.android.MessagingActivity

MODAL - Enum constant in enum class com.batch.android.BatchMessage.Format

BANNER is a popup that takes over the screen modally, like a system alert but with a custom style

more() - Method in class com.batch.android.json.JSONTokener

Returns true until the input has been exhausted.

N

names() - Method in class com.batch.android.json.JSONObject

Returns an array containing the string names in this object.

NETWORK_ERROR - Enum constant in enum class com.batch.android.FailReason

Network is not available or not responding

next() - Method in class com.batch.android.json.JSONTokener

Returns the next available character, or the null character '\0' if all input has been exhausted.

next(char) - Method in class com.batch.android.json.JSONTokener

Returns the next available character if it equals c.

next(int) - Method in class com.batch.android.json.JSONTokener

Returns the next length characters of the input.

nextClean() - Method in class com.batch.android.json.JSONTokener

Returns the next character that is not whitespace and does not belong to a comment.

nextString(char) - Method in class com.batch.android.json.JSONTokener

Returns the string up to but not including quote, unescaping any character escape sequences encountered along the way.

nextTo(char) - Method in class com.batch.android.json.JSONTokener

Equivalent to nextTo(String.valueOf(excluded)).

nextTo(String) - Method in class com.batch.android.json.JSONTokener

Returns the trimmed string holding the characters up to but not including the first of: any character in excluded a newline character '\n' a carriage return '\r'

nextValue() - Method in class com.batch.android.json.JSONTokener

Returns the next value from the input.

NONE - Enum constant in enum class com.batch.android.PushNotificationType

Display no notification at all

NOTIFICATION_DISMISS - Enum constant in enum class com.batch.android.Batch.EventDispatcher.Type

NOTIFICATION_DISPLAY - Enum constant in enum class com.batch.android.Batch.EventDispatcher.Type

NOTIFICATION_OPEN - Enum constant in enum class com.batch.android.Batch.EventDispatcher.Type

NOTIFICATION_TAG - Static variable in class com.batch.android.Batch

Notification tag.

NULL - Static variable in class com.batch.android.json.JSONObject

A sentinel value used to explicitly define a name with no value.

numberToString(Number) - Static method in class com.batch.android.json.JSONObject

Encodes the number as a JSON string.

O

object() - Method in class com.batch.android.json.JSONStringer

Begins encoding a new object.

onActivityCreated(Activity, Bundle) - Method in class com.batch.android.BatchActivityLifecycleHelper

onActivityDestroyed(Activity) - Method in class com.batch.android.BatchActivityLifecycleHelper

onActivityPaused(Activity) - Method in class com.batch.android.BatchActivityLifecycleHelper

onActivityResumed(Activity) - Method in class com.batch.android.BatchActivityLifecycleHelper

onActivitySaveInstanceState(Activity, Bundle) - Method in class com.batch.android.BatchActivityLifecycleHelper

onActivityStarted(Activity) - Method in class com.batch.android.BatchActivityLifecycleHelper

onActivityStopped(Activity) - Method in class com.batch.android.BatchActivityLifecycleHelper

onBatchInAppMessageReady(BatchInAppMessage) - Method in interface com.batch.android.Batch.Messaging.LifecycleListener2

Called when an In-App Message is about to be displayed, giving a chance to cancel it and handle it manually.

onBatchMessageActionTriggered(String, int, BatchMessageAction) - Method in interface com.batch.android.Batch.Messaging.LifecycleListener

Called when the message view will be dismissed due to the user pressing a CTA or the global tap action.

onBatchMessageCancelledByAutoclose(String) - Method in interface com.batch.android.Batch.Messaging.LifecycleListener

Called when the message view will be dismissed due to the auto close timer running out

onBatchMessageCancelledByError(String) - Method in interface com.batch.android.Batch.Messaging.LifecycleListener

Called when the message view will be dismissed due to an error when loading the message's content.

onBatchMessageCancelledByUser(String) - Method in interface com.batch.android.Batch.Messaging.LifecycleListener

Called when the message view will be dismissed due to the user pressing the close button, or the system's Back button.

onBatchMessageClosed(String) - Method in interface com.batch.android.Batch.Messaging.LifecycleListener

Called when the message view disappeared from the screen.

onBatchMessageShown(String) - Method in interface com.batch.android.Batch.Messaging.LifecycleListener

Called when the message view appeared on screen.

onBatchMessageWebViewActionTriggered(String, String, BatchMessageAction) - Method in interface com.batch.android.Batch.Messaging.LifecycleListener

Called when the WebView message view will be dismissed due to the user navigating away or triggering an action (using the Javascript SDK).

onCreate(Activity) - Static method in class com.batch.android.Batch

Method to call on your main activity Activity#onCreate(Bundle).

onCreate(Bundle) - Method in class com.batch.android.BatchPermissionActivity

onCreate(Bundle) - Method in class com.batch.android.MessagingActivity

onDestroy() - Method in class com.batch.android.BatchActionActivity

onDestroy() - Method in class com.batch.android.BatchPermissionActivity

onDestroy() - Method in class com.batch.android.MessagingActivity

onDestroy(Activity) - Static method in class com.batch.android.Batch

Method to call on your main activity Activity#onDestroy()
Calling this method if Batch is already stopped or not started will do nothing

onDialogDismiss(DialogFragment) - Method in class com.batch.android.MessagingActivity

onError() - Method in interface com.batch.android.BatchAttributesFetchListener

onError() - Method in interface com.batch.android.BatchOptOutResultListener

onError() - Method in interface com.batch.android.BatchTagCollectionsFetchListener

onError(Exception) - Method in interface com.batch.android.AdsIdentifierProvider.AdsIdentifierListener

Deprecated.

onFetchFailure(String) - Method in interface com.batch.android.BatchInboxFetcher.OnNewNotificationsFetchedListener

onFetchFailure(String) - Method in interface com.batch.android.BatchInboxFetcher.OnNextPageFetchedListener

onFetchSuccess(List<BatchInboxNotificationContent>, boolean) - Method in interface com.batch.android.BatchInboxFetcher.OnNextPageFetchedListener

onFetchSuccess(List<BatchInboxNotificationContent>, boolean, boolean) - Method in interface com.batch.android.BatchInboxFetcher.OnNewNotificationsFetchedListener

onHandleIntent(Intent) - Method in class com.batch.android.BatchActionService

onHandleIntent(Intent) - Method in class com.batch.android.BatchPushService

onNewIntent(Activity, Intent) - Static method in class com.batch.android.Batch

Method to call on your main activity Activity#onNewIntent(Intent)
Calling this method if Batch is already stopped or not started will do nothing

onNotificationDisplayed(Context, Intent) - Static method in class com.batch.android.Batch.Push

Call this method when you just displayed a Batch push notification by yourself.

onNotificationDisplayed(Context, RemoteMessage) - Static method in class com.batch.android.Batch.Push

Call this method when you just displayed a Batch push notification by yourself.

onReceive(Context, Intent) - Method in class com.batch.android.BatchPushMessageDismissReceiver

onReceive(Context, Intent) - Method in class com.batch.android.BatchPushMessageReceiver

onReceive(Context, Intent) - Method in class com.batch.android.BatchPushReceiver

onRequestPermissionsResult(int, String[], int[]) - Method in class com.batch.android.BatchPermissionActivity

onSaveInstanceState(Bundle) - Method in class com.batch.android.MessagingActivity

onServiceCreate(Context, boolean) - Static method in class com.batch.android.Batch

Method to call on your service Service#onCreate() to start Batch.
You must call this method before any other on Batch.
Note that all Batch functionality is not available in this mode.

onServiceDestroy(Context) - Static method in class com.batch.android.Batch

Method to call on your service Service#onDestroy() to stop Batch.
Calling this method if Batch is already stopped or not started will do nothing

onStart() - Method in class com.batch.android.BatchActionActivity

onStart() - Method in class com.batch.android.BatchPermissionActivity

onStart() - Method in class com.batch.android.MessagingActivity

onStart(Activity) - Static method in class com.batch.android.Batch

Method to call on your main activity Activity#onStart() to start Batch and support URL scheme events.
You must call this method before any other on Batch.

Will fail and log an Error if Given activity is null You call it before calling Batch#setConfig(Config) Your app doesn't have android.permission.INTERNET permission

onStartJob(JobParameters) - Method in class com.batch.android.BatchDisplayReceiptJobService

onStartJob(JobParameters) - Method in class com.batch.android.BatchPushJobService

onStop() - Method in class com.batch.android.BatchActionActivity

onStop() - Method in class com.batch.android.BatchPermissionActivity

onStop() - Method in class com.batch.android.MessagingActivity

onStop(Activity) - Static method in class com.batch.android.Batch

Method to call on your main activity Activity#onStop()
Calling this method if Batch is already stopped or not started will do nothing

onStopJob(JobParameters) - Method in class com.batch.android.BatchDisplayReceiptJobService

onStopJob(JobParameters) - Method in class com.batch.android.BatchPushJobService

onSuccess() - Method in interface com.batch.android.BatchOptOutResultListener

onSuccess(String, boolean) - Method in interface com.batch.android.AdsIdentifierProvider.AdsIdentifierListener

Deprecated.

onSuccess(Map<String, BatchUserAttribute>) - Method in interface com.batch.android.BatchAttributesFetchListener

onSuccess(Map<String, Set<String>>) - Method in interface com.batch.android.BatchTagCollectionsFetchListener

onTokenRefresh() - Method in class com.batch.android.BatchPushInstanceIDService

openSystemChannelSettings(Context) - Static method in class com.batch.android.BatchNotificationChannelsManager

Opens the notification channel settings system UI for Batch's default channel.

openSystemChannelSettings(Context, String) - Static method in class com.batch.android.BatchNotificationChannelsManager

Opens the notification channel settings system UI for the specified channel

opt(int) - Method in class com.batch.android.json.JSONArray

Returns the value at index, or null if the array has no value at index.

opt(String) - Method in class com.batch.android.json.JSONObject

Returns the value mapped by name, or null if no such mapping exists.

optBoolean(int) - Method in class com.batch.android.json.JSONArray

Returns the value at index if it exists and is a boolean or can be coerced to a boolean.

optBoolean(int, boolean) - Method in class com.batch.android.json.JSONArray

Returns the value at index if it exists and is a boolean or can be coerced to a boolean.

optBoolean(String) - Method in class com.batch.android.json.JSONObject

Returns the value mapped by name if it exists and is a boolean or can be coerced to a boolean, or false otherwise.

optBoolean(String, boolean) - Method in class com.batch.android.json.JSONObject

Returns the value mapped by name if it exists and is a boolean or can be coerced to a boolean, or fallback otherwise.

optDouble(int) - Method in class com.batch.android.json.JSONArray

Returns the value at index if it exists and is a double or can be coerced to a double.

optDouble(int, double) - Method in class com.batch.android.json.JSONArray

Returns the value at index if it exists and is a double or can be coerced to a double.

optDouble(String) - Method in class com.batch.android.json.JSONObject

Returns the value mapped by name if it exists and is a double or can be coerced to a double, or NaN otherwise.

optDouble(String, double) - Method in class com.batch.android.json.JSONObject

Returns the value mapped by name if it exists and is a double or can be coerced to a double, or fallback otherwise.

optIn(Context) - Static method in class com.batch.android.Batch

Opt In to Batch SDK Usage.

optInt(int) - Method in class com.batch.android.json.JSONArray

Returns the value at index if it exists and is an int or can be coerced to an int.

optInt(int, int) - Method in class com.batch.android.json.JSONArray

Returns the value at index if it exists and is an int or can be coerced to an int.

optInt(String) - Method in class com.batch.android.json.JSONObject

Returns the value mapped by name if it exists and is an int or can be coerced to an int, or 0 otherwise.

optInt(String, int) - Method in class com.batch.android.json.JSONObject

Returns the value mapped by name if it exists and is an int or can be coerced to an int, or fallback otherwise.

optJSONArray(int) - Method in class com.batch.android.json.JSONArray

Returns the value at index if it exists and is a JSONArray.

optJSONArray(String) - Method in class com.batch.android.json.JSONObject

Returns the value mapped by name if it exists and is a JSONArray, or null otherwise.

optJSONObject(int) - Method in class com.batch.android.json.JSONArray

Returns the value at index if it exists and is a JSONObject.

optJSONObject(String) - Method in class com.batch.android.json.JSONObject

Returns the value mapped by name if it exists and is a JSONObject, or null otherwise.

optLong(int) - Method in class com.batch.android.json.JSONArray

Returns the value at index if it exists and is a long or can be coerced to a long.

optLong(int, long) - Method in class com.batch.android.json.JSONArray

Returns the value at index if it exists and is a long or can be coerced to a long.

optLong(String) - Method in class com.batch.android.json.JSONObject

Returns the value mapped by name if it exists and is a long or can be coerced to a long, or 0 otherwise.

optLong(String, long) - Method in class com.batch.android.json.JSONObject

Returns the value mapped by name if it exists and is a long or can be coerced to a long, or fallback otherwise.

optOut(Context) - Static method in class com.batch.android.Batch

Opt Out from Batch SDK Usage.

optOut(Context, BatchOptOutResultListener) - Static method in class com.batch.android.Batch

Opt Out from Batch SDK Usage.

optOutAndWipeData(Context) - Static method in class com.batch.android.Batch

Opt Out from Batch SDK Usage.

optOutAndWipeData(Context, BatchOptOutResultListener) - Static method in class com.batch.android.Batch

Opt Out from Batch SDK Usage.

optString(int) - Method in class com.batch.android.json.JSONArray

Returns the value at index if it exists, coercing it if necessary.

optString(int, String) - Method in class com.batch.android.json.JSONArray

Returns the value at index if it exists, coercing it if necessary.

optString(String) - Method in class com.batch.android.json.JSONObject

Returns the value mapped by name if it exists, coercing it if necessary, or the empty string if no such mapping exists.

optString(String, String) - Method in class com.batch.android.json.JSONObject

Returns the value mapped by name if it exists, coercing it if necessary, or fallback if no such mapping exists.

P

ParsingException() - Constructor for exception com.batch.android.BatchPushPayload.ParsingException

ParsingException(String) - Constructor for exception com.batch.android.BatchPushPayload.ParsingException

ParsingException(String, Throwable) - Constructor for exception com.batch.android.BatchPushPayload.ParsingException

PAYLOAD_KEY - Static variable in class com.batch.android.Batch.Push

Key to retrieve the GCM payload from the activity launch intent

payloadFromBundle(Bundle) - Static method in class com.batch.android.BatchPushPayload

Attempt to extract the Batch Push data contained within the specified Bundle.
This is usually the method you want to use when reading this payload from an activity opened by Batch, or when you wrote an existing BatchPushPayload to a Bundle/Intent extras using BatchPushPayload.writeToBundle(android.os.Bundle) / BatchPushPayload.writeToIntentExtras(android.content.Intent).

payloadFromFirebaseMessage(RemoteMessage) - Static method in class com.batch.android.BatchPushPayload

Attempt to extract the Batch Push data contained within the specified Firebase RemoteMessage.
This is usually the method you want to use when reading this payload from a FirebaseMessagingService implementation, NOT from an activity intent.

payloadFromReceiverExtras(Bundle) - Static method in class com.batch.android.BatchPushPayload

Attempt to extract the Batch Push data contained within the specified Intent extras.
This is usually the method you want to use when reading this payload from a push broadcast receiver/service, NOT from an activity intent.

payloadFromReceiverIntent(Intent) - Static method in class com.batch.android.BatchPushPayload

Attempt to extract the Batch Push data contained within the specified Intent.
This is usually the method you want to use when reading this payload from a push broadcast receiver/service, NOT from an activity intent.

performAction(Context, String, JSONObject) - Static method in class com.batch.android.Batch.Actions

Perform an action by its identifier.

performAction(Context, String, JSONObject, UserActionSource) - Method in interface com.batch.android.UserActionRunnable

Perform the requested action defined by the given parameters.

popPendingMessage() - Static method in class com.batch.android.Batch.Messaging

Gets the currently enqueued message.

presentNotification(Context, Intent) - Method in class com.batch.android.BatchPushMessageReceiver

printDebugInformation() - Static method in class com.batch.android.Batch.User

Print the currently known attributes and tags for a user to logcat.

provide() - Static method in class com.batch.android.BatchNotificationChannelsManager

PushNotificationType - Enum Class in com.batch.android

Enum that define how notifications should be display

PushRegistrationProvider - Interface in com.batch.android

Defines a push notification registration provider

PushRegistrationProviderAvailabilityException - Exception in com.batch.android

PushRegistrationProviderAvailabilityException(String) - Constructor for exception com.batch.android.PushRegistrationProviderAvailabilityException

PushUserActionSource - Interface in com.batch.android

Represents a push user action source

put(boolean) - Method in class com.batch.android.json.JSONArray

Appends value to the end of this array.

put(double) - Method in class com.batch.android.json.JSONArray

Appends value to the end of this array.

put(int) - Method in class com.batch.android.json.JSONArray

Appends value to the end of this array.

put(int, boolean) - Method in class com.batch.android.json.JSONArray

Sets the value at index to value, null padding this array to the required length if necessary.

put(int, double) - Method in class com.batch.android.json.JSONArray

Sets the value at index to value, null padding this array to the required length if necessary.

put(int, int) - Method in class com.batch.android.json.JSONArray

Sets the value at index to value, null padding this array to the required length if necessary.

put(int, long) - Method in class com.batch.android.json.JSONArray

Sets the value at index to value, null padding this array to the required length if necessary.

put(int, Object) - Method in class com.batch.android.json.JSONArray

Sets the value at index to value, null padding this array to the required length if necessary.

put(long) - Method in class com.batch.android.json.JSONArray

Appends value to the end of this array.

put(Object) - Method in class com.batch.android.json.JSONArray

Appends value to the end of this array.

put(String, boolean) - Method in class com.batch.android.BatchEventData

Add a boolean attribute for the specified key

put(String, boolean) - Method in class com.batch.android.json.JSONObject

Maps name to value, clobbering any existing name/value mapping with the same name.

put(String, double) - Method in class com.batch.android.BatchEventData

Add a double attribute for the specified key

put(String, double) - Method in class com.batch.android.json.JSONObject

Maps name to value, clobbering any existing name/value mapping with the same name.

put(String, float) - Method in class com.batch.android.BatchEventData

Add a float attribute for the specified key

put(String, int) - Method in class com.batch.android.BatchEventData

Add a integer attribute for the specified key

put(String, int) - Method in class com.batch.android.json.JSONObject

Maps name to value, clobbering any existing name/value mapping with the same name.

put(String, long) - Method in class com.batch.android.BatchEventData

Add a long attribute for the specified key

put(String, long) - Method in class com.batch.android.json.JSONObject

Maps name to value, clobbering any existing name/value mapping with the same name.

put(String, Object) - Method in class com.batch.android.json.JSONObject

Maps name to value, clobbering any existing name/value mapping with the same name.

put(String, String) - Method in class com.batch.android.BatchEventData

Add a string attribute for the specified key

put(String, URI) - Method in class com.batch.android.BatchEventData

Add an URL attribute for the specified key

put(String, Date) - Method in class com.batch.android.BatchEventData

Add a date attribute for the specified key

putOpt(String, Object) - Method in class com.batch.android.json.JSONObject

Equivalent to put(name, value) when both parameters are non-null; does nothing otherwise.

Q

quote(String) - Static method in class com.batch.android.json.JSONObject

Encodes data as a JSON string.

R

reallyOptBoolean(String, Boolean) - Method in class com.batch.android.json.JSONObject

Returns the value mapped by name if it exists and is not null, coercing it if necessary, or fallback if no such mapping exists or is null.

reallyOptDouble(String, Double) - Method in class com.batch.android.json.JSONObject

Returns the value mapped by name if it exists and is not null, coercing it if necessary, or fallback if no such mapping exists or is null.

reallyOptInteger(String, Integer) - Method in class com.batch.android.json.JSONObject

Returns the value mapped by name if it exists and is not null, coercing it if necessary, or fallback if no such mapping exists or is null.

reallyOptLong(String, Long) - Method in class com.batch.android.json.JSONObject

Returns the value mapped by name if it exists and is not null, coercing it if necessary, or fallback if no such mapping exists or is null.

reallyOptString(String, String) - Method in class com.batch.android.json.JSONObject

Returns the value mapped by name if it exists and is not null, coercing it if necessary, or fallback if no such mapping exists or is null.

refreshRegistration() - Static method in class com.batch.android.Batch.Push

Force Batch to renew the push token.

register(UserAction) - Static method in class com.batch.android.Batch.Actions

Register an action with Batch.

remove(int) - Method in class com.batch.android.json.JSONArray

Removes and returns the value at index, or null if the array has no value at index.

remove(String) - Method in class com.batch.android.json.JSONObject

Removes the named mapping if it exists; does nothing otherwise.

removeAttribute(String) - Method in class com.batch.android.BatchUserDataEditor

Removes a custom attribute.
Does nothing if it was not set.

removeDispatcher(BatchEventDispatcher) - Static method in class com.batch.android.Batch.EventDispatcher

Remove an event dispatcher.

removeTag(String, String) - Method in class com.batch.android.BatchUserDataEditor

Removes a tag from a collection.

requestNotificationPermission(Context) - Static method in class com.batch.android.Batch.Push

Request the notification runtime permission.

S

save() - Method in class com.batch.android.BatchUserDataEditor

Save all of the pending changes made in that editor.

SDK_OPTED_OUT - Enum constant in enum class com.batch.android.FailReason

Batch has globally been opted out from: network calls are not allowed

setAdditionalIntentFlags(Integer) - Static method in class com.batch.android.Batch.Push

Sets additional intent flags for notifications.

setAttribute(String, boolean) - Method in class com.batch.android.BatchUserDataEditor

Set a custom user attribute for a key.

setAttribute(String, double) - Method in class com.batch.android.BatchUserDataEditor

Set a custom user attribute for a key.

setAttribute(String, long) - Method in class com.batch.android.BatchUserDataEditor

Set a custom user attribute for a key.

setAttribute(String, String) - Method in class com.batch.android.BatchUserDataEditor

Set a custom user attribute for a key.

setAttribute(String, URI) - Method in class com.batch.android.BatchUserDataEditor

Set a custom user attribute for a key.

setAttribute(String, Date) - Method in class com.batch.android.BatchUserDataEditor

Set a custom user attribute for a key.

setAttributionIdentifier(String) - Method in class com.batch.android.BatchUserDataEditor

Set the user attribution identifier.

setAutomaticMode(boolean) - Static method in class com.batch.android.Batch.Messaging

Toggle this module's automatic mode.

setCanUseAdvancedDeviceInformation(boolean) - Method in class com.batch.android.Config

Set if Batch can use advanced device identifiers (default = true)

Advanced device identifiers include information about the device itself, but nothing that directly identify the user, such as but not limited to: - Device model - Device brand - Carrier name
Setting this to false have a negative impact on core Batch features
You should only use it if you know what you are doing.

setCanUseAdvertisingID(boolean) - Method in class com.batch.android.Config

Deprecated.
This method does nothing, please stop using it and see BatchUserDataEditor#setAttributionIdentifier(String)

setCanUseAndroidID(boolean) - Method in class com.batch.android.Config

Deprecated.
No replacement.

setCanUseInstanceID(boolean) - Method in class com.batch.android.Config

Deprecated.
Please switch to Firebase Cloud Messaging

setChannelIdInterceptor(BatchNotificationChannelsManager.NotificationChannelIdInterceptor) - Method in class com.batch.android.BatchNotificationChannelsManager

Used to set a channel id interceptor, allowing you to override the Channel ID of a notification, per notification.
You will be called on this interceptor before displaying notifications, unless you're in manual mode and don't use Batch to display the notification.

setChannelIdOverride(String) - Method in class com.batch.android.BatchNotificationChannelsManager

Overrides the default notification channel that Batch will use for notifications.
By default, Batch will manage its own channel, identified by BatchNotificationChannelsManager.DEFAULT_CHANNEL_ID.
After calling this method with a non-null channelId, Batch will stop trying to register its default channel

setChannelName(Context, int) - Method in class com.batch.android.BatchNotificationChannelsManager

Used to set a channel name provider, allowing you to change Batch's default channel name.

setChannelNameProvider(BatchNotificationChannelsManager.ChannelNameProvider) - Method in class com.batch.android.BatchNotificationChannelsManager

Used to set a channel name provider, allowing you to change Batch's default channel name.

setConfig(Config) - Static method in class com.batch.android.Batch

Set the configuration of Batch.

You should call this method before any other, only one time.
Typically on the onCreate of your MainActivity.

setCustomID(String) - Method in class com.batch.android.BatchUserProfile

Deprecated.
Please use Batch.User methods instead

setDeeplinkInterceptor(BatchDeeplinkInterceptor) - Static method in class com.batch.android.Batch.Actions

Set a deeplink interceptor.

setDoNotDisturbEnabled(boolean) - Static method in class com.batch.android.Batch.Messaging

Toggles whether Batch.Messaging should entier its "do not disturb" (DnD) mode, or exit it.

setEmail(String) - Method in class com.batch.android.BatchUserDataEditor

Set the user email.

setEmailMarketingSubscriptionState(BatchEmailSubscriptionState) - Method in class com.batch.android.BatchUserDataEditor

Set the user email marketing subscription state.

setFetchLimit(int) - Method in class com.batch.android.BatchInboxFetcher

Maximum number of notifications to fetch.

setFilterSilentNotifications(boolean) - Method in class com.batch.android.BatchInboxFetcher

Sets whether the SDK should filter silent notifications (pushes that don't result in a message being shown to the user).

setFindMyInstallationEnabled(boolean) - Static method in class com.batch.android.Batch

Control whether Batch should enables the Find My Installation feature (default = true)

setGCMSenderId(String) - Static method in class com.batch.android.Batch.Push

Deprecated.
Please migrate to FCM: https://batch.com/doc/android/advanced/fcm-migration.html

setHandlerOverride(Handler) - Method in class com.batch.android.BatchInboxFetcher

Specify a handler to post the callbacks on.

setIdentifier(String) - Method in class com.batch.android.BatchUserDataEditor

Set the user identifier.
Be careful: you should make sure the identifier uniquely identifies a user.

setLanguage(String) - Method in class com.batch.android.BatchUserDataEditor

Set the language of this user.
Overrides the detected user language.

setLanguage(String) - Method in class com.batch.android.BatchUserProfile

Deprecated.
Please use Batch.User methods instead

setLargeIcon(Bitmap) - Static method in class com.batch.android.Batch.Push

Set a custom large icon that push notifications will use.

setLifecycleListener(Batch.Messaging.LifecycleListener) - Static method in class com.batch.android.Batch.Messaging

Set a lifecycle listener.

setLoggerDelegate(LoggerDelegate) - Method in class com.batch.android.Config

Set if Batch should send its logs to an object of yours (default = null)

Be careful with your implementation: setting this can impact stability and performance
You should only use it if you know what you are doing.

setLoggerLevel(LoggerLevel) - Method in class com.batch.android.Config

Set the log level Batch should use

setManualDisplay(boolean) - Static method in class com.batch.android.Batch.Push

Set manual display mode for push notifications.

setMaxPageSize(int) - Method in class com.batch.android.BatchInboxFetcher

Number of notifications to fetch on each call, up to 100 messages per page.

setNotificationInterceptor(BatchNotificationInterceptor) - Static method in class com.batch.android.Batch.Push

Set a notification interceptor.

setNotificationsColor(int) - Static method in class com.batch.android.Batch.Push

Set the notification accent color for Lollipop or later.

setNotificationsType(EnumSet<PushNotificationType>) - Static method in class com.batch.android.Batch.Push

Adjust the way Batch will display notifications.
You should use this method if you want to remove vibration, light, sound or avoid notifications for this user.

setRegion(String) - Method in class com.batch.android.BatchUserDataEditor

Set the region of this user.
Overrides the detected user region.

setRegion(String) - Method in class com.batch.android.BatchUserProfile

Deprecated.
Please use Batch.User methods instead

setShouldAutomaticallyRegisterPush(boolean) - Method in class com.batch.android.Config

Deprecated.
This feature isn't supported anymore

setShowForegroundLandings(boolean) - Static method in class com.batch.android.Batch.Messaging

Toggle whether mobile landings should be shown directly rather than displaying a notification when the app is in foreground.

setSmallIconResourceId(int) - Static method in class com.batch.android.Batch.Push

Set a custom small icon resource that push notifications will use.

setSound(Uri) - Static method in class com.batch.android.Batch.Push

Set a custom sound uri that push notifications will use.
On Android 8.0, this setting will be applied to the default NotificationChannel that Batch registers, meaning that you won't be able to change it after the first notification.

setTypefaceOverride(Typeface, Typeface) - Static method in class com.batch.android.Batch.Messaging

Override the Typeface (aka font) used by Batch's messaging views.

shouldAutoRegisterForPush() - Static method in class com.batch.android.Batch

Deprecated.
Please remove this call, as it doesn't do anything anymore

shouldDismissNotification - Variable in class com.batch.android.BatchNotificationAction

Should a tap on this action dismiss its notification?

shouldDisplayPush(Context, Intent) - Static method in class com.batch.android.Batch.Push

Should the developer handle and display this push, or will Batch display it? Use this method to know if Batch will ignore this push, and that displaying it is your responsibility

shouldDisplayPush(Context, RemoteMessage) - Static method in class com.batch.android.Batch.Push

Should the developer handle and display this push, or will Batch display it? Use this method to know if Batch will ignore this push, and that displaying it is your responsibility

shouldShowCloseButton() - Method in class com.batch.android.BatchInterstitialContent

shouldUseAdvancedDeviceInformation() - Static method in class com.batch.android.Batch

Can Batch use advanced device information

shouldUseAdvertisingID() - Static method in class com.batch.android.Batch

Deprecated.
This method does nothing, please stop using it and see return false.

shouldUseGoogleInstanceID() - Static method in class com.batch.android.Batch

Deprecated.
Please migrate to FCM

show(Activity) - Method in class com.batch.android.BatchBannerView

Shows the banner for the specified activity.

show(Context, BatchMessage) - Static method in class com.batch.android.Batch.Messaging

Asynchronously show the BatchMessage.

show(View) - Method in class com.batch.android.BatchBannerView

Shows the banner for the specified anchor view.

skipPast(String) - Method in class com.batch.android.json.JSONTokener

Advances past all input up to and including the next occurrence of thru.

skipTo(char) - Method in class com.batch.android.json.JSONTokener

Advances past all input up to but not including the next occurrence of to.

SOUND - Enum constant in enum class com.batch.android.PushNotificationType

Add sound to the notification

startActivityForMessage(Context, BatchMessage) - Static method in class com.batch.android.MessagingActivity

startDebugActivity(Context) - Static method in class com.batch.android.Batch.Debug

Start the debug activity.

startWakefulService(Context, Intent) - Static method in class com.batch.android.BatchPushMessageDismissReceiver

Do a Context.startService, but holding a wake lock while the service starts.

startWakefulService(Context, Intent) - Static method in class com.batch.android.BatchPushMessageReceiver

Do a Context.startService, but holding a wake lock while the service starts.

startWakefulService(Context, Intent) - Static method in class com.batch.android.BatchPushReceiver

Do a Context.startService, but holding a wake lock while the service starts.

STRING - Enum constant in enum class com.batch.android.BatchUserAttribute.Type

StringResChannelNameProvider(Context, int) - Constructor for class com.batch.android.BatchNotificationChannelsManager.StringResChannelNameProvider

SUBSCRIBED - Enum constant in enum class com.batch.android.BatchEmailSubscriptionState

syntaxError(String) - Method in class com.batch.android.json.JSONTokener

Returns an exception containing the given message plus the current position and the entire input string.

T

TITLE_KEY - Static variable in class com.batch.android.Batch.Push

Key to retrieve the Title of the message (optional)

toJSONArray(JSONArray) - Method in class com.batch.android.json.JSONObject

Returns an array with the values corresponding to names.

toJSONObject(JSONArray) - Method in class com.batch.android.json.JSONArray

Returns a new object whose values are the values in this array, and whose names are the values in names.

toString() - Method in class com.batch.android.json.JSONArray

Encodes this array as a compact JSON string, such as:

toString() - Method in class com.batch.android.json.JSONObject

Encodes this object as a compact JSON string, such as:

toString() - Method in class com.batch.android.json.JSONStringer

Returns the encoded JSON string.

toString() - Method in class com.batch.android.json.JSONTokener

Returns the current position and the entire input string.

toString(int) - Method in class com.batch.android.json.JSONArray

Encodes this array as a human readable JSON string for debugging, such as:

toString(int) - Method in class com.batch.android.json.JSONObject

Encodes this object as a human readable JSON string for debugging, such as:

toValue(EnumSet<PushNotificationType>) - Static method in enum class com.batch.android.PushNotificationType

trackEvent(String) - Static method in class com.batch.android.Batch.User

Track an event.

trackEvent(String, String) - Static method in class com.batch.android.Batch.User

Track an event.

trackEvent(String, String, BatchEventData) - Static method in class com.batch.android.Batch.User

Track an event.

trackEvent(String, String, JSONObject) - Static method in class com.batch.android.Batch.User

Deprecated.
See Batch.User#trackEvent(String, String, BatchEventData). Data sent using this method might be truncated if it can't be converted to a BatchEventData instance.

trackLocation(Location) - Static method in class com.batch.android.Batch.User

Track a location update.

trackTransaction(double) - Static method in class com.batch.android.Batch.User

Track a transaction.

trackTransaction(double, JSONObject) - Static method in class com.batch.android.Batch.User

Track a transaction.

TRANSACTIONAL - Enum constant in enum class com.batch.android.BatchNotificationSource

TRIGGER - Enum constant in enum class com.batch.android.BatchNotificationSource

type - Variable in class com.batch.android.BatchUserAttribute

U

UNEXPECTED_ERROR - Enum constant in enum class com.batch.android.FailReason

An unexpected error occured, a future retry can succeed

UNKNOWN - Enum constant in enum class com.batch.android.BatchMessage.Format

UNKNOWN means that the message is invalid and does not contain any displayable message, or that the format is unknown to this version of the SDK, and might be available in a newer one.

UNKNOWN - Enum constant in enum class com.batch.android.BatchNotificationSource

unregister(String) - Static method in class com.batch.android.Batch.Actions

Unregister an action from Batch.

UNSUBSCRIBED - Enum constant in enum class com.batch.android.BatchEmailSubscriptionState

URL - Enum constant in enum class com.batch.android.BatchUserAttribute.Type

UserAction - Class in com.batch.android

Model that represents an user action, which can be triggered by Batch SDK in various contexts.

UserAction(String, UserActionRunnable) - Constructor for class com.batch.android.UserAction

Construct an Action for the specified parameters

UserActionRunnable - Interface in com.batch.android

Represents an UserAction's runnable.

UserActionSource - Interface in com.batch.android

Represents an action source.

V

value - Variable in class com.batch.android.BatchUserAttribute

value(boolean) - Method in class com.batch.android.json.JSONStringer

Encodes value to this stringer.

value(double) - Method in class com.batch.android.json.JSONStringer

Encodes value to this stringer.

value(long) - Method in class com.batch.android.json.JSONStringer

Encodes value to this stringer.

value(Object) - Method in class com.batch.android.json.JSONStringer

Encodes value.

valueOf(String) - Static method in enum class com.batch.android.Batch.EventDispatcher.Type

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.batch.android.BatchEmailSubscriptionState

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.batch.android.BatchMessage.Format

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.batch.android.BatchNotificationSource

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.batch.android.BatchOptOutResultListener.ErrorPolicy

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.batch.android.BatchUserAttribute.Type

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.batch.android.FailReason

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.batch.android.LoggerLevel

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.batch.android.PushNotificationType

Returns the enum constant of this class with the specified name.

values() - Static method in enum class com.batch.android.Batch.EventDispatcher.Type

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.batch.android.BatchEmailSubscriptionState

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.batch.android.BatchMessage.Format

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.batch.android.BatchNotificationSource

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.batch.android.BatchOptOutResultListener.ErrorPolicy

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.batch.android.BatchUserAttribute.Type

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.batch.android.FailReason

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.batch.android.LoggerLevel

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.batch.android.PushNotificationType

Returns an array containing the constants of this enum class, in the order they are declared.

verbose(String, String, Throwable) - Method in interface com.batch.android.LoggerDelegate

Send a Log.VERBOSE log message.

VERBOSE - Enum constant in enum class com.batch.android.LoggerLevel

VIBRATE - Enum constant in enum class com.batch.android.PushNotificationType

Add vibration to the notification

W

warn(String, String, Throwable) - Method in interface com.batch.android.LoggerDelegate

Send a Log.WARN log message.

WARNING - Enum constant in enum class com.batch.android.LoggerLevel

WebserviceParameterUtils - Class in com.batch.android

Utility class to easily get webservice parameters

WebserviceParameterUtils() - Constructor for class com.batch.android.WebserviceParameterUtils

WEBVIEW - Enum constant in enum class com.batch.android.BatchMessage.Format

WEBVIEW is a fullscreen format that load an URL into a WebView

wrap(Object) - Static method in class com.batch.android.json.JSONObject

Wraps the given object if necessary.

writeToBundle(Bundle) - Method in class com.batch.android.BatchMessage

writeToBundle(Bundle) - Method in class com.batch.android.BatchPushPayload

Serialize this instance into a Bundle.
Note that you'll need to use BatchPushPayload.payloadFromBundle(android.os.Bundle) with the intent's extras to read it back.

writeToIntent(Intent) - Method in class com.batch.android.BatchMessage

writeToIntentExtras(Intent) - Method in class com.batch.android.BatchPushPayload

Serialize this instance into an Intent.

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form