PushNotifications::Settings Struct Reference

Describes settings we want to use for current device. More...

Classes
struct	Category
	Describes a category of a notification. More...

Public Types
using	Action = Notification::Action

Public Attributes
bool	allowSound = false
	whether the app should play a sound upon notification
bool	allowAlert = false
	whether the app should present an alert upon notification
bool	allowBadge = false
	whether the app may badge its icon upon notification
Array< Category >	categories
	list of categories the app wants to support

Detailed Description

Describes settings we want to use for current device.

Note that at the moment this is only used on iOS and partially on OSX.

On OSX only allow* flags are used and they control remote notifications only. To control sound, alert and badge settings for local notifications on OSX, use Notifications settings in System Preferences.

To setup push notifications for current device, provide permissions required, as well as register categories of notifications you want to support. Each category needs to have a unique identifier and it can optionally have multiple actions. Each action also needs to have a unique identifier. The example setup may look as follows:

using Action   = PushNotifications::Settings::Action;
using Category = PushNotifications::Settings::Category;
 
Action okAction;
okAction.identifier = "okAction";
okAction.title = "OK!";
okAction.style = Action::button;
okAction.triggerInBackground = true;
 
Action cancelAction;
cancelAction.identifier = "cancelAction";
cancelAction.title = "Cancel";
cancelAction.style = Action::button;
cancelAction.triggerInBackground = true;
cancelAction.destructive = true;
 
Action textAction;
textAction.identifier = "textAction";
textAction.title = "Enter text";
textAction.style = Action::text;
textAction.triggerInBackground = true;
textAction.destructive = false;
textAction.textInputButtonText = "Ok";
textAction.textInputPlaceholder = "Enter text...";
 
Category okCategory;
okCategory.identifier = "okCategory";
okCategory.actions = { okAction };
 
Category okCancelCategory;
okCancelCategory.identifier = "okCancelCategory";
okCancelCategory.actions = { okAction, cancelAction };
 
Category textCategory;
textCategory.identifier = "textCategory";
textCategory.actions = { textAction };
textCategory.sendDismissAction = true;
 
PushNotifications::Settings settings;
settings.allowAlert = true;
settings.allowBadge = true;
settings.allowSound = true;
settings.categories = { okCategory, okCancelCategory, textCategory };

Member Typedef Documentation

Action

using PushNotifications::Settings::Action = Notification::Action

Member Data Documentation

allowSound

bool PushNotifications::Settings::allowSound = false

whether the app should play a sound upon notification

allowAlert

bool PushNotifications::Settings::allowAlert = false

whether the app should present an alert upon notification

allowBadge

bool PushNotifications::Settings::allowBadge = false

whether the app may badge its icon upon notification

categories

Array<Category> PushNotifications::Settings::categories

list of categories the app wants to support