com.blueshift.util

Class NotificationUtils

java.lang.Object

com.blueshift.util.NotificationUtils

public class NotificationUtils
extends java.lang.Object

A class with helper methods to show custom notification.

Created by Rahul on 20/9/16 @ 3:55 PM.

Constructor Summary

Constructors

Constructor and Description
NotificationUtils()

Method Summary

Modifier and Type	Method and Description
static android.app.NotificationChannel	createNotificationChannel(android.content.Context context, Message message) Creates a channel object with default details.
static void	downloadCarouselImages(android.content.Context context, Message message) Downloads all carousel images and stores them inside app's private file location after compressing them.
static android.content.Intent	getAddToCartActivityIntent(android.content.Context context, Message message) Get the activity marked as cart activity inside the configuration object with extras
static java.lang.String	getImageFileName(java.lang.String url) Extracts the file name from the image file url
static java.lang.String	getNotificationChannelDescription(android.content.Context context, Message message) Reads a channel description from the config object
static java.lang.String	getNotificationChannelId(android.content.Context context, Message message) Read the channel id provided in message or config.
static java.lang.String	getNotificationChannelId(java.lang.String channelName) Deprecated.
static java.lang.String	getNotificationChannelName(android.content.Context context, Message message) Read default channel name from config if provided.
static android.content.Intent	getNotificationEventsActivity(android.content.Context context, java.lang.String action, android.os.Bundle extras) Checks for the activity responsible for handling notification clicks based on the action.
static android.content.Intent	getOpenAppIntent(android.content.Context context, Message message) Get the activity marked as LAUNCHER in the AndroidManifest.xml
static android.content.Intent	getViewCartActivityIntent(android.content.Context context, Message message) Get the activity marked as cart activity inside the configuration object
static android.content.Intent	getViewOffersActivityIntent(android.content.Context context, Message message) Get the activity marked as offer display activity inside the configuration object
static android.content.Intent	getViewProductActivityIntent(android.content.Context context, Message message) Get the activity marked as product details activity inside the configuration object with extras
static void	invokePushClicked(android.content.Context context, Message message, java.lang.String clickUrl) This helper method allows the sdk to call the listener method (if provided) along with internal tracking method for push click.
static void	invokePushDelivered(android.content.Context context, Message message) This helper method allows the sdk to call the listener method (if provided) along with internal tracking method for push delivered.
static android.graphics.Bitmap	loadImageFromDisc(android.content.Context context, java.lang.String fileName) Loads the image stored inside app's private file location
static android.graphics.Bitmap	loadScaledBitmap(java.lang.String url, int reqWidth, int reqHeight)
static boolean	processNotificationClick(android.content.Context context, android.content.Intent intent) Simplified version of processNotificationClick(context, action, bundle)
static boolean	processNotificationClick(android.content.Context context, java.lang.String action, android.os.Bundle bundle) This is a helper method that can decide what needs to be done when someone clicks on push msg.
static void	removeCachedCarouselImages(android.content.Context context, Message message) Method to remove all carousel images cached.
static void	removeImageFromDisc(android.content.Context context, java.lang.String fileName) Remove file with given name from app's private files directory.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NotificationUtils

public NotificationUtils()

Method Detail

getImageFileName

public static java.lang.String getImageFileName(java.lang.String url)

Extracts the file name from the image file url

Parameters:

url - a valid image url

Returns:

the file name of the image the url referring to

downloadCarouselImages

public static void downloadCarouselImages(android.content.Context context,
                                          Message message)

Downloads all carousel images and stores them inside app's private file location after compressing them.

Parameters:

context - valid context object

message - message object with valid carousel elements

loadImageFromDisc

public static android.graphics.Bitmap loadImageFromDisc(android.content.Context context,
                                                        java.lang.String fileName)

Loads the image stored inside app's private file location

Parameters:

context - valid context object

fileName - name of the image to be retrieved

Returns:

bitmap image with given filename (if exists)

removeImageFromDisc

public static void removeImageFromDisc(android.content.Context context,
                                       java.lang.String fileName)

Remove file with given name from app's private files directory.

Parameters:

context - valid context object

fileName - the name of the file to be removed.

removeCachedCarouselImages

public static void removeCachedCarouselImages(android.content.Context context,
                                              Message message)

Method to remove all carousel images cached.

Parameters:

context - valid context object

message - message with valid carousel elements

getNotificationChannelId

@Deprecated
public static java.lang.String getNotificationChannelId(java.lang.String channelName)

Deprecated.

Generates channel id unique for this package

Parameters:

channelName - channel name for generating unique channel id

Returns:

Valid channel id for notification.

getNotificationChannelId

public static java.lang.String getNotificationChannelId(android.content.Context context,
                                                        Message message)

Read the channel id provided in message or config. If not found in both the places, return "bsft_channel_General" as default channel id.

Parameters:

context - valid Context object

message - message object to read the channel name from

Returns:

valid notification channel id

getNotificationChannelName

public static java.lang.String getNotificationChannelName(android.content.Context context,
                                                          Message message)

Read default channel name from config if provided. If not return "General" as channel name.

Parameters:

context - valid Context object

message - message object to read the channel name from

Returns:

valid notification channel name

getNotificationChannelDescription

public static java.lang.String getNotificationChannelDescription(android.content.Context context,
                                                                 Message message)

Reads a channel description from the config object

Parameters:

context - valid context object

message - message object to read the channel name from

Returns:

valid channel description if provided, else null

createNotificationChannel

public static android.app.NotificationChannel createNotificationChannel(android.content.Context context,
                                                                        Message message)

Creates a channel object with default details. This is required for Oreo to show Notification.

Parameters:

message - valid Message object

Returns:

valid NotificationChannel object

getNotificationEventsActivity

public static android.content.Intent getNotificationEventsActivity(android.content.Context context,
                                                                   java.lang.String action,
                                                                   android.os.Bundle extras)

Checks for the activity responsible for handling notification clicks based on the action.

Parameters:

context - context object to create intent

action - action string

extras - extra params as bundle

Returns:

Intent object to launch activity.

getAddToCartActivityIntent

public static android.content.Intent getAddToCartActivityIntent(android.content.Context context,
                                                                Message message)

Get the activity marked as cart activity inside the configuration object with extras

Parameters:

context - Application's context to get configuration object

message - Message object to get values required to add inside bundle

Returns:

Valid intent object to launch

getViewCartActivityIntent

public static android.content.Intent getViewCartActivityIntent(android.content.Context context,
                                                               Message message)

Get the activity marked as cart activity inside the configuration object

Parameters:

context - Application's context to get configuration object

message - Message object to get values required to add inside bundle

Returns:

Valid intent object to launch

getViewProductActivityIntent

public static android.content.Intent getViewProductActivityIntent(android.content.Context context,
                                                                  Message message)

Get the activity marked as product details activity inside the configuration object with extras

Parameters:

context - Application's context to get configuration object

message - Message object to get values required to add inside bundle

Returns:

Valid intent object to launch

getViewOffersActivityIntent

public static android.content.Intent getViewOffersActivityIntent(android.content.Context context,
                                                                 Message message)

Get the activity marked as offer display activity inside the configuration object

Parameters:

context - Application's context to get configuration object

message - Message object to get values required to add inside bundle

Returns:

Valid intent object to launch

getOpenAppIntent

public static android.content.Intent getOpenAppIntent(android.content.Context context,
                                                      Message message)

Get the activity marked as LAUNCHER in the AndroidManifest.xml

Parameters:

context - Application's context to get configuration object

message - Message object to get values required to add inside bundle

Returns:

Valid intent object to launch

loadScaledBitmap

public static android.graphics.Bitmap loadScaledBitmap(java.lang.String url,
                                                       int reqWidth,
                                                       int reqHeight)

processNotificationClick

public static boolean processNotificationClick(android.content.Context context,
                                               java.lang.String action,
                                               android.os.Bundle bundle)

This is a helper method that can decide what needs to be done when someone clicks on push msg. This method is being called by the sdk from the BlueshiftNotificationEventsActivity The host app can make use of this method if they would like to override the clicks on push msg.

Parameters:

context - valid context object

action - action from the intent

bundle - bundle inside the intent

Returns:

true: if the click was handled by the sdk, false: if the click was not handled by the sdk.

processNotificationClick

public static boolean processNotificationClick(android.content.Context context,
                                               android.content.Intent intent)

Simplified version of processNotificationClick(context, action, bundle)

Parameters:

context - valid context object

intent - valid intent

invokePushDelivered

public static void invokePushDelivered(android.content.Context context,
                                       Message message)

This helper method allows the sdk to call the listener method (if provided) along with internal tracking method for push delivered.

Parameters:

context - valid Context object

message - valid Message object

invokePushClicked

public static void invokePushClicked(android.content.Context context,
                                     Message message,
                                     java.lang.String clickUrl)

This helper method allows the sdk to call the listener method (if provided) along with internal tracking method for push click.

Parameters:

context - valid Context object

message - valid Message object