An interface for describing an iOS Notification Attachment.
View the Attachments documentation to learn more.
A optional unique identifier of the attachment.
id is provided, a unique id is created for you.
id?: undefined | string;
An optional clipping rectangle for a thumbnail image.
When set to
true the thumbnail will be hidden.
thumbnailHidden?: undefined | false | true;
The frame number of an animation to use as the thumbnail.
thumbnailTime?: undefined | number;
For a video, it is the time (in seconds) into the video from which to grab the thumbnail image.
For a GIF, it is the frame number of the animation to use as a thumbnail image.
An optional hint about an attachment’s file type, as as Uniform Type Identifier (UTI).
typeHint?: undefined | string;
A list of UTI values can be found here e.g. for JPEG you'd use
public.jpeg as the
If you do not include this key, the attachment’s filename extension is used to determine its type.
A URL to the media file to display.
The value can be any of the following:
- An absolute path to a file on the device
- iOS resource
For a list of supported file types, see Supported File Types on the official Apple documentation for more information.
All product names, logos, and brands are property of their respective owners. All company, product and service names used in this website are for identification purposes only. Use of these names, logos, and brands does not imply endorsement.