Detailed Description

Helper class for displaying notifications.

Since: 6.1

Classes
interface	BuilderHelper

class	Options
	Parameters for draining a notification. More...

Static Public Member Functions
static void	setVibePattern (long[] pattern)
	Set vibration pattern to be used. More...

static void	setLauncherClass (Class activityToLaunch)
	Set activity class to launch when clicking on notifications. More...

static void	setDefaultIcon (int iconId)
	Set defalt icon used in notifications from this class. More...

static void	createNotification (Context context, String notificationChannel, int notificationId, String title)
	Create a notification. More...

static void	createNotification (Context context, String notificationChannel, int notificationId, String title, String message)
	Create a notification. More...

static void	createNotification (Context context, String notificationChannel, int notificationId, String title, String message, String subtext)
	Create a notification. More...

static void	createNotification (Context context, String notificationChannel, int notificationId, String title, String message, String subtext, BuilderHelper nbh)
	Create a notification. More...

static void	createBackgroundActivityNotification (Context context, String notificationChannel, int notificationId, String title, String message, PendingIntent pendingIntent)
	Create a fullscreen notification from the background. More...

static void	createNotification (Context context, Options options)
	Create a notification. More...

static void	createBackgroundActivityNotification (Context context, Options options)
	Create a fullscreen notification from the background. More...

static void	clear (Context context, int notificationId)
	Clear a notification. More...

static void	clear (Context context, String notificationTag, int notificationId)
	Clear a notification. More...

Member Function Documentation

◆ clear() [1/2]

static void com.speedify.speedifysdk.NotificationHelper.clear	(	Context	context,
		int	notificationId
	)

static

Clear a notification.

Parameters

context	context used to launch notification
notificationId	unique identifier for the notification to clear

Since: 9.3

◆ clear() [2/2]

static void com.speedify.speedifysdk.NotificationHelper.clear	(	Context	context,
		String	notificationTag,
		int	notificationId
	)

static

Clear a notification.

Parameters

context	context used to launch notification
notificationTag	tag for the notification to clear
notificationId	unique identifier for the notification to clear

Since: 14.0

◆ createBackgroundActivityNotification() [1/2]

static void com.speedify.speedifysdk.NotificationHelper.createBackgroundActivityNotification	(	Context	context,
		String	notificationChannel,
		int	notificationId,
		String	title,
		String	message,
		PendingIntent	pendingIntent
	)

static

Create a fullscreen notification from the background.

Parameters

context	context used to launch notification
notificationChannel	channel group for this notification
notificationId	unique identifier for this notification
title	notification title
message	notification message
pendingIntent	intent this fullscreen notification should launch

Since: 8.1

Deprecated:: As of 14.0. use createBackgroundActivityNotification(Context, Options) instead

◆ createBackgroundActivityNotification() [2/2]

static void com.speedify.speedifysdk.NotificationHelper.createBackgroundActivityNotification	(	Context	context,
		Options	options
	)

static

Create a fullscreen notification from the background.

Parameters

context	context used to launch notification
options	notification options

Since: 14.0

◆ createNotification() [1/5]

static void com.speedify.speedifysdk.NotificationHelper.createNotification	(	Context	context,
		String	notificationChannel,
		int	notificationId,
		String	title
	)

static

Create a notification.

Parameters

context	context used to launch notification
notificationChannel	channel group for this notification
notificationId	unique identifier for this notification
title	notification title

Since: 6.1

Deprecated:: As of 14.0. use createNotification(Context, Options) instead

◆ createNotification() [2/5]

static void com.speedify.speedifysdk.NotificationHelper.createNotification	(	Context	context,
		String	notificationChannel,
		int	notificationId,
		String	title,
		String	message
	)

static

Create a notification.

Parameters

context	context used to launch notification
notificationChannel	channel group for this notification
notificationId	unique identifier for this notification
title	notification title
message	notification message

Since: 6.1

Deprecated:: As of 14.0. use createNotification(Context, Options) instead

◆ createNotification() [3/5]

static void com.speedify.speedifysdk.NotificationHelper.createNotification	(	Context	context,
		String	notificationChannel,
		int	notificationId,
		String	title,
		String	message,
		String	subtext
	)

static

Create a notification.

Parameters

context	context used to launch notification
notificationChannel	channel group for this notification
notificationId	unique identifier for this notification
title	notification title
message	notification message
subtext	notification subtext

Since: 6.1

Deprecated:: As of 14.0. use createNotification(Context, Options) instead

◆ createNotification() [4/5]

static void com.speedify.speedifysdk.NotificationHelper.createNotification	(	Context	context,
		String	notificationChannel,
		int	notificationId,
		String	title,
		String	message,
		String	subtext,
		BuilderHelper	nbh
	)

static

Create a notification.

Parameters

context	context used to launch notification
notificationChannel	channel group for this notification
notificationId	unique identifier for this notification
title	notification title
message	notification message
subtext	notification subtext
nbh	handler providing access to the base NotificationCompat.Builder object for further customization

Since: 11.1

Deprecated:: As of 14.0. use createNotification(Context, Options) instead

◆ createNotification() [5/5]

static void com.speedify.speedifysdk.NotificationHelper.createNotification	(	Context	context,
		Options	options
	)

static

Create a notification.

Parameters

context	context used to launch notification
options	notification options

Since: 14.0

◆ setDefaultIcon()

static void com.speedify.speedifysdk.NotificationHelper.setDefaultIcon ( int iconId )

static

Set defalt icon used in notifications from this class.

Parameters

iconId resource id of icon to use

Since: 9.3.1

◆ setLauncherClass()

static void com.speedify.speedifysdk.NotificationHelper.setLauncherClass ( Class activityToLaunch )

static

Set activity class to launch when clicking on notifications.

Null to disable.

Parameters

activityToLaunch actvity class to launch

Since: 6.1

◆ setVibePattern()

static void com.speedify.speedifysdk.NotificationHelper.setVibePattern ( long [] pattern )

static

Set vibration pattern to be used.

A null or empty array disabled vibration.

Parameters

pattern vibration pattern

Since: 6.1

The documentation for this class was generated from the following file:

src/main/java/com/speedify/speedifysdk/util/NotificationHelper.java

Detailed Description

Classes

Static Public Member Functions

Member Function Documentation

◆ clear() [1/2]

◆ clear() [2/2]

◆ createBackgroundActivityNotification() [1/2]

◆ createBackgroundActivityNotification() [2/2]

◆ createNotification() [1/5]

◆ createNotification() [2/5]

◆ createNotification() [3/5]

◆ createNotification() [4/5]

◆ createNotification() [5/5]

◆ setDefaultIcon()

◆ setLauncherClass()

◆ setVibePattern()