UTNotifications  1.8
Professional Local & Push Notification Plugin
Public Member Functions | Public Attributes | Properties | List of all members
UTNotifications.ScheduledRepeatingNotification Class Reference

Scheduled repeating notification. More...

Inheritance diagram for UTNotifications.ScheduledRepeatingNotification:
UTNotifications.ScheduledNotification UTNotifications.LocalNotification UTNotifications.Notification

Public Member Functions

 ScheduledRepeatingNotification (DateTime triggerDateTime, int intervalSeconds, string title, string text, int id, IDictionary< string, string > userData, string notificationProfile, int badgeNumber, ICollection< Button > buttons)
 Initializes a new instance of the T:UTNotifications.ScheduledRepeatingNotification class. More...
 
 ScheduledRepeatingNotification (DateTime triggerDateTime, int intervalSeconds, string title, string text, int id)
 Initializes a new instance of the T:UTNotifications.ScheduledRepeatingNotification class. More...
 
 ScheduledRepeatingNotification (JSONNode json)
 Initializes a new instance of the T:UTNotifications.ScheduledRepeatingNotification class. More...
 
override JSONClass ToJson ()
 Converts to a notification json. More...
 
new ScheduledRepeatingNotification SetUserData (IDictionary< string, string > userData)
 Sets the user data. More...
 
new ScheduledRepeatingNotification SetNotificationProfile (string notificationProfile)
 Sets the notification profile. More...
 
new ScheduledRepeatingNotification SetBadgeNumber (int badgeNumber)
 Sets the badge number. More...
 
new ScheduledRepeatingNotification SetButtons (ICollection< Button > buttons)
 Sets the buttons. More...
 
- Public Member Functions inherited from UTNotifications.ScheduledNotification
 ScheduledNotification (DateTime triggerDateTime, string title, string text, int id, IDictionary< string, string > userData, string notificationProfile, int badgeNumber, ICollection< Button > buttons)
 Initializes a new instance of the T:UTNotifications.ScheduledNotification class. More...
 
 ScheduledNotification (DateTime triggerDateTime, string title, string text, int id)
 Initializes a new instance of the T:UTNotifications.ScheduledNotification class. More...
 
 ScheduledNotification (JSONNode json)
 Initializes a new instance of the T:UTNotifications.ScheduledNotification class. More...
 
new ScheduledNotification SetUserData (IDictionary< string, string > userData)
 Sets the user data. More...
 
new ScheduledNotification SetNotificationProfile (string notificationProfile)
 Sets the notification profile. More...
 
new ScheduledNotification SetBadgeNumber (int badgeNumber)
 Sets the badge number. More...
 
new ScheduledNotification SetButtons (ICollection< Button > buttons)
 Sets the buttons. More...
 
- Public Member Functions inherited from UTNotifications.LocalNotification
 LocalNotification (string title, string text, int id, IDictionary< string, string > userData, string notificationProfile, int badgeNumber, ICollection< Button > buttons)
 Initializes a new instance of the T:UTNotifications.LocalNotification class. More...
 
 LocalNotification (string title, string text, int id)
 Initializes a new instance of the T:UTNotifications.LocalNotification class. More...
 
 LocalNotification (JSONNode json)
 Initializes a new instance of the T:UTNotifications.LocalNotification class. More...
 
new LocalNotification SetUserData (IDictionary< string, string > userData)
 Sets the user data. More...
 
new LocalNotification SetNotificationProfile (string notificationProfile)
 Sets the notification profile. More...
 
new LocalNotification SetBadgeNumber (int badgeNumber)
 Sets the badge number. More...
 
new LocalNotification SetButtons (ICollection< Button > buttons)
 this. More...
 
- Public Member Functions inherited from UTNotifications.Notification
 Notification (string title, string text, int id)
 Initializes a new instance of the T:UTNotifications.Notification class. More...
 
 Notification (string title, string text, int id, IDictionary< string, string > userData, string notificationProfile, int badgeNumber, ICollection< Button > buttons)
 Initializes a new instance of the T:UTNotifications.Notification class. More...
 
 Notification (JSONNode json)
 Initializes a new instance of the T:UTNotifications.Notification class. More...
 
Notification SetUserData (IDictionary< string, string > userData)
 Sets the user data. More...
 
Notification SetNotificationProfile (string notificationProfile)
 Sets the notification profile. More...
 
Notification SetBadgeNumber (int badgeNumber)
 Sets the badge number. More...
 
Notification SetButtons (ICollection< Button > buttons)
 Sets the buttons. More...
 
override string ToString ()
 Returns a T:System.String that represents the current T:UTNotifications.Notification. More...
 

Public Attributes

readonly int intervalSeconds
 The interval repeating interval in seconds. More...
 
- Public Attributes inherited from UTNotifications.ScheduledNotification
readonly DateTime triggerDateTime
 Date time (in device local time zone) the notification is scheduled for / was shown. More...
 
- Public Attributes inherited from UTNotifications.Notification
const int BADGE_NOT_SPECIFIED = -1
 Use instead of a badge number to keep the previous badge number. More...
 
readonly string title
 The title. More...
 
readonly string text
 The text. More...
 
readonly int id
 The id. More...
 

Properties

override bool IsRepeating [get]
 Gets a value indicating whether this T:UTNotifications.ScheduledRepeatingNotification is repeating (i.e. intervalSeconds > 0). More...
 
- Properties inherited from UTNotifications.ScheduledNotification
virtual bool IsRepeating [get]
 Gets a value indicating whether this T:UTNotifications.ScheduledNotification is repeating. More...
 
- Properties inherited from UTNotifications.Notification
IDictionary< string, string > userData [get]
 The user data provided by you in Manager.PostLocalNotification, Manager.ScheduleNotification or Manager.ScheduleNotificationRepeating or by your server in a push notification payload. More...
 
string notificationProfile [get]
 The name of the notification profile (sound, icon and other notification attributes). More...
 
int badgeNumber [get]
 The badge number (default value is BADGE_NOT_SPECIFIED). More...
 
ICollection< Buttonbuttons [get]
 Notification buttons (when supported by the platform). More...
 

Additional Inherited Members

- Static Public Member Functions inherited from UTNotifications.Notification
static Notification FromJson (JSONNode json)
 Factory method to create a T:UTNotifications.Notification object from a notification json. More...
 

Detailed Description

Scheduled repeating notification.

Constructor & Destructor Documentation

◆ ScheduledRepeatingNotification() [1/3]

UTNotifications.ScheduledRepeatingNotification.ScheduledRepeatingNotification ( DateTime  triggerDateTime,
int  intervalSeconds,
string  title,
string  text,
int  id,
IDictionary< string, string >  userData,
string  notificationProfile,
int  badgeNumber,
ICollection< Button buttons 
)

Initializes a new instance of the T:UTNotifications.ScheduledRepeatingNotification class.

Parameters
triggerDateTimeDate time (in device local time zone) the notification is scheduled for / was shown the first time.
intervalSecondsInterval seconds.
titleTitle.
textText.
idId.
userDataUser data (optional).
notificationProfileNotification profile (optional).
badgeNumberBadge number.
buttonsButtons (optional).

◆ ScheduledRepeatingNotification() [2/3]

UTNotifications.ScheduledRepeatingNotification.ScheduledRepeatingNotification ( DateTime  triggerDateTime,
int  intervalSeconds,
string  title,
string  text,
int  id 
)

Initializes a new instance of the T:UTNotifications.ScheduledRepeatingNotification class.

Parameters
triggerDateTimeDate time (in device local time zone) the notification is scheduled for / was shown the first time.
intervalSecondsInterval seconds.
titleTitle.
textText.
idId.

◆ ScheduledRepeatingNotification() [3/3]

UTNotifications.ScheduledRepeatingNotification.ScheduledRepeatingNotification ( JSONNode  json)

Initializes a new instance of the T:UTNotifications.ScheduledRepeatingNotification class.

Parameters
jsonNotification json.

Member Function Documentation

◆ SetBadgeNumber()

new ScheduledRepeatingNotification UTNotifications.ScheduledRepeatingNotification.SetBadgeNumber ( int  badgeNumber)

Sets the badge number.

Returns
this.
Parameters
badgeNumberBadge number.

◆ SetButtons()

new ScheduledRepeatingNotification UTNotifications.ScheduledRepeatingNotification.SetButtons ( ICollection< Button buttons)

Sets the buttons.

Returns
this.
Parameters
buttonsButtons.

◆ SetNotificationProfile()

new ScheduledRepeatingNotification UTNotifications.ScheduledRepeatingNotification.SetNotificationProfile ( string  notificationProfile)

Sets the notification profile.

Returns
this.
Parameters
notificationProfileNotification profile.

◆ SetUserData()

new ScheduledRepeatingNotification UTNotifications.ScheduledRepeatingNotification.SetUserData ( IDictionary< string, string >  userData)

Sets the user data.

Returns
this.
Parameters
userDataUser data.

◆ ToJson()

override JSONClass UTNotifications.ScheduledRepeatingNotification.ToJson ( )
virtual

Converts to a notification json.

Returns
The json.

Reimplemented from UTNotifications.ScheduledNotification.

Member Data Documentation

◆ intervalSeconds

readonly int UTNotifications.ScheduledRepeatingNotification.intervalSeconds

The interval repeating interval in seconds.

Please note that the actual interval may be different. On iOS there are only fixed options like every minute, every day, every week and so on. So the provided intervalSeconds value will be approximated by one of the available options.

Property Documentation

◆ IsRepeating

override bool UTNotifications.ScheduledRepeatingNotification.IsRepeating
get

Gets a value indicating whether this T:UTNotifications.ScheduledRepeatingNotification is repeating (i.e. intervalSeconds > 0).

true if is repeating; otherwise, false.


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