summaryrefslogtreecommitdiffstats
path: root/browser/components/newtab/content-src/asrouter/templates/ToastNotification/ToastNotification.schema.json
blob: c6d917d235e942d8bae928f4da652e10b47d603e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
{
  "$schema": "https://json-schema.org/draft/2019-09/schema",
  "$id": "file:///ToastNotification.schema.json",
  "title": "ToastNotification",
  "description": "A template for toast notifications displayed by the Alert service.",
  "allOf": [{ "$ref": "file:///FxMSCommon.schema.json#/$defs/Message" }],
  "type": "object",
  "properties": {
    "content": {
      "type": "object",
      "properties": {
        "title": {
          "$ref": "file:///FxMSCommon.schema.json#/$defs/localizableText",
          "description": "Id of localized string or message override of toast notification title"
        },
        "body": {
          "$ref": "file:///FxMSCommon.schema.json#/$defs/localizableText",
          "description": "Id of localized string or message override of toast notification body"
        },
        "icon_url": {
          "description": "The URL of the image used as an icon of the toast notification.",
          "type": "string",
          "format": "moz-url-format"
        },
        "image_url": {
          "description": "The URL of an image to be displayed as part of the notification.",
          "type": "string",
          "format": "moz-url-format"
        },
        "launch_url": {
          "description": "The URL to launch when the notification or an action button is clicked.",
          "type": "string",
          "format": "moz-url-format"
        },
        "requireInteraction": {
          "type": "boolean",
          "description": "Whether the toast notification should remain active until the user clicks or dismisses it, rather than closing automatically."
        },
        "tag": {
          "type": "string",
          "description": "An identifying tag for the toast notification."
        },
        "data": {
          "type": "object",
          "description": "Arbitrary data associated with the toast notification."
        },
        "actions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "title": {
                "$ref": "file:///FxMSCommon.schema.json#/$defs/localizableText",
                "description": "The action text to be shown to the user."
              },
              "action": {
                "type": "string",
                "description": "Opaque identifer that identifies action."
              },
              "iconURL": {
                "type": "string",
                "format": "uri",
                "description": "URL of an icon to display with the action."
              },
              "windowsSystemActivationType": {
                "type": "boolean",
                "description": "Whether to have Windows process the given `action`."
              }
            },
            "required": ["action", "title"],
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true,
      "required": ["title", "body"]
    },
    "template": {
      "type": "string",
      "const": "toast_notification"
    }
  },
  "required": ["content", "targeting", "template", "trigger"],
  "additionalProperties": true
}