Method Detail

• getPushRenderingLock

  @RestrictTo(value = Scope.LIBRARY)@NonNull() Object getPushRenderingLock()

• load

  @NonNull() static PushProviders load(Context context, CleverTapInstanceConfig config, BaseDatabaseManager baseDatabaseManager, ValidationResultStack validationResultStack, AnalyticsManager analyticsManager, ControllerManager controllerManager, CTWorkManager ctWorkManager)

  Factory method to load push providers.

• _createNotification

   void _createNotification(Context context, Bundle extras, int notificationId)

  Launches an asynchronous task to download the notification icon from CleverTap,and create the Android notification.

  If your app is using CleverTap SDK's built in FCM message handling,this method does not need to be called explicitly.Use this method when implementing your own FCM handling mechanism. Refer to theSDK documentation for usage scenarios and examples.

  Parameters:

  context - A reference to an Android context

  extras - The Bundle object received by the broadcast receiver

  notificationId - A custom id to build a notification

• cacheToken

   void cacheToken(String token, PushType pushType)

  Saves token for a push type into shared pref

  Parameters:

  token - - Messaging token

  pushType - - Pushtype, RefPushType

• doTokenRefresh

  @RestrictTo(value = Scope.LIBRARY_GROUP) void doTokenRefresh(String token, PushType pushType)

• forcePushDeviceToken

  @RestrictTo(value = Scope.LIBRARY) void forcePushDeviceToken(boolean register)

  push the device token outside of the normal course

• getAvailablePushTypes

  @NonNull() ArrayList<PushType> getAvailablePushTypes()

• getCachedToken

   String getCachedToken(PushType pushType)

  Parameters:

  pushType - - Pushtype PushType

• getDevicePushTokenRefreshListener

   CleverTapAPI.DevicePushTokenRefreshListener getDevicePushTokenRefreshListener()

• setDevicePushTokenRefreshListener

   void setDevicePushTokenRefreshListener(CleverTapAPI.DevicePushTokenRefreshListener tokenRefreshListener)

• handleToken

   void handleToken(String token, PushType pushType, boolean register)

  Direct Method to send tokens to Clevertap's serverCall this method when Clients are handling the Messaging services on their own

  Parameters:

  token - - Messaging token

  pushType - - Pushtype, Ref:PushType

  register - - true if we want to register the token to CT serverfalse if we want to unregister the token from CT server

• isNotificationSupported

   boolean isNotificationSupported()

• onNewToken

   void onNewToken(String freshToken, PushType pushType)

• onTokenRefresh

   void onTokenRefresh()

• processCustomPushNotification

   void processCustomPushNotification(Bundle extras)

  Stores silent push notification in DB for smooth working of Pull NotificationsBackground Job Service and also stores wzrk_pid to the DB to avoid duplication of PushNotifications from Pull Notifications.

  Parameters:

  extras - - Bundle

• unregisterToken

   void unregisterToken(String token, PushType pushType)

  Unregister the token for a push type from Clevertap's server.Devices with unregistered token wont be reachable.

  Parameters:

  token - - Messaging token

  pushType - - pushtype Ref:PushType

• updatePingFrequencyIfNeeded

   void updatePingFrequencyIfNeeded(Context context, int frequency)

  updates the ping frequency if there is a change & reschedules existing ping tasks.

• runPushAmpWork

   void runPushAmpWork(Context context)

• addPushService

   void addPushService(PushType pushType)

  Adds new push provider similar to FCM

• getPushNotificationRenderer

  @RestrictTo(value = Scope.LIBRARY)@NonNull() INotificationRenderer getPushNotificationRenderer()

• setPushNotificationRenderer

  @RestrictTo(value = Scope.LIBRARY) void setPushNotificationRenderer(@NonNull() INotificationRenderer iNotificationRenderer)