UTNotifications.ScheduledNotification Class Reference

Scheduled notification. More...

Inheritance diagram for UTNotifications.ScheduledNotification:

Public Member Functions
	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...
override JSONClass	ToJson ()
	Converts to a notification json. 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 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
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< Button >	buttons [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 notification.

Constructor & Destructor Documentation

ScheduledNotification() [1/3]

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.

Parameters

triggerDateTime	Date time (in device local time zone) the notification is scheduled for / was shown.
title	Title.
text	Text.
id	Id.
userData	User data (optional).
notificationProfile	Notification profile (optional).
badgeNumber	Badge number.
buttons	Buttons (optional).

ScheduledNotification() [2/3]

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

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

Parameters

triggerDateTime	Date time (in device local time zone) the notification is scheduled for / was shown.
title	Title.
text	Text.
id	Id.

ScheduledNotification() [3/3]

UTNotifications.ScheduledNotification.ScheduledNotification

(

JSONNode

json

)

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

Parameters

json	Notification json.

Member Function Documentation

SetBadgeNumber()

new ScheduledNotification UTNotifications.ScheduledNotification.SetBadgeNumber

(

int

badgeNumber

)

Sets the badge number.

Returns

this.

Parameters

badgeNumber

Badge number.

SetButtons()

new ScheduledNotification UTNotifications.ScheduledNotification.SetButtons

(

ICollection< Button >

buttons

)

Sets the buttons.

Returns

this.

Parameters

buttons

Buttons.

SetNotificationProfile()

new ScheduledNotification UTNotifications.ScheduledNotification.SetNotificationProfile

(

string

notificationProfile

)

Sets the notification profile.

Returns

this.

Parameters

notificationProfile

Notification profile.

SetUserData()

new ScheduledNotification UTNotifications.ScheduledNotification.SetUserData

(

IDictionary< string, string >

userData

)

Sets the user data.

Returns

this.

Parameters

userData

User data.

ToJson()

override JSONClass UTNotifications.ScheduledNotification.ToJson ( )

virtual

Converts to a notification json.

Returns

The json.

Reimplemented from UTNotifications.Notification.

Reimplemented in UTNotifications.ScheduledRepeatingNotification.

Member Data Documentation

triggerDateTime

readonly DateTime UTNotifications.ScheduledNotification.triggerDateTime

Date time (in device local time zone) the notification is scheduled for / was shown.

Property Documentation

IsRepeating

virtual bool UTNotifications.ScheduledNotification.IsRepeating

get

Gets a value indicating whether this T:UTNotifications.ScheduledNotification is repeating.

true if is repeating; otherwise, false.

---

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

• Assets/UTNotifications/Src/NotificationTypes.cs