SDK Methods

Manually Triggering the Permission Dialog

You may choose to disable automatic triggering of the permission dialog via the platform. In this scenario you would choose to trigger the dialog based on your own criteria (eg: after a visitor interacts with a modal / soft prompt, visits a specific screen/page, etc).

The following code will manually trigger the dialog:

React

const { granted } = await PushSDK.showNativeNotificationPermissionPrompt();
console.log(`User accepted permissions: ${granted}`);

Adding Attributes to a Subscriber's Profile

You can add attributes to a subscriber's profile and later perform segmentation based on those attributes. For example, you may want to tag visitors who are interested in a specific type of news (eg: politics, sports) so that you can target them with specific notifications.

React

PushSDK.UserProfile.set("interests", ["politics", "news"]);

If you want to set more than one attribute at a time you can also send a map of values. The following example sets both a is_paying_subscriber and interests attribute on the subscriber.

React

PushSDK.UserProfile.set({
  is_paying_subscriber: true,
  interests: ["politics", "news"]
});

If you're storing the value of a property as an array you can use the append and remove methods to add or remove values. Both are asynchronous and return a Promise<void> that resolves once the update has been sent.

React

// add 'sports' to the subscriber's existing interests
await PushSDK.UserProfile.append("interests", ["sports"]);

// remove 'fashion' and 'news' from the subscriber's interests
await PushSDK.UserProfile.remove("interests", ["fashion", "news"]);

Properties updated via PushSDK.UserProfile.append() and PushSDK.UserProfile.remove() will only store the most recent 20 values provided.

Activity Tracking (URL / Screen Visits)

To track the subscriber flow through your application you can use activity tracking. You can track via screen or URL and pass associated metadata/tags if desired.

This information can then be used in segmentation to create cohorts of subscribers that have visited specific URLs or screens with tags based on number of visits and recency. For example: "Subscribers who have visited a page/screen tagged with "Astrology" at least 4 times in the last 30 days".

React

To track a URL or screen visited along with the keyword/tag metadata:

PushSDK.UserProfile.trackActivity("myapp://dashboard", ["my-tag"]);

Or if there are no tags to be provided omit the tags parameter:

PushSDK.UserProfile.trackActivity("https://www.pushly.com/article-1");

Retrieving Your Anonymous Push ID

The PushSDK automatically assigns an anonymous Push ID for event tracking and debugging purposes.

Run the following code to return the Push ID:

React

const pushId = await PushSDK.UserProfile.getAnonymousId();

Setting the Subscriber's External ID

Providing a unique User ID for your subscriber allows you to later interact with that subscriber via the API.

Once a subscriber's external ID has been set you may work with our team to set up bi-directional automated data syncs. The following use cases are common ways that publishers use the external ID via server-to-server requests:

• Sending notifications to individual subscribers programmatically

• Processing unsubscribe requests

• Adding and removing profile attributes and events to subscribers

React

PushSDK.UserProfile.setExternalId("external-id");

You can also check to see if the subscriber is already tagged with an External ID:

React

const currentExternalId = await PushSDK.UserProfile.getExternalId();

Determining if a Visitor is Already Subscribed

If you need to know if a user is already subscribed to notifications the following snippet can be used:

React

const subscribed = await PushSDK.UserProfile.getIsSubscribed();

Determining if a Visitor is Eligible to Prompt

React

const isEligible = await PushSDK.UserProfile.getIsEligibleToPrompt();

Pausing / Resuming a User's Notifications (Soft Unsubscribe)

A user's notifications can be paused by calling the following method. It is asynchronous and returns a Promise<void> that resolves once the pause has been sent to the SDK:

React

await PushSDK.PushNotifications.pause();

If the user's notifications should be resumed call the following method, which is also asynchronous and returns a Promise<void>:

React

await PushSDK.PushNotifications.resume();

To check if the user's notifications are currently paused, call getIsPaused():

React

const isPaused = await PushSDK.PushNotifications.getIsPaused();

The React Native SDK exposes this as the asynchronous method getIsPaused(), returning Promise<boolean | null>. The Android and iOS SDKs expose the same state synchronously as isPaused (a property/method). When following Android or iOS documentation or examples, substitute await PushSDK.PushNotifications.getIsPaused() for isPaused.

Permanently Delete a User

If the user should be excluded from all notifications and tracking run the following method:

React

PushSDK.UserProfile.requestUserDeletion();

Setting the SDK Log Level

The PushSDK log level is set to NONE by default. Supported log levels are: VERBOSE, DEBUG, INFO, WARN, ERROR, CRITICAL, and NONE.

To enable more detailed logging add the following code in your application's index.tsx or app.tsx file:

React

PushSDK.setLogLevel(LogLevel.INFO);