@notifee/react-native / IOSNotificationAttachment
Interface: IOSNotificationAttachment
An interface for describing an iOS Notification Attachment.
View the Attachments documentation to learn more.
id?
optionalid:string
A optional unique identifier of the attachment.
If no id is provided, a unique id is created for you.
thumbnailClippingRect?
optionalthumbnailClippingRect:IOSAttachmentThumbnailClippingRect
An optional clipping rectangle for a thumbnail image.
thumbnailHidden?
optionalthumbnailHidden:boolean
When set to true the thumbnail will be hidden.
Defaults to false.
thumbnailTime?
optionalthumbnailTime:number
The frame number of an animation to use as the thumbnail.
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.
typeHint?
optionaltypeHint:string
An optional hint about an attachment’s file type, as as Uniform Type Identifier (UTI).
A list of UTI values can be found here e.g. for JPEG you'd use public.jpeg as the typeHint value.
If you do not include this key, the attachment’s filename extension is used to determine its type.
url
url:
string
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.