Class NSPocketNotificationMessage
Describes behavior and content for a push notification message.
Constructors
NSPocketNotificationMessage()
Initializes a new instance of the NSPocketNotificationMessage class.
Declaration
NSPocketNotificationMessageMethods
GetDate()
Declaration
DateTime GetDate()Examples
NSPocketNotificationMessage thing;
DateTime date = thing.GetDate();Returns
| Type | Description |
| DateTime | If the message is about some event happening at a specific date and time. |
GetDuration()
Declaration
TimeSpan GetDuration()Examples
NSPocketNotificationMessage thing;
TimeSpan duration = thing.GetDuration();Returns
| Type | Description |
| TimeSpan | Specify duration of the event. |
GetExtraValues()
Declaration
Map GetExtraValues()Examples
NSPocketNotificationMessage thing;
Map extraValues = thing.GetExtraValues();Returns
| Type | Description |
| Map | Additional key/value properties to include in the message. |
GetMessage()
Declaration
String GetMessage()Examples
NSPocketNotificationMessage thing;
String message = thing.GetMessage();Returns
| Type | Description |
| String | The notification message body. |
GetRecordId()
Declaration
Integer GetRecordId()Examples
NSPocketNotificationMessage thing;
Integer recordId = thing.GetRecordId();Returns
| Type | Description |
| Integer | If the message is about some specific database record, this could be its primary key. |
GetSilent()
Declaration
Bool GetSilent()Examples
NSPocketNotificationMessage thing;
Bool silent = thing.GetSilent();Returns
| Type | Description |
| Bool | Indicates wether or not the message will vibrate/play a sound when delivered. |
GetTimeToLive()
Declaration
Integer GetTimeToLive()Examples
NSPocketNotificationMessage thing;
Integer timeToLive = thing.GetTimeToLive();Returns
| Type | Description |
| Integer | Specifies how many minutes the message should be valid. |
GetTitle()
Declaration
String GetTitle()Examples
NSPocketNotificationMessage thing;
String title = thing.GetTitle();Returns
| Type | Description |
| String | Title for the notification. |
GetType()
Declaration
Integer GetType()Examples
NSPocketNotificationMessage thing;
Integer type = thing.GetType();Returns
| Type | Description |
| Integer | The type of notification this is. See <xref href="CRMScript.NetServer.NotificationMessageType" data-throw-if-not-resolved="false"></xref>. |
GetUrl()
Declaration
String GetUrl()Examples
NSPocketNotificationMessage thing;
String url = thing.GetUrl();Returns
| Type | Description |
| String | A URL associated with the notification that will be handled by Pocket. |
SetDate(DateTime)
Declaration
Void SetDate(DateTime date)Examples
NSPocketNotificationMessage thing;
DateTime date;
thing.SetDate(date);Parameters
| Type | Name | Description |
| DateTime | date | If the message is about some event happening at a specific date and time. |
Returns
| Type | Description |
| Void |
SetDuration(TimeSpan)
Declaration
Void SetDuration(TimeSpan duration)Examples
NSPocketNotificationMessage thing;
TimeSpan duration;
thing.SetDuration(duration);Parameters
| Type | Name | Description |
| TimeSpan | duration | Specify duration of the event. |
Returns
| Type | Description |
| Void |
SetExtraValues(Map)
Declaration
Void SetExtraValues(Map extraValues)Examples
NSPocketNotificationMessage thing;
Map extraValues;
thing.SetExtraValues(extraValues);Parameters
| Type | Name | Description |
| Map | extraValues | Additional key/value properties to include in the message. |
Returns
| Type | Description |
| Void |
SetMessage(String)
Declaration
Void SetMessage(String message)Examples
NSPocketNotificationMessage thing;
String message;
thing.SetMessage(message);Parameters
| Type | Name | Description |
| String | message | The notification message body. |
Returns
| Type | Description |
| Void |
SetRecordId(Integer)
Declaration
Void SetRecordId(Integer recordId)Examples
NSPocketNotificationMessage thing;
Integer recordId;
thing.SetRecordId(recordId);Parameters
| Type | Name | Description |
| Integer | recordId | If the message is about some specific database record, this could be its primary key. |
Returns
| Type | Description |
| Void |
SetSilent(Bool)
Declaration
Void SetSilent(Bool silent)Examples
NSPocketNotificationMessage thing;
Bool silent;
thing.SetSilent(silent);Parameters
| Type | Name | Description |
| Bool | silent | Indicates wether or not the message will vibrate/play a sound when delivered. |
Returns
| Type | Description |
| Void |
SetTimeToLive(Integer)
Declaration
Void SetTimeToLive(Integer timeToLive)Examples
NSPocketNotificationMessage thing;
Integer timeToLive;
thing.SetTimeToLive(timeToLive);Parameters
| Type | Name | Description |
| Integer | timeToLive | Specifies how many minutes the message should be valid. |
Returns
| Type | Description |
| Void |
SetTitle(String)
Declaration
Void SetTitle(String title)Examples
NSPocketNotificationMessage thing;
String title;
thing.SetTitle(title);Parameters
| Type | Name | Description |
| String | title | Title for the notification. |
Returns
| Type | Description |
| Void |
SetType(Integer)
Declaration
Void SetType(Integer type)Examples
NSPocketNotificationMessage thing;
Integer type;
thing.SetType(type);Parameters
| Type | Name | Description |
| Integer | type | The type of notification this is. See <xref href="CRMScript.NetServer.NotificationMessageType" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |