Icons

A notification can optionally include an array of images for use as an icon representing the notification. The array of images specifies frames in an animation, which always loop. Implementations are free to ignore the images data, and implementations that support images need not support animation.

If the image array has more than one element, a "primary frame" can be specified. If not specified, it defaults to the first frame. For implementations that support images but not animation, only the primary frame will be used.

Each element of the array must have the same type as the first element. Mixtures of strings and blobs are not allowed. The element types can be one of the following:

ElementTypeDescription
Icon Theme NameString Any string that does not begin with the / character is assumed to be an icon theme name and is looked up according to the spec. The best size to fit the servers chosen presentation will be used. This is the recommended way of specifying images.
Absolute PathString Any string that begins with a / will be used as an absolute file path. Implementations should support at minimum files of type image/png and image/svg.
Image DataBinary Data A data stream may be embedded in the message. This is assumed to be of type image/png.