Package com.batch.android

Interface Summary

Interface	Description
AdsIdentifierProvider
AdsIdentifierProvider.AdsIdentifierListener	Interface used to callback from
Batch.EventDispatcher.Payload	Accessor to the payload of the dispatched event in BatchEventDispatcher.dispatchEvent(Type, Payload).
Batch.Messaging.DisplayHintProvider
Batch.Messaging.LifecycleListener	Listener interface for messaging views lifecycle events.
Batch.Messaging.LifecycleListener2	Listener interface for messaging events.
BatchAttributesFetchListener	Listener used when fetching attributes using Batch.User.fetchAttributes(Context, BatchAttributesFetchListener).
BatchDeeplinkInterceptor	Abstract class describing a deeplink interceptor.
BatchEventDispatcher	Interface used when listening for event to dispatch.
BatchInAppMessage.Content	Interface defining a BatchInAppMessage content model object.
BatchInboxFetcher.OnNewNotificationsFetchedListener
BatchInboxFetcher.OnNextPageFetchedListener
BatchNotificationChannelsManager.ChannelNameProvider	Interface describing a channel name provider.
BatchNotificationChannelsManager.NotificationChannelIdInterceptor	Interface describing a channel ID interceptor for notifications displayed by Batch
BatchOptOutResultListener	Interface describing a listener for server-side Opt-Out/Opt-Out and wipe acknowledgment
BatchTagCollectionsFetchListener	Listener used when fetching tag collections using Batch.User.fetchTagCollections(Context, BatchTagCollectionsFetchListener).
InAppMessageUserActionSource	Represents an In-App Message user action source.
LoggerDelegate	Interface declaring methods that needs to be implemented for a Logger delegate.
PushRegistrationProvider	Defines a push notification registration provider
PushUserActionSource	Represents a push user action source
UserActionRunnable	Represents an UserAction's runnable.
UserActionSource	Represents an action source.

Class Summary

Class	Description
AdvertisingID	Object that encapsulate advertising ID
Batch	Entry point of the Batch library
Batch.Actions	Batch Action manager
Batch.Debug	Batch Debug module
Batch.EventDispatcher	Batch EventDispatcher module
Batch.Inbox	Batch Inbox module
Batch.Messaging	Batch Messaging module
Batch.Messaging.DisplayHint
Batch.Push	Batch Push module
Batch.User	Batch User module
BatchActionActivity	Dummy activity that starts BatchActionService or opens a deeplink
BatchActionService	Service that Batch uses to respond to actions when not in an activity
BatchActivityLifecycleHelper	Implementation of Application.ActivityLifecycleCallbacks for managing Batch's lifecycle
BatchAlertContent	Model for the content of an Alert In-App/Landing message
BatchAlertContent.CTA
BatchBannerContent	Model for the content of a Banner In-App/Landing message
BatchBannerContent.Action
BatchBannerContent.CTA
BatchBannerView	BatchBannerView handles operations related to a Batch In-App Messaging banner, when used in manual mode.
BatchBannerViewPrivateHelper	Helper to access package private methods of BatchBannerView
BatchDisplayReceiptJobService	JobService implementation of Batch Display Receipt
BatchEventData	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.
BatchEventDataPrivateHelper
BatchImageContent	Model for the content of an image-only message
BatchImageContent.Action
BatchInAppMessage	A subclass of BatchMessage that represents an In-App message
BatchInboxFetcher	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.
BatchInboxNotificationContent	BatchInboxNotificationContent is a model representing the content of an inbox notification
BatchInterstitialContent	Model for the content of an Interstitial In-App/Landing message
BatchInterstitialContent.CTA
BatchLandingMessage	A subclass of BatchMessage that represents a push landing message
BatchMessage	Model representing a Batch Messaging message.
BatchMessageAction	Represents a BatchAction triggerable by a messaging component
BatchMessageCTA	Represents a BatchAction triggerable by a basic CTA messaging component
BatchMessagingWebViewJavascriptBridge	Class providing method implementation for the In-App Webview javascript SDK.
BatchModalContent	Model for the content of a modal message
BatchModalContent.Action
BatchModalContent.CTA
BatchNotificationAction	Represents a Notification Action button
BatchNotificationChannelsManager	BatchNotificationChannelsManager manages how Batch interacts with Android 8.0 (API 26).
BatchNotificationChannelsManager.StringResChannelNameProvider	Implementation of BatchNotificationChannelsManager.ChannelNameProvider using a String resource to automatically fetch the right translation.
BatchNotificationChannelsManagerPrivateHelper
BatchNotificationInterceptor	Abstract class describing a notification interceptor.
BatchPushData	Deprecated. Use BatchPushPayload
BatchPushHelper	Set of helper methods shared between BatchPushNotificationPresenter and methods exposed to devs via the push module
BatchPushInstanceIDService	Batch's service for handling Google's Instance ID token refresh
BatchPushJobService	JobService implementation of Batch Push
BatchPushMessageDismissReceiver	Batch's implementation of dismiss intent of push notification
BatchPushMessageReceiver	Batch's implementation of GCM's Push BroadcastReceiver
BatchPushNotificationPresenter	Class responsible to display a notification from a GCM/FCM push payload
BatchPushPayload	Convenience object to retrieve standardized Batch data out of a Batch Push intent. This class does not have a public constructor.
BatchPushReceiver	Batch's legacy implementation of GCM's Push BroadcastReceiver
BatchPushService	Batch's service for handling the push messages and show a notification
BatchUserAttribute
BatchUserDataEditor	Batch User data editor
BatchUserProfile	Deprecated. Please use Batch.User methods instead
BatchWebservice	Batch webservice that extends Webservice and can access SystemParameterHelper. Contains common methods to all webservices
BatchWebViewContent	Model for the content of an WebView message
BuildConfig
Config	Class to build a configuration for Batch SDK
GoogleApiAvailabilityContainer	References com.google.android.gms
ImageDownloadWebservice
IntentParser	Intent parser to retrieve promo code and other data
LocalCampaignsWebservice	Webservice to ask the server for all type of local campaigns (be in-app or notification)
MessagingActivity	Activity that only lives to display a messaging fragment
MessagingAnalyticsDelegate	Class that proxies the analytics call to the messaging module but ensures stuff like triggers only occurring once.
PrivateNotificationContentHelper	Helper to extract a package local field from BatchInboxNotificationContent
UserAction	Model that represents an user action, which can be triggered by Batch SDK in various contexts.
UserDataAccessor
WebserviceLauncher	Simple proxy to allow webservice call from outside this package
WebserviceMetrics	Static class that tracks webservices metrics for report

Enum Summary

Enum	Description
Batch.EventDispatcher.Type	Represents the type of the dispatched event in BatchEventDispatcher.dispatchEvent(Type, Payload).
BatchMessage.Format	Formats that can be contained into a BatchMessage.
BatchMessagingWebViewJavascriptBridge.DevelopmentErrorCause
BatchNotificationSource	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.ErrorPolicy
BatchUserAttribute.Type
FailReason	Reason for Batch failure
LoggerLevel
PushNotificationType	Enum that define how notifications should be display

Exception Summary

Exception	Description
AdsIdentifierProviderAvailabilityException
BatchMessagingException	Batch Messaging Exception.
BatchPushPayload.ParsingException	Represents a payload parsing exception.
DeeplinkInterceptorRuntimeException	Wraps an exception that happened in a BatchDeeplinkInterceptor
PushRegistrationProviderAvailabilityException