Package org.cyclos.impl.utils.notifications

Interface CustomNotificationSender

public interface CustomNotificationSender

Allows scripts to send custom notifications.

Method Summary

Modifier and Type	Method	Description
CustomNotificationSender	app(String title, String body)	Enables mobile app notification, setting its title and body
CustomNotificationSender	appAndroidIconColor(String color)	If mobile app notification is enabled, sets the icon color for Android devices
CustomNotificationSender	appCustomUrl(String customUrl)	If mobile app notification is enabled, sets the custom schema URL for the application to load when the notification is clicked
CustomNotificationSender	appImageUrl(String imageUrl)	If mobile app notification is enabled, sets the image URL displayed in the notification
CustomNotificationSender	appIosUseBadge(boolean useBadge)	If mobile app notification is enabled, sets whether the badge should be updated in iOS devices
CustomNotificationSender	appVariable(String key, String value)	If mobile app notification is enabled, sets a variable that is sent to the mobile app
CustomNotificationSender	email(String subject, String body)	Enables email notification and sets its subject and body
CustomNotificationSender	emailAttachment(FileInfo file)	If email notification is enabled, adds an attachment to the email
void	send()	Sends the notification in the background
CustomNotificationResult	sendSync()	Sends the notification immediately, blocking the current thread until notification is sent through all requested mediums
CustomNotificationSender	sms(String message)	Enables SMS notification and sets its message
CustomNotificationSender	smsEvenIfDisabled()	When called, SMS notifications will be delivered even to mobile phones which are not enabled for SMS

Method Detail

app

CustomNotificationSender app(String title,
                             String body)

Enables mobile app notification, setting its title and body

appAndroidIconColor

CustomNotificationSender appAndroidIconColor(String color)

If mobile app notification is enabled, sets the icon color for Android devices

appCustomUrl

CustomNotificationSender appCustomUrl(String customUrl)

If mobile app notification is enabled, sets the custom schema URL for the application to load when the notification is clicked

appImageUrl

CustomNotificationSender appImageUrl(String imageUrl)

If mobile app notification is enabled, sets the image URL displayed in the notification

appIosUseBadge

CustomNotificationSender appIosUseBadge(boolean useBadge)

If mobile app notification is enabled, sets whether the badge should be updated in iOS devices

appVariable

CustomNotificationSender appVariable(String key,
                                     String value)

If mobile app notification is enabled, sets a variable that is sent to the mobile app

email

CustomNotificationSender email(String subject,
                               String body)

Enables email notification and sets its subject and body

emailAttachment

CustomNotificationSender emailAttachment(FileInfo file)

If email notification is enabled, adds an attachment to the email

send

void send()

Sends the notification in the background

sendSync

CustomNotificationResult sendSync()

Sends the notification immediately, blocking the current thread until notification is sent through all requested mediums

sms

CustomNotificationSender sms(String message)

Enables SMS notification and sets its message

smsEvenIfDisabled

CustomNotificationSender smsEvenIfDisabled()

When called, SMS notifications will be delivered even to mobile phones which are not enabled for SMS