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:

Swift

PushSDK.PushNotifications.showPermissionPrompt() { granted, settings, error in
    // optional callback
    print("User accepted permissions: \(granted)")
}

Objective-C

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.

Swift

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

Objective-C

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 an is_paying_subscriber and interests attribute on the subscriber.

Swift

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

Objective-C

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:

Swift

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

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

Objective-C

Properties using append 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".

Swift

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

PushSDK.UserProfile.trackActivity(name: "myapp://dashboard", withTags: ["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")

Objective-C

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:

Swift

let pushId = PushSDK.UserProfile.anonymousId

Objective-C

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

Swift

PushSDK.UserProfile.externalId = "external-id"

Objective-C

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

Swift

let currentExternalId = PushSDK.UserProfile.externalId

Objective-C

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:

Swift

let subscribed = PushSDK.PushNotifications.isSubscribed

Objective-C

If your application needs to react to a user's subscription status changing we recommend implementing Permission Lifecycle Delegates to ensure you are immediately notified of any change.

Determining if a Visitor is Eligible to Prompt

Swift

let isEligible = PushSDK.PushNotifications.isEligibleToPrompt

Objective-C

If your application needs to react to a user's subscription status changing we recommend implementing Permission Lifecycle Delegates to ensure you are immediately notified of any change.

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

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

Swift

PushSDK.PushNotifications.pause()

Objective-C

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

Swift

PushSDK.PushNotifications.resume()

Objective-C

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

Swift

PushSDK.PushNotifications.isPaused

Objective-C

Permanently Delete a User

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

Swift

PushSDK.UserProfile.requestUserDeletion()

Objective-C

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.

Swift

PushSDK.logLevel = .info

Objective-C