NotificationContent - fullphat/snarl_network_protocol GitHub Wiki

A NotificationContent object describes a notification to be displayed by Snarl. Most properties are optional and need not be included in the request.

Used By

• POST /v2/notifications

Syntax

{
  "AppId": null,
  "EventId": null,
  "Title": null,
  "Text": null,
  "SubText": null,
  "Icons": {
    "Stock": null,
    "File": null,
    "Encoded": null,
    "App": null,
    "Resource": null,
    "Url": null,
    "Base64": null
  },
  "Priority": null,
  "Sticky": null,
  "CallbackButtonLabel": null,
  "Callbacks": {
    "OnInvoked": null,
    "OnExpired": null,
    "OnDismissed": null,
    "OnSnoozed": null
  },
  "Sound": null,
  "Uid": null,
  "DisplayMode": 0,
  "ScheduledFor": "2019-03-29T08:37:30.2142767+00:00",
  "ReplyPort": null,
  "Options": [],
  "Headers": {},
  "Data": {}
}

Properties

Name	Type	Description
AppId	String	Required. The application identifier.
Title	String	Required. The name of the application.
ConfigurationUrl	String	URL to the application's configuration page, if it supports this feature.
Description	String	Provides more information about the application.
Events	List	List of EventContent objects that specify event classes to be added.
Icon	String	Specifies the icon to use. Can be a URL, file path, or stock icon.
Version	String	Free-form string that indicates the version number of the application.

    public enum NotificationDisplayMode
    {
        Normal,
        Replace,
        Update,
        Merge
    }

Example

{
  "AppId": "foo",
  "Title": "App Foo",
  "Icon": "!misc-chair",
  "Description": "This is application Foo",
  "Version": "6.1.2.3.foo",
}