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