Batch class

Batch SDK Flutter Plugin main module.

The plugin is split into multiple modules. Use the "instance" property on the following classes to use them.

  • Batch
  • BatchUser
  • BatchInbox

Even though you can instantiate the base class, Batch's native SDKs are mostly composed of static methods, which is why the Flutter plugin should also be used that way.

Constructors

Batch()

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
optIn() Future<void>
Opt-in to Batch SDK. Will automatically restart the SDK with the configured API Key.
optOut() Future<void>
Opt-out from Batch SDK. A opt-out request will also be sent to Batch servers if possible. The SDK will save the opt-out and stop running even if the network request fails.
optOutAndWipeData() Future<void>
Opt-out from Batch SDK and wipe data. An installation data wipe command will be sent to Batch's servers if the user is connected to the internet.
showDebugView() → void
Get the debug view controller. For development purposes only, this contains UI with multiple debug features allowing you to debug your Batch implementation more easily. If you want to make it accessible in production, you should hide it in a hard to reproduce sequence.
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Properties

instance Batch
Batch Plugin singleton.
getter/setter pair