Essential Kit
Loading...
Searching...
No Matches
NotificationBuilder

Builder class for INotification objects. Provides a convenient way to set the various fields of a INotification.

Public Member Functions

NotificationBuilder SetTitle (string value)
 Sets the title property of notification.
 
NotificationBuilder SetSubtitle (string value)
 Sets the subtitle property of notification.
 
NotificationBuilder SetBody (string value)
 Sets the body property of notification.
 
NotificationBuilder SetBadge (int value)
 Sets the badge property of notification.
 
NotificationBuilder SetUserInfo (Dictionary< string, string > value)
 Sets the custom userinfo property of notification.
 
NotificationBuilder SetUserInfo (params KeyValuePair< string, string >[] values)
 Sets the custom userinfo property of notification.
 
NotificationBuilder SetSoundFileName (string value)
 Sets the sound filename property of notification.
 
NotificationBuilder SetIosProperties (NotificationIosProperties value)
 Sets the iOS specific properties of notification.
 
NotificationBuilder SetAndroidProperties (NotificationAndroidProperties value)
 Sets the android specific properties of notification.
 
NotificationBuilder SetTimeIntervalNotificationTrigger (double interval, bool repeats=false)
 Adds the time interval based trigger.
 
NotificationBuilder SetCalendarNotificationTrigger (DateComponents dateComponent, bool repeats=false)
 Adds the date time based trigger.
 
NotificationBuilder SetLocationNotificationTrigger (CircularRegion region, bool notifyOnEntry, bool notifyOnExit, bool repeats=false)
 Adds the location based trigger.
 
NotificationBuilder SetPriority (NotificationPriority priority)
 Sets the priority of notification.
 
INotification Create ()
 Returns newly created IMutableNotification instance.
 

Static Public Member Functions

static NotificationBuilder CreateNotification (string notificationId)
 Initializes a new instance of the NotificationBuilder class.
 

Member Function Documentation

◆ CreateNotification()

static NotificationBuilder CreateNotification ( string notificationId)
static
Parameters
notificationIdThe unique identifier for this notification.

Referenced by NotificationServices.CreateNotificationWithId().

◆ SetTitle()

NotificationBuilder SetTitle ( string value)
Parameters
valueValue.

◆ SetSubtitle()

NotificationBuilder SetSubtitle ( string value)
Parameters
valueValue.

◆ SetBody()

NotificationBuilder SetBody ( string value)
Parameters
valueValue.

◆ SetBadge()

NotificationBuilder SetBadge ( int value)
Parameters
valueValue.

◆ SetUserInfo() [1/2]

NotificationBuilder SetUserInfo ( Dictionary< string, string > value)
Parameters
valueValue.

◆ SetUserInfo() [2/2]

NotificationBuilder SetUserInfo ( params KeyValuePair< string, string >[] values)
Parameters
valuesKey value pair values.

◆ SetSoundFileName()

NotificationBuilder SetSoundFileName ( string value)
Parameters
valueValue.

◆ SetIosProperties()

Parameters
valueValue.

◆ SetAndroidProperties()

NotificationBuilder SetAndroidProperties ( NotificationAndroidProperties value)
Parameters
valueValue.

◆ SetTimeIntervalNotificationTrigger()

NotificationBuilder SetTimeIntervalNotificationTrigger ( double interval,
bool repeats = false )
Parameters
intervalThe time (in seconds) that must elapse from the current time before the trigger fires.
repeatsIf set to true repeats.

◆ SetCalendarNotificationTrigger()

NotificationBuilder SetCalendarNotificationTrigger ( DateComponents dateComponent,
bool repeats = false )
Returns
The date time based trigger.
Parameters
dateComponentThe time when notification is triggered for first time.
repeatsIf set to true repeats.

◆ SetLocationNotificationTrigger()

NotificationBuilder SetLocationNotificationTrigger ( CircularRegion region,
bool notifyOnEntry,
bool notifyOnExit,
bool repeats = false )
Returns
The location based trigger.
Parameters
regionThe geographic region that must be entered or exited.
notifyOnEntryIf set to true notify on entry.
notifyOnExitIf set to true notify on exit.
repeatsIf set to true repeats.

◆ SetPriority()

NotificationBuilder SetPriority ( NotificationPriority priority)
Parameters
priorityValue representing the priority of the notification.
Returns