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:

Kotlin

PushSDK.PushNotifications.showPermissionPrompt(completion = { granted, response, error ->
    // Optional callback
    println("User accepted permissions: $granted")
}

Java

PushSDK.PushNotifications.showPermissionPrompt((granted, response, error) -> {
    // Optional callback
    System.out.printf("User accepted permissions: %b", granted);
    return null;
});

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.

Kotlin

PushSDK.UserProfile.set(key="interests", value=listOf("politics", "news"))

Java

PushSDK.UserProfile.set("interests", List.of("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.

Kotlin

PushSDK.UserProfile.set(data=hashMapOf(
  "is_paying_subscriber" to true,
  "interests" to listOf("politics", "news")
))

Java

PushSDK.UserProfile.set(Map.of(
  "is_paying_subscriber", true,
  "interests", List.of("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:

Kotlin

// add 'sports' to the subscriber's existing interests
PushSDK.UserProfile.append(key = "interests", values = listOf("sports"))

// remove 'fashion' and 'news' from the subscriber's interests
PushSDK.UserProfile.remove(key = "interests", values = listOf("fashion", "news"))

Java

// add 'sports' to the subscriber's existing interests
PushSDK.UserProfile.append("interests", List.of("sports"));

// remove 'fashion' and 'news' from the subscriber's interests
PushSDK.UserProfile.remove("interests", List.of("fashion", "news"));

Properties using the append and remove methods 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".

Kotlin

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

PushSDK.UserProfile.trackActivity(name="myapp://dashboard", tags=listOf("my-tag"))

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

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

Java

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

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

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

PushSDK.UserProfile.trackActivity("https://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:

Kotlin

val pushId = PushSDK.UserProfile.anonymousId

Java

String pushId = 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

Kotlin

PushSDK.UserProfile.externalId = "external-id"

Java

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

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

Kotlin

val currentExternalId = PushSDK.UserProfile.externalId

Java

String currentExternalId = 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:

Kotlin

val subscribed = PushSDK.PushNotifications.isSubscribed

Java

Boolean subscribed = PushSDK.PushNotifications.isSubscribed();

Determining if a Visitor is Eligible to Prompt

Kotlin

val isEligible = PushSDK.PushNotifications.isEligibleToPrompt

Java

Boolean isEligible = PushSDK.PushNotifications.isEligibleToPrompt();

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

A user's notifications can be paused by calling the following method:

Kotlin

PushSDK.PushNotifications.pause()

Java

PushSDK.PushNotifications.pause();

If the user's notifications should be resumed call the following method:

Kotlin

PushSDK.PushNotifications.resume()

Java

PushSDK.PushNotifications.resume();

To check if the user's notifications are currently paused:

Kotlin

val isPaused = PushSDK.PushNotifications.isPaused

Java

Boolean isPaused = PushSDK.PushNotifications.isPaused();

Permanently Delete a User

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

Kotlin

PushSDK.UserProfile.requestUserDeletion()

Java

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 main onCreate method:

Kotlin

PushSDK.logLevel = PNLogLevel.INFO

Java

PushSDK.setLogLevel(PNLogLevel.INFO);