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

Local notification. More...

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

Public Member Functions

 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...
 
virtual JSONClass ToJson ()
 Converts to a notification json. 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...
 

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

Detailed Description

Local notification.

Constructor & Destructor Documentation

◆ LocalNotification() [1/3]

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.

Parameters
titleTitle.
textText.
idId.
userDataUser data (optional).
notificationProfileNotification profile (optional).
badgeNumberBadge number.
buttonsButtons (optional).

◆ LocalNotification() [2/3]

UTNotifications.LocalNotification.LocalNotification ( string  title,
string  text,
int  id 
)

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

Parameters
titleTitle.
textText.
idId.

◆ LocalNotification() [3/3]

UTNotifications.LocalNotification.LocalNotification ( JSONNode  json)

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

Parameters
jsonNotification json.

Member Function Documentation

◆ SetBadgeNumber()

new LocalNotification UTNotifications.LocalNotification.SetBadgeNumber ( int  badgeNumber)

Sets the badge number.

Returns
this.
Parameters
badgeNumberBadge number.

◆ SetButtons()

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

this.

Returns
The buttons.
Parameters
buttonsButtons.

◆ SetNotificationProfile()

new LocalNotification UTNotifications.LocalNotification.SetNotificationProfile ( string  notificationProfile)

Sets the notification profile.

Returns
this.
Parameters
notificationProfileNotification profile.

◆ SetUserData()

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

Sets the user data.

Returns
this.
Parameters
userDataUser data.

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