Batch Android SDK/com.batch.android

Package-level declarations

Types

Batch

class Batch

Entry point of the Batch library

BatchActionActivity

open class BatchActionActivity : Activity

Dummy activity that starts BatchActionService or opens a deeplink

BatchActionService

class BatchActionService : IntentService

Service that Batch uses to respond to actions when not in an activity

BatchActivityLifecycleHelper

open class BatchActivityLifecycleHelper : Application.ActivityLifecycleCallbacks

Implementation of android.app.Application.ActivityLifecycleCallbacks for managing Batch's lifecycle Important note: While this removes the need for most lifecycle activities, you still MUST add Batch.

BatchAlertContent

open class BatchAlertContent : BatchInAppMessage.Content

Model for the content of an Alert In-App/Landing message

BatchAttributesFetchListener

interface BatchAttributesFetchListener

Listener used when fetching attributes using fetchAttributes.

BatchBannerContent

open class BatchBannerContent : BatchInAppMessage.Content

Model for the content of a Banner In-App/Landing message

BatchDataCollectionConfig

open class BatchDataCollectionConfig

Batch Automatic Data Collection related configuration.

BatchDeeplinkInterceptor

interface BatchDeeplinkInterceptor

Abstract class describing a deeplink interceptor.

BatchEmailSubscriptionState

enum BatchEmailSubscriptionState

Enum defining the state of an email subscription

BatchEventAttributes

open class BatchEventAttributes

Object holding attributes 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.

BatchEventDispatcher

interface BatchEventDispatcher

Interface used when listening for event to dispatch.

BatchImageContent

open class BatchImageContent : BatchInAppMessage.Content

Model for the content of an image-only message

BatchInAppMessage

open class BatchInAppMessage : BatchMessage, InAppMessageUserActionSource

A subclass of BatchMessage that represents an In-App message

BatchInboxFetcher

open class 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

open class BatchInboxNotificationContent

BatchInboxNotificationContent is a model representing the content of an inbox notification

BatchInterstitialContent

open class BatchInterstitialContent : BatchInAppMessage.Content

Model for the content of an Interstitial In-App/Landing message

BatchLandingMessage

open class BatchLandingMessage : BatchMessage, PushUserActionSource

A subclass of BatchMessage that represents a push landing message

BatchMessage

abstract class BatchMessage : UserActionSource

Model representing a Batch Messaging message.

BatchMessageAction

open class BatchMessageAction

Represents a BatchAction triggerable by a messaging component

BatchMessageCTA

open class BatchMessageCTA : BatchMessageAction

Represents a BatchAction triggerable by a basic CTA messaging component

BatchMessagingException

open class BatchMessagingException : Exception

Batch Messaging Exception.

BatchMessagingView

open class BatchMessagingView

Class representing a Batch Messaging view.

BatchMessagingWebViewJavascriptBridge

open class BatchMessagingWebViewJavascriptBridge

Class providing method implementation for the In-App Webview javascript SDK.

BatchMigration

enum BatchMigration

BatchModalContent

open class BatchModalContent : BatchInAppMessage.Content

Model for the content of a modal message

BatchNotificationAction

open class BatchNotificationAction

Represents a Notification Action button

BatchNotificationChannelsManager

class BatchNotificationChannelsManager

BatchNotificationChannelsManager manages how Batch interacts with Android 8.0 (API 26).

BatchNotificationInterceptor

abstract class BatchNotificationInterceptor

Abstract class describing a notification interceptor.

BatchNotificationSource

enum 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

interface BatchOptOutResultListener

Interface describing a listener for server-side Opt-Out/Opt-Out and wipe acknowledgment

BatchPermissionActivity

open class BatchPermissionActivity : Activity

Dummy activity that ask a runtime permission to the user

BatchPermissionListener

interface BatchPermissionListener

Interface for requesting runtime permission with callback.

BatchProfileAttributeEditor

open class BatchProfileAttributeEditor : InstallDataEditor

Batch Profile Attribute Editor Profiles centralize data and events from multiple sources (Apps, Websites, APIs) in a single place based on the Custom ID.

BatchPushJobService

@RequiresApi(api = Build.VERSION_CODES.O)

open class BatchPushJobService : JobService

JobService implementation of Batch Push

BatchPushMessageDismissReceiver

open class BatchPushMessageDismissReceiver : WakefulBroadcastReceiver

Batch's implementation of dismiss intent of push notification

BatchPushMessageReceiver

open class BatchPushMessageReceiver : WakefulBroadcastReceiver

Batch's implementation of FCM's Push BroadcastReceiver

BatchPushPayload

open class BatchPushPayload : PushUserActionSource

Convenience object to retrieve standardized Batch data out of a Batch Push intent.

BatchPushRegistration

open class BatchPushRegistration

Class holding the push registration information.

BatchPushService

open class BatchPushService : IntentService

Batch's service for handling the push messages and show a notification This can be used on Android O, if eligibility has been verified beforehand and startService exceptions are handled.

BatchSMSSubscriptionState

enum BatchSMSSubscriptionState

Enum defining the state of an SMS subscription

BatchTagCollectionsFetchListener

interface BatchTagCollectionsFetchListener

Listener used when fetching tag collections using fetchTagCollections.

BatchUserAttribute

open class BatchUserAttribute

BatchWebViewContent

open class BatchWebViewContent : BatchInAppMessage.Content

Model for the content of an WebView message

FailReason