Batch Android SDK

3.0.0

Batch Android SDK/com.batch.android/Batch

Batch

class Batch

Entry point of the Batch library

Types

Batch Action manager

class Debug

Batch Debug module

EventDispatcher

class EventDispatcher

Batch EventDispatcher module

class Inbox

Batch Inbox module

class Messaging

Batch Messaging module

Batch Profile module

class Push

Batch Push module

class User

Batch User module

Properties

ACTION_REGISTRATION_IDENTIFIER_OBTAINED

val ACTION_REGISTRATION_IDENTIFIER_OBTAINED: String = "com.batch.android.intent.action.push.REGISTRATION_IDENTIFIER_OBTAINED"

Intent broadcasted locally by the SDK when a push registration identifier has been retrieved (also called "Push Token").

BROADCAST_PERMISSION_SUFFIX

val BROADCAST_PERMISSION_SUFFIX: String = ".batch.permission.INTERNAL_BROADCAST"

Permission suffix for broadcasts triggered by Batch.

EXTRA_REGISTRATION_IDENTIFIER

val EXTRA_REGISTRATION_IDENTIFIER: String = "registration_id"

Extra containing the Registration Identifier for a ACTION_REGISTRATION_IDENTIFIER_OBTAINED broadcast

EXTRA_REGISTRATION_PROVIDER_NAME

val EXTRA_REGISTRATION_PROVIDER_NAME: String = "provider_name"

Extra containing the Registration Provider name for a ACTION_REGISTRATION_IDENTIFIER_OBTAINED broadcast

EXTRA_REGISTRATION_SENDER_ID

val EXTRA_REGISTRATION_SENDER_ID: String = "sender_id"

Extra containing the Sender ID (if any) for a ACTION_REGISTRATION_IDENTIFIER_OBTAINED broadcast

NOTIFICATION_TAG

val NOTIFICATION_TAG: String = "batch"

Notification tag.

open val sessionID: String

Current session ID (changed at each start)

Functions

copyBatchExtras

open fun copyBatchExtras(@Nullable from: Intent, @Nullable to: Intent)

Copy Batch's internal data from an intent to another.

open fun copyBatchExtras(@Nullable from: Bundle, @Nullable to: Bundle)

Copy Batch's internal data from intent extras to another bundle.

disableMigration

open fun disableMigration(@NonNull migrations: EnumSet<BatchMigration>)

Set data migrations you want to disable.

getBroadcastPermissionName

open fun getBroadcastPermissionName(@NonNull context: Context): String

Get the broadcast permission name.

open fun isOptedOut(@NonNull context: Context): Boolean

Returns whether Batch has been opted out from or not Warning: This method might perform some quick I/O in the caller thread.

open fun onCreate(activity: Activity)

Method to call on your main activity onCreate.

open fun onDestroy(activity: Activity)

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

open fun onNewIntent(activity: Activity, intent: Intent)

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

onServiceCreate

open fun onServiceCreate(context: Context, userActivity: Boolean)

Method to call on your service onCreate to start Batch.

onServiceDestroy

open fun onServiceDestroy(context: Context)

Method to call on your service onDestroy to stop Batch.

open fun onStart(activity: Activity)

Method to call on your main activity onStart to start Batch and support URL scheme events.

open fun onStop(activity: Activity)

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

open fun optIn(@NonNull context: Context)

Opt In to Batch SDK Usage.

open fun optOut(@NonNull context: Context)

open fun optOut(@NonNull context: Context, @Nullable listener: BatchOptOutResultListener)

Opt Out from Batch SDK Usage.

optOutAndWipeData

open fun optOutAndWipeData(@NonNull context: Context)

open fun optOutAndWipeData(@NonNull context: Context, @Nullable listener: BatchOptOutResultListener)

Opt Out from Batch SDK Usage.

setFindMyInstallationEnabled

open fun setFindMyInstallationEnabled(enabled: Boolean)

Control whether Batch should enables the Find My Installation feature (default = true) If enabled Batch will copy the current installation id in the clipboard when the application is foregrounded 5 times within 12 seconds.

setLoggerDelegate

open fun setLoggerDelegate(@Nullable delegate: LoggerDelegate)

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.

open fun setLoggerLevel(@NonNull level: LoggerLevel)

Set the log level that Batch should use

open fun start(@NonNull apiKey: String)

Set the API Key of Batch.

updateAutomaticDataCollection

open fun updateAutomaticDataCollection(editor: BatchDataCollectionConfig.Editor)

Configure the SDK Automatic Data Collection.