Class PocketNotificationMessage
Describes behaviour and content for a push notification message
Carrier object for PocketNotificationMessage. Services for the PocketNotificationMessage Carrier is available from the IPocketAgent.Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class PocketNotificationMessage : Object
Constructors
PocketNotificationMessage()
Default constructor
Declaration
public PocketNotificationMessage()
See Also
Properties
Date
If the message is about some event happening at a specific date and time
Declaration
public virtual DateTime Date { get; set; }
Property Value
Type | Description |
---|---|
DateTime |
See Also
Duration
Specify duration of the event
Declaration
public virtual TimeSpan Duration { get; set; }
Property Value
Type | Description |
---|---|
TimeSpan |
See Also
ExtraValues
Additional key/value properties to include in the message
Declaration
public virtual StringDictionary ExtraValues { get; set; }
Property Value
Type | Description |
---|---|
StringDictionary |
See Also
Message
The notification message body
Declaration
public virtual string Message { get; set; }
Property Value
Type | Description |
---|---|
String |
See Also
RecordId
If the message is about some specific database record, this could be its primary key
Declaration
public virtual int RecordId { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
See Also
Silent
Indicates wether or not the message will vibrate/play a sound when delivered
Declaration
public virtual bool Silent { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
See Also
TimeToLive
Specifies how many minutes the message should be valid
Declaration
public virtual int TimeToLive { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
See Also
Title
Title for the notification
Declaration
public virtual string Title { get; set; }
Property Value
Type | Description |
---|---|
String |
See Also
Type
The type of notification this is
Declaration
public virtual NotificationMessageType Type { get; set; }
Property Value
Type | Description |
---|---|
NotificationMessageType |
See Also
Url
An url associated with the notification that will be handled by Pocket
Declaration
public virtual string Url { get; set; }
Property Value
Type | Description |
---|---|
String |
See Also
Methods
ToString()
Returns the carrier contents as a formatted string.
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
String | The carrier contents. |
See Also
ToString(String)
Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.
Declaration
public string ToString(string prefix)
Parameters
Type | Name | Description |
---|---|---|
String | prefix | The line prefix (typically used for indenting) |
Returns
Type | Description |
---|---|
String | The carrier contents. |