SDK opt-out (e.g. GDPR)

If you plan to send personal user data and have to comply with EU's GDPR, any other data privacy law or simply want to give your users more control regarding their privacy, these methods will help you plug your consent screen to Batch.

There are two SDK operation modes:

• SDK enabled by default, opting-out required via an explicit method call: this is the default mode.
• SDK disabled by default, opting-in required

Important: On iOS, disabling the SDK won't disable push notifications if Batch already has a valid token.

Opting-out

In order to opt-out from SDK, simply call:

await Batch.instance.optOut()

Opting out will:

• Prevent Batch from starting
• Disable any network capability from the SDK
• Disable all In-App campaigns
• Make the Inbox module return an error immediatly
• Make any call to BatchProfileAttributeEditor.save() do nothing
• Make any trackEvent methods from BatchProfile ineffective

Even if you opt-in afterwards, data generated (such as user data or tracked events) while opted out WILL be lost.

You can also wipe the SDK installation data:

await Batch.instance.optOutAndWipeData()

This will wipe the data locally and request a remote data removal for the matching Installation ID and its associated data.
Any user-level data associated with the Custom User ID (if any) set via our server APIs will not be deleted. However, the Installation ID <> Custom User ID association will be, effectively logging the user out before deleting their installation data.
Sending notifications to this user using their Advertising ID (via the Transactional API or a Custom Audience) will not be possible for a month.

Note: Opting out or wiping data is not possible while the SDK hasn't started. If you're opted out and want to delete user data, please temporarily opt-in so that Batch can send the deletion request to the servers.

Disabling the SDK by default

In order to disable the SDK by default, you will need to modify your Info.plist or AndroidManifest.xml:

• On iOS, you need to add a key called BATCH_OPTED_OUT_BY_DEFAULT with a true boolean value to your Info.plist.
• On Android, please add a meta-data entry to your AndroidManifest's <application> tag:

<meta-data android:name="batch_opted_out_by_default" android:value="true" />

Opting-in

Once you've opted-out (either programmatically, or by default), you can re-enable the SDK by calling the following:

Batch.instance.optIn()

Reading opted-out status

If you need to know whether your users are opted-out from the sdk you can use:

await Batch.instance.isOptedOut()