UTNotifications.PushNotification Class Reference

Push notification. More...

Inheritance diagram for UTNotifications.PushNotification:

Public Member Functions
	PushNotification (PushNotificationsProvider provider, 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.PushNotification class. More...
	PushNotification (PushNotificationsProvider provider, string title, string text, int id)
	Initializes a new instance of the T:UTNotifications.PushNotification class. More...
	PushNotification (JSONNode json)
	Initializes a new instance of the T:UTNotifications.PushNotification class. More...
override JSONClass	ToJson ()
	Converts to a notification json. More...
new PushNotification	SetUserData (IDictionary< string, string > userData)
	Sets the user data. More...
new PushNotification	SetNotificationProfile (string notificationProfile)
	Sets the notification profile. More...
new PushNotification	SetBadgeNumber (int badgeNumber)
	Sets the badge number. More...
new PushNotification	SetButtons (ICollection< Button > buttons)
	Sets the buttons. 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 PushNotificationsProvider	provider
	The push notifications provider that delivered the notification: APNS / FCM / ADM / WNS. 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...

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...
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...

Detailed Description

Push notification.

Constructor & Destructor Documentation

PushNotification() [1/3]

UTNotifications.PushNotification.PushNotification	(	PushNotificationsProvider	provider,
		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.PushNotification class.

Parameters

provider	Push notifications provider.
title	Title.
text	Text.
id	Id.
userData	User data (optional).
notificationProfile	Notification profile (optional).
badgeNumber	Badge number.
buttons	Buttons (optional).

PushNotification() [2/3]

UTNotifications.PushNotification.PushNotification	(	PushNotificationsProvider	provider,
		string	title,
		string	text,
		int	id
	)

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

Parameters

provider	Push notifications provider.
title	Title.
text	Text.
id	Id.

PushNotification() [3/3]

UTNotifications.PushNotification.PushNotification

(

JSONNode

json

)

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

Parameters

json	Notification json.

Member Function Documentation

SetBadgeNumber()

new PushNotification UTNotifications.PushNotification.SetBadgeNumber

(

int

badgeNumber

)

Sets the badge number.

Returns

this.

Parameters

badgeNumber

Badge number.

SetButtons()

new PushNotification UTNotifications.PushNotification.SetButtons

(

ICollection< Button >

buttons

)

Sets the buttons.

Returns

this.

Parameters

buttons

Buttons.

SetNotificationProfile()

new PushNotification UTNotifications.PushNotification.SetNotificationProfile

(

string

notificationProfile

)

Sets the notification profile.

Returns

this.

Parameters

notificationProfile

Notification profile.

SetUserData()

new PushNotification UTNotifications.PushNotification.SetUserData

(

IDictionary< string, string >

userData

)

Sets the user data.

Returns

this.

Parameters

userData

User data.

ToJson()

override JSONClass UTNotifications.PushNotification.ToJson ( )

virtual

Converts to a notification json.

Returns

The json.

Reimplemented from UTNotifications.Notification.

Member Data Documentation

provider

readonly PushNotificationsProvider UTNotifications.PushNotification.provider

The push notifications provider that delivered the notification: APNS / FCM / ADM / WNS.

---

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

• Assets/UTNotifications/Src/NotificationTypes.cs