Unregisters this device's push token and push-to-start tokens (iOS only) from Braze and, on
success, performs cleanup.
On success, the device's push token is unregistered, local data is wiped, and the SDK is disabled.
To receive push notifications again, re-register via registerPushToken or the appropriate native
system APIs. On failure, no data is wiped and the SDK stays enabled.
Push-to-start tokens are only unregistered if the iOS host app has integrated Live Activities
and registered them for push-to-start in native code. Otherwise, that step is skipped.
The SDK does not retry on its own. Inspect BrazePushUnregistrationError.isRetriable to decide
whether calling again may succeed.
Returns Promise<void>
Resolves on success; rejects with a BrazePushUnregistrationError on failure.
Unregisters this device's push token and push-to-start tokens (iOS only) from Braze and, on success, performs cleanup.
On success, the device's push token is unregistered, local data is wiped, and the SDK is disabled. To receive push notifications again, re-register via
registerPushTokenor the appropriate native system APIs. On failure, no data is wiped and the SDK stays enabled.Push-to-start tokens are only unregistered if the iOS host app has integrated Live Activities and registered them for push-to-start in native code. Otherwise, that step is skipped.
The SDK does not retry on its own. Inspect
BrazePushUnregistrationError.isRetriableto decide whether calling again may succeed.