SDK Callbacks

PushSDKLifecycleCallbacks, PermissionLifecycleCallbacks, NotificationLifecycleCallbacks, and AppMessageLifecycleCallbacks are not exported from @pushly/push-sdk-react-native. There is no import type { X } from '@pushly/push-sdk-react-native' available for any of them. Pass a plain object literal matching the shape documented below directly to the matching register* method — TypeScript will structurally type-check the literal against the method's parameter type without an explicit import.

We recommend registering all SDK callbacks once, near your application's root component (eg. in a useEffect alongside PushSDK.setConfiguration), to ensure proper handling of all events.

SDK Lifecycle Callbacks

These callbacks can be implemented to observe SDK loading and exiting.

In order to implement these callbacks call the SDK's registerPushSDKLifecycleCallbacks method with an object literal implementing the callback(s) you need.

React

PushSDK.registerPushSDKLifecycleCallbacks({
  // Add function overrides here
});

The following SDK Lifecycle callbacks are available:

Finished Loading

This callback is executed when the SDK finishes its initialization and is ready for interaction.

React

onPushSDKDidFinishLoading(configuration, subscriberStatus) {
  // Add code to execute after SDK finishes loading
}

Exited With Subscriber Status

This callback is executed when the SDK exits and reports the subscriber's current status.

React

onPushSDKDidExitWithSubscriberStatus(status, deleted) {
  // Add code to execute after the SDK exits
}

Permission Lifecycle Callbacks

These callbacks can be implemented to observe a user's permission authorization changes.

In order to implement these callbacks call the SDK's registerPermissionLifecycleCallbacks method with an object literal implementing the callback(s) you need.

React

PushSDK.registerPermissionLifecycleCallbacks({
  // Add function overrides here
});

The following Permission Lifecycle callbacks are available:

Permission Status Changed

This callback is executed when a user's permission status/authorization has changed.

The response variable represents the user's new permission status.

React

onPushSDKDidReceivePermissionResponse(response) {
  // Add code to execute after a user's notification permission has changed
}

Permission Status Changed With Error

This callback is executed when a user's permission status/authorization changes and the SDK also has an error to report for that change.

React

onPushSDKDidReceivePermissionResponseWithError(response, error) {
  // Add code to execute after a user's notification permission has
  // changed alongside an error
}

error is typed as Error, but the SDK delivers an internal PushSDKException instance, which is not exported. You can read error.message, but you cannot import the class to check instanceof.

Registered For Remote Notifications

This callback is executed when the device successfully registers for remote notifications and receives a device token.

React

onPushSDKDidRegisterForRemoteNotificationsWithDeviceToken(token) {
  // Add code to execute after the device registers for remote notifications
}

Failed To Register For Remote Notifications

This callback is executed when the device fails to register for remote notifications.

React

onPushSDKDidFailToRegisterForRemoteNotificationsWithError(error) {
  // Add code to execute after the device fails to register for remote notifications
}

As with onPushSDKDidReceivePermissionResponseWithError, error is typed as Error but delivered as an internal, non-exported PushSDKException instance.

Notification Lifecycle Callbacks

These callbacks can be implemented to observe events like impressions, opens, and other interactions with notifications.

In order to implement these callbacks call the SDK's registerNotificationLifecycleCallbacks method with an object literal implementing the callback(s) you need.

React

PushSDK.registerNotificationLifecycleCallbacks({
  // Add function overrides here
});

The following Notification Lifecycle callbacks are available:

Notification Received

This callback is executed when a user receives a notification.

React

onPushSDKDidReceiveRemoteNotification(notification) {
  // Add code to execute after the subscriber's device receives a notification
}

Notification Opened With URI/URL Destination

This callback is executed when a notification is opened that has a landing URL attached. The subscriber should be navigated to the view that represents the URL.

This method expects a Boolean response (a Promise<boolean> is also supported). If the response is true then the SDK will perform no additional actions for this notification open. If the response is false then the SDK will attempt to navigate the subscriber to the destination URL.

React

onPushSDKDidReceiveNotificationDestination(destination, interaction): boolean {
  // Navigate within your application using the destination (the Landing URL)

  // Return true to inform the SDK that it should not navigate
  return true;
}

See the Deep Linking documentation for a complete example.

App Message Lifecycle Callbacks

These callbacks can be implemented to observe events like impressions, opens, and other interactions with app messages.

In order to implement these callbacks call the SDK's registerAppMessageLifecycleCallbacks method with an object literal implementing the callback(s) you need.

React

PushSDK.registerAppMessageLifecycleCallbacks({
  // Add function overrides here
});

The following App Message Lifecycle callbacks are available:

App Message Will Present

This callback is executed when an App Message is presented to a user.

React

onPushSDKWillPresentAppMessage(appMessage) {
  // Add code to execute when a user's device presents an app message
}

App Message Received User Interaction

This callback is executed when a user interacts with an App Message.

This method expects a Boolean response (a Promise<boolean> is also supported). If the response is true then the SDK will not handle the interaction or attempt to perform navigation when the interaction is an Open URL action. If the response is false then the SDK will process the interaction and, if the interaction is an Open URL action, will attempt to navigate the user to the destination URL.

React

onPushSDKDidReceiveAppMessageInteraction(interaction, appMessage): boolean {
  // Add code to execute when a user interacts with an app message

  // Return true to inform the SDK that it should not handle the interaction
  return true;
}

Failed To Process Message

This callback is executed when the SDK fails to process an App Message.

React

onPushSDKDidFailToProcessMessage(message, appMessage) {
  // Add code to execute when the SDK fails to process an app message
}