CleverPush Developer Docs

CleverPush Developer Docs

  • SDK Docs
  • API Overview
  • API Reference

›iOS SDK

JavaScript SDK

  • Setup
  • Methods

iOS SDK

  • Setup
  • Methods
  • Inbox View
  • Chat
  • Stories
  • Deep Links
  • Live Activities
  • Troubleshooting
  • Changelog

Android SDK

  • Setup
  • Methods
  • Notification Extender Service
  • Inbox View
  • Chat
  • Stories
  • Deep Links
  • Troubleshooting
  • Upgrading
  • Changelog

Capacitor SDK

  • Setup
  • Methods

Cordova SDK

  • Setup
  • Methods
  • Changelog

React Native SDK

  • Setup
  • Methods
  • Changelog

Xamarin SDK

  • Setup
  • Methods
  • Changelog

Flutter SDK

  • Setup
  • Methods
  • Chat
  • Troubleshooting
  • Changelog

Changelog

1.26.1

  • Fixed logic for app banner conditions when using properties

1.26.0

  • Removed triggerAppBannerEvent method. App banners can now be triggered with the trackEvent method.

1.25.2

  • Introduce properties argument for trackEvents method
  • Ease app banner event tracking by using conversion events

1.25.1

  • Added optional onFailure callbacks for addSubscriptionTag, removeSubscriptionTag, addSubscriptionTopic and removeSubscriptionTopic

1.25.0

  • Support app banner dark mode settings + connected banners (see app banner settings in CleverPush for more information)

1.24.4

  • Fixes for app banner attribute conditions + small optimizations for an edge case where app banners had screens enabled previously and was then showing the wrong contents.

1.24.3

  • Fixed the start date option for app banners

1.24.2

  • Fixed a potential crash when tapping an image in app banners

1.24.1

  • Fixed app banner text align bug

1.24.0

  • Added Live Activities Support. See our docs for more information.

1.23.0

  • Make areNotificationsEnabled method public

1.22.5

  • Optimized app banner behaviour when delays are used

1.22.4

  • Support calling various methods before a subscription has been created (e.g. call addSubscriptionTag and subscribe at the same time).
  • Optimized app banner attribute targeting

1.22.3

  • Support app banner language filters
  • Implement methods to optionally disable app banner statistic tracking

1.22.2

  • Added setTopicsChangedListener to get notified about changed subscription topics

1.22.1

  • Improved pending topics dialog behaviour when deviceToken is not available
  • Improved app banner version filters

1.22.0

  • Improved folder structure & added example application into SDK
  • Released as XCFramework for arm64 simulator support
  • Fixed setLogListener crash

1.21.4

  • Added ability to set own log listener via setLogListener
  • Improved NSArray method signatures

1.21.3

  • Improved getNotifications method
  • Implemented getDeviceToken:callback method

1.21.2

  • Improved setMaximumNotificationCount method

1.21.1

  • Added setMaximumNotificationCount method for limiting internal data of getNotifications

1.21.0

  • Added support for attribute filter relations

1.20.5

  • Fixed a potential crash in app banners

1.20.4

  • Improve app banners

1.20.3

  • Improved subscription attribute array methods with duplicates

1.20.2

  • Changed method signature of getSubscriptionAttribute to return an object instead of a string

1.20.1

  • Optimized pushSubscriptionAttributeValue and pullSubscriptionAttributeValue methods

1.20.0

  • Improved isSubscribed behaviour
  • Implemented setConfirmAlertShown method to track the confirm alert counts when prompting the push permission before calling subscribe
  • Implemented addSubscriptionTopic and removeSubscriptionTopic methods

1.19.1

  • Implemented setKeepTargetingDataOnUnsubscribe method

1.19.0

  • Added App Banner version filter relation
  • Added layoutSubviews in CPChatView to make sure the contained WebView always has the correct size

1.18.0

  • Support app banners without carousel and with multiple screens

1.17.1

  • Implemented callback block for showTopicsDialog method

1.17.0

  • Implemented triggerFollowUpEvent method

1.16.3

  • Implemented setShowNotificationsInForeground (enabled by default)

1.16.2

  • Implemented setIgnoreDisabledNotificationPermission to subscribe users, even when the notification permission has not been accepted (disabled by default).

1.16.1

  • Optimized usage of NSDictionaries to prevent crashes

1.16.0

  • Added optional failure block for subscribe function

1.15.12

  • Optimized "createdAt" field in CPNotification
  • Exported all user defaults keys to #defines

1.15.11

  • Fixed getNotifications method in header file

1.15.10

  • Improved empty customData dictionary in CPNotification

1.15.9

  • Fixed duplicate notification filtering in getNotifications
  • Updated method signatures for getNotifications to include type of NSArray (CPNotification)

1.15.8

  • Implemented pagination for getNotifications call with skip and limit

1.15.7

  • Filter duplicate notifications in getNotifications method

1.15.6

  • Added getAppBanners method

1.15.5

  • Support opt in delay settings & split tests

1.15.4

  • App Banner optimizations when re-starting a session

1.15.3

  • Fixed removeNotification method

1.15.2

  • Added App Banner targeting filter: subscribed state

1.15.1

  • Fixed unsubscribe behaviour

1.15.0

  • Added Unit Test cases
  • Added removeNotification(id) method
  • Added CPInboxView

1.14.1

  • Fixed createdAt field in CPNotification
  • App Banner optimizations

1.14.0

  • Support for Carousel App Banners
  • Optimized getNotifications behaviour when filtering out duplicates

1.13.3

  • Improved externalId field mapping in CPChannelTopic

1.13.2

  • Added new getNotifications(true, callback) method which can combine notifications from local storage and from the API

1.13.1

  • Improved 'autoRegister: true' behaviour when user has unsubscribed.

1.13.0

  • Added feature to automatically show topics dialog again after new topics have been added. This can optionally be enabled in the CleverPush backend under Channels -> Topics -> Show topics dialog again after new topics have been added.

1.12.6

  • Updated height calculation in topics dialog

1.12.5

  • Updated font family in topics dialog

1.12.4

  • Fixed nib file missing in resources

1.12.3

  • Fixed Topics Dialog showing when no topics available

1.12.2

  • Fixed Chat subscribeCallback

1.12.1

  • Fixed topics dialog with autoRegister: false
  • Optimized app review feedback email

1.12.0

  • Refactor topics dialog
  • App Banners: Image callback support
  • New Feature: Stories

1.11.0

  • Added addSubscriptionTags and removeSubscriptionTags methods

1.10.1

  • App Banners: prevent showing multiple banners at the same time
  • App Banners: Validate "stopAt" field for banners triggered manually or by notification

1.10.0

  • Added pushSubscriptionAttribute, pullSubscriptionAttribute and hasSubscriptionAttributeValue methods for array attributes

1.9.3

  • Added ability to specify normalTintColor which is being used by Topics Dialog Alert

1.9.2

  • Optimised App Banners

1.9.1

  • Optimised App Banners

1.9.0

  • Optimised & Refactored SDK code
  • Improved App Banner Positions (Top, Center, Bottom)
  • Improved "Uncheck all topics" behaviour
  • Added methods for enabling an disabling App Banners

1.8.0

  • New App Banner block type: HTML
  • Support custom fonts in App Banner
  • Open App Banner via Notification

1.7.1

  • Fixed Notification Opened handler when SDK was initialized delayed
  • Improved App Banner Conditions

1.7.0

  • Introduced optional 'Deselect all' switch in TopicsDialog (can be enabled in your CleverPush topic settings).
  • Added support for Close Buttons in HTML app banners

1.6.0

  • Support HTML content in app banners

1.5.0

  • Support silent push notifications

1.4.7

  • Custom Data support for Topics

1.4.6

  • Added platform name to App Banner path to make filtering by platform possible in the backend.

1.4.5

  • Fixed defaultUnchecked field for topics.

1.4.4

  • Fixed subscribe behaviour when the push permission was already given earlier.

1.4.3

  • Fixed an issue within trackPageView which was caused because the new CPChannelTag model class was missing a key

1.4.2

  • Fixed setSubscriptionTopics behaviour when called immediately inside the subscribe callback

1.4.1

  • Fixed crash in Topics Dialog

1.4.0

  • Potentially Breaking: Added own Model Classes (CPNotification, CPChannelTags, CPChannelTopics, ..) which are used in NotificationOpened and NotificationReceived listeners, getAvailableTopics and getAvailableTags. Existing implementations should still work but we encourage to use the new getters directly from our classes.

1.3.4

  • Fixed dismissal of app banners

1.3.3

  • Fixed a crash when trying to display an app-banner with empty image block

1.3.2

  • Optimized behaviour when channelId changes

1.3.1

  • Removed not necessary public headers from Framework

1.3.0

  • New App Banners

1.2.7

  • Further optimized generation of badge counts

1.2.6

  • Further optimized generation of badge counts

1.2.5

  • Improved generation of badge counts

1.2.4

  • Fixed a display issue with the topics dialog
  • Fixed translations

1.2.3

  • Decrement badge count when notification is opened

1.2.2

  • Fixed subscribe callback subscriptionId parameter on initial subscribe

1.2.1

  • Added setApiEndpoint method

1.2.0

  • Added setIncrementBadge option to automatically increment the badge count for every received notification

1.1.1

  • Fixed App Banner crash

1.1.0

  • Fixed some warnings
  • Added completely new Topics Dialog with support for sub-topics

1.0.5

  • Modified build settings to fix warnings

1.0.4

  • Allow users to unsubscribe from all topics

1.0.3

  • Modified setTrackingConsent behaviour: If called with NO no more future tracking calls will be queued and all recent queued calls will be removed

1.0.2

  • Added setTopicsDialogWindow method

1.0.1

  • Ability to specify window for showTopicsDialog

1.0.0

  • Added setTrackingConsentRequired and setTrackingConsent methods. If the tracking consent is required, tags, attributes and session tracking will only fire if the user gave his consent.

0.6.2

  • Added action to NotificationOpenedResult

0.6.1

  • Use country from NSLocale

0.6.0

  • Introduced automatic assignment of tags with trackPageView method

0.5.11

  • Fixed unsubscribe edge cases
  • Added async unsubscribe callback

0.5.10

  • Fixed autoRegister: false behaviour

0.5.9

  • Fixed crashes

0.5.8

  • Fixes

0.5.7

  • Added ability to show topics dialog after opens / days / seconds
  • Minor App Review fix

0.5.6

  • Changed App Review behaviour

0.5.5

  • Fixed a crash

0.5.4

  • Transmit last received notification

0.5.3

  • Addded Bitcode Compiler Flags

0.5.2

  • Check if callbacks are not nil before calling them

0.5.1

  • Fixed getChannelConfig callback

0.5.0

  • Split Location SDK in new Framework
  • Make most blocking internal calls asynchroneous

0.4.4

  • Build with Xcode 11.3.1

0.4.3

  • Geo fence fix

0.4.2

  • Location Prompt fix

0.4.1

  • Geo fence fix

0.4.0

  • Added Geo Fences

0.3.1

  • Sync topics from API to client

0.3.0

  • Added trackEvent method
  • Added Carousel Notifications

0.2.16

  • Minor chat notification fix

0.2.15

  • Improved ChatView: Show an error when there is no internet connection
  • Improved Opt-in rate tracking

0.2.14

  • Fixed a crash

0.2.13

  • Optimized Topics Dialog

0.2.12

  • Fixed crash when opening a notification

0.2.11

  • Optimized Chat View
  • Added ability to disable automatic clearing of badge

0.2.10

  • Fixed freeze when unsubscribe called and user is not subscribed

0.2.9

  • Optimized TopicsDialog

0.2.8

  • Do not cache HTTP requests (keeps config up to date)

0.2.7

  • Fixed CPChatView.lockChat

0.2.6

  • Optimized App Banner behaviour

0.2.5

  • Added CPChatView.lockChat and CPChatView.headerCodes

0.2.4

  • Chat optimizations

0.2.3

  • Chat optimizations

0.2.2

  • added getAvailableTopics

0.2.1

  • track app version
  • added CPChatView

0.2.0

  • automatically unsubscribe on app start if notification permission has been revoked
  • added handleNotificationReceived callback
  • display in-app notification banners by default
  • fixed isSubscribed lag

0.1.15

  • in-app banner fixes

0.1.14

  • in-app banner fixes

0.1.13

  • in-app banner fixes

0.1.12

  • track opt-in rate correctly

0.1.11

  • added showAppBanners method without arguments

0.1.10

  • optimizations for in-app banners

0.1.9

  • added app review alerts

0.1.8

  • added showAppBanners
  • Do not block main loop when channel does not exist

0.1.7

  • Run notificationsEnabled in main thread

0.1.6

  • Show topic selection dialog after accepting notifications (if there are topics available)

0.1.5

  • Update for iOS 13

0.1.4

  • Let handleSubscribed be called multiple times when re-subscribing

0.1.3

  • Always register after remote notifications have been enabled

0.1.2

  • Fixed some bugs

0.1.1

  • Added API for retrieving the last received notifications

0.1.0

  • Crash fixed when internet is not available on first launch
← TroubleshootingSetup →
  • 1.26.1
  • 1.26.0
  • 1.25.2
  • 1.25.1
  • 1.25.0
  • 1.24.4
  • 1.24.3
  • 1.24.2
  • 1.24.1
  • 1.24.0
  • 1.23.0
  • 1.22.5
  • 1.22.4
  • 1.22.3
  • 1.22.2
  • 1.22.1
  • 1.22.0
  • 1.21.4
  • 1.21.3
  • 1.21.2
  • 1.21.1
  • 1.21.0
  • 1.20.5
  • 1.20.4
  • 1.20.3
  • 1.20.2
  • 1.20.1
  • 1.20.0
  • 1.19.1
  • 1.19.0
  • 1.18.0
  • 1.17.1
  • 1.17.0
  • 1.16.3
  • 1.16.2
  • 1.16.1
  • 1.16.0
  • 1.15.12
  • 1.15.11
  • 1.15.10
  • 1.15.9
  • 1.15.8
  • 1.15.7
  • 1.15.6
  • 1.15.5
  • 1.15.4
  • 1.15.3
  • 1.15.2
  • 1.15.1
  • 1.15.0
  • 1.14.1
  • 1.14.0
  • 1.13.3
  • 1.13.2
  • 1.13.1
  • 1.13.0
  • 1.12.6
  • 1.12.5
  • 1.12.4
  • 1.12.3
  • 1.12.2
  • 1.12.1
  • 1.12.0
  • 1.11.0
  • 1.10.1
  • 1.10.0
  • 1.9.3
  • 1.9.2
  • 1.9.1
  • 1.9.0
  • 1.8.0
  • 1.7.1
  • 1.7.0
  • 1.6.0
  • 1.5.0
  • 1.4.7
  • 1.4.6
  • 1.4.5
  • 1.4.4
  • 1.4.3
  • 1.4.2
  • 1.4.1
  • 1.4.0
  • 1.3.4
  • 1.3.3
  • 1.3.2
  • 1.3.1
  • 1.3.0
  • 1.2.7
  • 1.2.6
  • 1.2.5
  • 1.2.4
  • 1.2.3
  • 1.2.2
  • 1.2.1
  • 1.2.0
  • 1.1.1
  • 1.1.0
  • 1.0.5
  • 1.0.4
  • 1.0.3
  • 1.0.2
  • 1.0.1
  • 1.0.0
  • 0.6.2
  • 0.6.1
  • 0.6.0
  • 0.5.11
  • 0.5.10
  • 0.5.9
  • 0.5.8
  • 0.5.7
  • 0.5.6
  • 0.5.5
  • 0.5.4
  • 0.5.3
  • 0.5.2
  • 0.5.1
  • 0.5.0
  • 0.4.4
  • 0.4.3
  • 0.4.2
  • 0.4.1
  • 0.4.0
  • 0.3.1
  • 0.3.0
  • 0.2.16
  • 0.2.15
  • 0.2.14
  • 0.2.13
  • 0.2.12
  • 0.2.11
  • 0.2.10
  • 0.2.9
  • 0.2.8
  • 0.2.7
  • 0.2.6
  • 0.2.5
  • 0.2.4
  • 0.2.3
  • 0.2.2
  • 0.2.1
  • 0.2.0
  • 0.1.15
  • 0.1.14
  • 0.1.13
  • 0.1.12
  • 0.1.11
  • 0.1.10
  • 0.1.9
  • 0.1.8
  • 0.1.7
  • 0.1.6
  • 0.1.5
  • 0.1.4
  • 0.1.3
  • 0.1.2
  • 0.1.1
  • 0.1.0
SDKs
JavaScriptiOSAndroidCordovaCapacitorReact NativeXamarinFlutter
Community
TwitterFacebookGitHub
More
API ReferenceAPI OverviewBlogImprintPrivacy PolicyTerms of serviceGDPR
Copyright © 2023 CleverPush