react-native-notify-kit

react-native-notify-kit / IOSNotificationAttachment

Interface: IOSNotificationAttachment

Defined in: packages/react-native/src/types/NotificationIOS.ts:609

An interface for describing an iOS Notification Attachment.

View the Attachments documentation to learn more.

Platform

ios

Properties

id?

optional id: string

Defined in: packages/react-native/src/types/NotificationIOS.ts:614

A optional unique identifier of the attachment. If no id is provided, a unique id is created for you.

thumbnailClippingRect?

optional thumbnailClippingRect: IOSAttachmentThumbnailClippingRect

Defined in: packages/react-native/src/types/NotificationIOS.ts:646

An optional clipping rectangle for a thumbnail image.

thumbnailHidden?

optional thumbnailHidden: boolean

Defined in: packages/react-native/src/types/NotificationIOS.ts:641

When set to true the thumbnail will be hidden. Defaults to false.

thumbnailTime?

optional thumbnailTime: number

Defined in: packages/react-native/src/types/NotificationIOS.ts:657

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?

optional typeHint: string

Defined in: packages/react-native/src/types/NotificationIOS.ts:635

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

Defined in: packages/react-native/src/types/NotificationIOS.ts:626

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.