CleverPush Developer Docs

CleverPush Developer Docs

  • SDK Docs
  • API Overview
  • API Reference

›Android 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.29.2

  • Fixed a bug connected to removeSubscriptionTopic
  • Optimized HTML AppBanner support

1.29.1

  • Fixed logic for app banner conditions when using properties

1.29.0

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

1.28.1

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

1.28.0

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

1.27.7

  • Prevent crash in PermissionActivity when callback is null

1.27.6

  • Fixed missing activity in case onActivityResumed is not called

1.27.5

  • Added try catch for possible race condition

1.27.4

  • Fixed missing fcmId in request to CleverPush API.

1.27.3

  • Fixed crash when runnable throws an exception

1.27.2

  • Release new NotificationOpenedCallbackListener (see documentation)

1.27.1

  • Added getDeviceToken method

1.27.0

  • Make areNotificationsEnabled method public

1.26.9

  • Improve permission activity styling

1.26.8

  • Added ability to specify custom dialogActivity in subscribe method
  • Improved app banner targeting behaviour

1.26.7

  • Fixed app banner attribute targeting
  • Added new method to support showing app banner drafts: setAppBanerDraftsEnabled

1.26.6

  • Fixed race condition in showTopicsDialog method

1.26.5

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

1.26.4

  • Updated proguard to prevent gson issue

1.26.3

  • Implemented optional callback for unsubscribe method

1.26.2

  • Publish maven package with api scope for dependencies to potentially fix errors where proguard rules from dependencies were not included

1.26.1

  • Added more logs and try-catch to prevent potential crash

1.26.0

  • Implemented optional Device ID feature to prevent duplicate notifications on multiple apps of the same package name group.

1.25.2

  • Fixed potential crashes in AppBanners

1.25.1

  • Support disabling of badge counts via Notification Categories

1.25.0

  • Android 13 support

1.24.2

  • Improved app banner version filter conditions

1.24.1

  • Added ability to set own log listener via setLogListener

1.24.0

  • Added support for attribute filter relations
  • Implemented setMaximumNotificationCount method
  • Implemented add/removeSubscriptionTopic methods

1.23.6

  • Optimized app banner trigger conditions

1.23.5

  • Implemented setKeepTargetingDataOnUnsubscribe method

1.23.4

  • Optimized layout for app banners with multiple buttons

1.23.3

  • Implemented setCustomActivity method

1.23.2

  • Optimized ActivityLifecycleListener behaviour

1.23.1

  • Implemented SubscribeCallbackListener which can be passed as an argument to the subscribe method

1.23.0

  • Disable subscribe calls when notification permission has been disabled.
  • Added version filters for app banners
  • Added multiple screen support for app banners without carousel

1.22.1

  • Implemented isAppOpen method used by Cordova SDK

1.22.0

  • Implemented triggerFollowUpEvent method

1.21.2

  • Implemented FCM onNewToken listener

1.21.1

  • Fixed topics dialog scrolling

1.21.0

  • Optimized Activity resume behaviour when notifications are opened
  • Implemented meta data entry for disabling default activity launching: <meta-data android:name="com.cleverpush.notification_open_activity_disabled" android:value="false" />

1.20.2

  • Fixed topics dialog behaviour on cancel

1.20.1

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

1.20.0

  • Optimized topics dialog behaviour
  • Fixed a race condition when adding tag directly after subscribing

1.19.9

  • Keep image aspect ratio in TEXT_WITH_IMAGE notification style

1.19.8

  • Make sure tags are added and removed one after another to prevent race conditions

1.19.7

  • Optimized Notification category setup

1.19.6

  • Added condition in ActivityLifecycleListener to prevent NPE in Android 7

1.19.5

  • Optimized edge case in parseColor utility method

1.19.4

  • Reverted SerializedName change in Notification class

1.19.3

  • Further optimized cursor pagination for getNotificationsCombined

1.19.2

  • Optimized cursor pagination for getNotificationsCombined

1.19.1

  • Added pagination cursor for getNotifications call

1.19.0

  • Updated several dependencies (AndroidX, maximum FCM & Google play services versions)
  • Added more try-catch handlers to prevent crashes in edge cases

1.18.15

  • Added safety check in ActivityLifecycleListener to prevent NPE

1.18.14

  • Added getAppBanners method

1.18.13

  • Added App Banner targeting filter: subscribed state

1.18.12

  • Added removeNotification(id) method

1.18.11

  • Optimized createdAt field for Notification class

1.18.10

  • Do not use Topics Dialog title from config if it's empty
  • Optimized displaying of app banners - wait until root view is ready

1.18.9

  • Added ability to disable nightmode adaption via disableNightModeAdaption() (e.g. for topics dialog checkboxes)

1.18.8

  • Further optimized getInstance calls to CleverPush main class from AppBannerModule

1.18.7

  • Optimized getInstance calls to CleverPush main class from AppBannerModule

1.18.6

  • Fixed Release

1.18.5

  • Optimized setUpNotificationCategoryGroups function to prevent exception

1.18.4

  • Fixed another NullPointerException in App Banners when Activity is null

1.18.3

  • Automatically set up notification categories on init
  • Fixed NullPointerException in App Banners when Activity is null

1.18.2

  • Fixed NullPointerException when opening App Banner URL in WebView

1.18.1

  • Added ability to set listeners outside of init methods

1.18.0

  • Automatically re-sync when device token changes (might happen during development)
  • Add ability to specify custom Notification Styles

1.17.0

  • Updates for Android 12

1.16.5

  • Delayed CleanUpService start until first Activity is ready
  • Added new getNotifications(true, callback) method which can combine notifications from local storage and from the API

1.16.4

  • Fixed ActivityLifecycleListener removing CleverPush instance too early

1.16.3

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

1.16.2

  • Fixed NotificationOpenedHandler firing twice when re-opening app from background
  • Addressed possible memory leaks

1.16.1

  • Optimized app review feedback email

1.16.0

  • Added App Stories
  • Added methods for adding / removing multiple tags at once

1.15.6

  • Improved Topics Dialog behaviour

1.15.5

  • App Banners: Optimized app banner behaviour

1.15.4

  • Optimized behaviour for downloading Notification images

1.15.3

  • Added ProGuard consumer rules

1.15.2

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

1.15.1

  • Catch FCM exceptions in onReceivedMessage listener to prevent crash on invalid payloads

1.15.0

  • Added pushSubscriptionAttribute, pullSubscriptionAttribute and hasSubscriptionAttributeValue methods for array attributes
  • Result from getSubscriptionAttributes added to Map<String, Object>

1.14.5

  • Improved style of topics dialog

1.14.4

  • Improved Behaviour of App Banners
  • Improved internal storage of received notifications

1.14.3

  • Improved Behaviour of App Banners

1.14.2

  • Optimized Topics Dialog for Dark Mode

1.14.1

  • Optimized Topics Dialog behaviour when shown multiple times

1.14.0

  • Improved App Banner Positions (Top, Center, Bottom)
  • Added Support for Firebase SDK 22+
  • Improved "Uncheck all topics" behaviour
  • Added methods for enabling an disabling App Banners

1.13.1

  • Improved App Banner Layout for tablets

1.13.0

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

1.12.1

  • Improved behaviour of automatic incrementing of badge count

1.12.0

  • Introduced optional 'Deselect all' checkbox in TopicsDialog (can be enabled in your CleverPush topic settings).
  • Support app banners with HTML content

1.11.1

  • Optimized silent notifications

1.11.0

  • Added support for silent push notifications

1.10.0

  • Provide new methods for tracking deliveries and clicks when using the NotificationExtenderService with own Notifications
  • Updated to latest Firebase dependencies

1.9.1

  • Resolved a race condition where the NotificationOpenedHandler might yield the wrong notification for multiple notification received at the exact same time.

1.9.0

  • Added extra null check for subscription_id (#4)

1.8.12

  • Allow notifications with empty titles

1.8.11

  • Custom Data support for Topics

1.8.10

  • Fixed translation

1.8.9

  • Fixed Notification colors

1.8.8

  • Added ability to specify a Theme ID (R.style.Theme_…) for the Topics Dialog

1.8.7

  • Use AlertDialog from AndroidX

1.8.6

  • Fixed Exception in NotificationCategory class

1.8.5

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

1.8.4

  • Add try-catch black inside NotificationExtenderService

1.8.3

  • Clear subscription data incl. Topics, Tags and Attributes when changing Channel ID

1.8.2

  • Allow automatic automatic replacing of active Notifications in status bar when the same Tag / ID is used.

1.8.1

  • Fixes for App Banner Images

1.8.0

  • New App Banners

1.7.5

  • Added externalId to ChannelTopics

1.7.4

  • Reset Channel Config when Channel ID changes in init

1.7.3

  • Added enableDevelopmentMode to bypass config cache
  • Automatically re-subscribe when Channel ID changes

1.7.2

  • Fixed sorting of getAvailableTopics result

1.7.1

  • Fixed empty FCM ID when calling subscribe before init has finished

1.7.0

  • New Badge Support

1.6.7

  • Fixed JSONException inside getAvailableTopicsFromConfig

1.6.6

  • Handle empty FCM notification data

1.6.5

  • Update ChannelTopic object

1.6.4

  • Added various Notification Category features

1.6.3

  • Fixed ExtenderService with Carousel Notifications

1.6.2

  • Support child topics

1.6.1

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

1.6.0

  • Added TrackingConsentListener

1.5.0

  • Support custom NotificationExtenderService (see docs)

1.4.1

  • Fix for Notification Channel sounds

1.4.0

  • Custom sound support

1.3.0

  • Easier tagging support

1.2.0

  • Support for Android Notification Channels

1.1.0

  • Support for HMS (Huawei Mobile Services)

1.0.0

  • Breaking Change: Migrated to AndroidX
  • Breaking Change: Set minSdkVersion to 16
  • Updated Gradle Plugin to 3.5.3
  • Updated Google Services Plugin to 4.3.3
  • Updated Gson to 2.8.6
  • Deprecated CleverPushInstanceIDListenerService
  • Compatible with newest Firebase libraries

0.6.0

  • Updated google services + gradle

0.5.9

  • Added init method only with channel ID parameter

0.5.8

  • Improved App Review dialog

0.5.7

  • Add ability to delay topics dialog by opens / days / seconds

0.5.6

  • Minor fix

0.5.5

  • Transmit last received notification

0.5.4

  • Event Tracking fix

0.5.3

  • Added createdAt property for Notifications

0.5.2

  • Crash Fixes in Fcm Listener

0.5.1

  • Geo Fence Fixes

0.5.0

  • Added Geo Fences

0.4.3

  • Added TopicsDialogListener

0.4.2

  • Sync subscribed topics from API to Client

0.4.1

  • Added NotificationReceivedCallbackListener with ability to set if notification should be shown

0.4.0

  • Added trackEvent
  • Added Carousel Notifications

0.3.3

  • Added getAvailableTopics
  • Fixed ChatSubscribeListener

0.3.2

  • Topics dialog optimizations

0.3.1

  • Optimized ChatView: Show error when there is no internet connection available

0.3.0

  • Fixed ChatUrlOpenedListener
  • Added TopicsChangedListener
  • Deprecated sync getChannelConfig and getSubscriptionId methods
  • Added ActivityLifecycleListener and removed internal activity variable.
  • added isInitialized method

0.2.0

  • Added lockChat for ChatView
  • Optimizations in ChatView
  • Automatically call subscribe in init after getting channel config to prevent potential blocks

0.1.13

  • Added ability to provide custom activity for Topics Dialog

0.1.12

  • optimized Topics Dialog

0.1.11

  • optimized ChatView

0.1.10

  • added ChatView

0.1.9

  • catch BadTokenException when showing AppBanner

0.1.8

  • bug fixes

0.1.7

  • bug fixes

0.1.6

  • added new NotificationReceivedListener which will be called everytime a notification will be received (in foreground or background)
  • app review support

0.0.14

  • timezone support

0.0.13

  • fix where launcher activity was not opened sometimes when cold-starting app from notification
  • added setSubscriptionLanguage and setSubscriptionCountry

0.0.12

  • support big text and big image notification styles

0.0.11

  • fixes

0.0.10

  • added subscribe and unsubscribe methods

0.0.9

  • make all method async
  • deprecate getAvailableTags & getAvailableAttributes without callback listeners
  • add optional parameter autoRegister for init method (defaults to true)
← UpgradingSetup →
  • 1.29.2
  • 1.29.1
  • 1.29.0
  • 1.28.1
  • 1.28.0
  • 1.27.7
  • 1.27.6
  • 1.27.5
  • 1.27.4
  • 1.27.3
  • 1.27.2
  • 1.27.1
  • 1.27.0
  • 1.26.9
  • 1.26.8
  • 1.26.7
  • 1.26.6
  • 1.26.5
  • 1.26.4
  • 1.26.3
  • 1.26.2
  • 1.26.1
  • 1.26.0
  • 1.25.2
  • 1.25.1
  • 1.25.0
  • 1.24.2
  • 1.24.1
  • 1.24.0
  • 1.23.6
  • 1.23.5
  • 1.23.4
  • 1.23.3
  • 1.23.2
  • 1.23.1
  • 1.23.0
  • 1.22.1
  • 1.22.0
  • 1.21.2
  • 1.21.1
  • 1.21.0
  • 1.20.2
  • 1.20.1
  • 1.20.0
  • 1.19.9
  • 1.19.8
  • 1.19.7
  • 1.19.6
  • 1.19.5
  • 1.19.4
  • 1.19.3
  • 1.19.2
  • 1.19.1
  • 1.19.0
  • 1.18.15
  • 1.18.14
  • 1.18.13
  • 1.18.12
  • 1.18.11
  • 1.18.10
  • 1.18.9
  • 1.18.8
  • 1.18.7
  • 1.18.6
  • 1.18.5
  • 1.18.4
  • 1.18.3
  • 1.18.2
  • 1.18.1
  • 1.18.0
  • 1.17.0
  • 1.16.5
  • 1.16.4
  • 1.16.3
  • 1.16.2
  • 1.16.1
  • 1.16.0
  • 1.15.6
  • 1.15.5
  • 1.15.4
  • 1.15.3
  • 1.15.2
  • 1.15.1
  • 1.15.0
  • 1.14.5
  • 1.14.4
  • 1.14.3
  • 1.14.2
  • 1.14.1
  • 1.14.0
  • 1.13.1
  • 1.13.0
  • 1.12.1
  • 1.12.0
  • 1.11.1
  • 1.11.0
  • 1.10.0
  • 1.9.1
  • 1.9.0
  • 1.8.12
  • 1.8.11
  • 1.8.10
  • 1.8.9
  • 1.8.8
  • 1.8.7
  • 1.8.6
  • 1.8.5
  • 1.8.4
  • 1.8.3
  • 1.8.2
  • 1.8.1
  • 1.8.0
  • 1.7.5
  • 1.7.4
  • 1.7.3
  • 1.7.2
  • 1.7.1
  • 1.7.0
  • 1.6.7
  • 1.6.6
  • 1.6.5
  • 1.6.4
  • 1.6.3
  • 1.6.2
  • 1.6.1
  • 1.6.0
  • 1.5.0
  • 1.4.1
  • 1.4.0
  • 1.3.0
  • 1.2.0
  • 1.1.0
  • 1.0.0
  • 0.6.0
  • 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.3
  • 0.4.2
  • 0.4.1
  • 0.4.0
  • 0.3.3
  • 0.3.2
  • 0.3.1
  • 0.3.0
  • 0.2.0
  • 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.0.14
  • 0.0.13
  • 0.0.12
  • 0.0.11
  • 0.0.10
  • 0.0.9
SDKs
JavaScriptiOSAndroidCordovaCapacitorReact NativeXamarinFlutter
Community
TwitterFacebookGitHub
More
API ReferenceAPI OverviewBlogImprintPrivacy PolicyTerms of serviceGDPR
Copyright © 2023 CleverPush