From 41542153ee2edae7e06eac819c9933e6c280f1b4 Mon Sep 17 00:00:00 2001 From: Mike Hardy Date: Thu, 19 Dec 2024 08:18:27 -0500 Subject: [PATCH] docs: use typedoc+markdown plugin for docs.page compatible reference completely stock right now except using mdx file extension for docs.page compatibility --- docs/react-native/reference/README.mdx | 135 ++++ .../reference/enumerations/AlarmType.mdx | 61 ++ .../enumerations/AndroidBadgeIconType.mdx | 53 ++ .../enumerations/AndroidCategory.mdx | 179 +++++ .../reference/enumerations/AndroidColor.mdx | 235 ++++++ .../enumerations/AndroidDefaults.mdx | 66 ++ .../reference/enumerations/AndroidFlags.mdx | 36 + .../AndroidForegroundServiceType.mdx | 164 ++++ .../AndroidGroupAlertBehavior.mdx | 52 ++ .../enumerations/AndroidImportance.mdx | 103 +++ .../AndroidLaunchActivityFlag.mdx | 269 +++++++ .../AndroidNotificationSetting.mdx | 55 ++ .../reference/enumerations/AndroidStyle.mdx | 55 ++ .../enumerations/AndroidVisibility.mdx | 57 ++ .../enumerations/AuthorizationStatus.mdx | 69 ++ .../reference/enumerations/EventType.mdx | 163 ++++ .../enumerations/IOSIntentIdentifier.mdx | 263 ++++++ .../enumerations/IOSNotificationSetting.mdx | 53 ++ .../enumerations/IOSShowPreviewsSetting.mdx | 65 ++ .../enumerations/RepeatFrequency.mdx | 51 ++ .../reference/enumerations/TimeUnit.mdx | 51 ++ .../reference/enumerations/TriggerType.mdx | 31 + docs/react-native/reference/globals.mdx | 81 ++ .../reference/interfaces/AndroidAction.mdx | 79 ++ .../interfaces/AndroidBigPictureStyle.mdx | 84 ++ .../interfaces/AndroidBigTextStyle.mdx | 65 ++ .../reference/interfaces/AndroidChannel.mdx | 250 ++++++ .../interfaces/AndroidChannelGroup.mdx | 67 ++ .../interfaces/AndroidInboxStyle.mdx | 68 ++ .../reference/interfaces/AndroidInput.mdx | 93 +++ .../interfaces/AndroidMessagingStyle.mdx | 77 ++ .../AndroidMessagingStyleMessage.mdx | 57 ++ .../AndroidNotificationSettings.mdx | 23 + .../reference/interfaces/AndroidPerson.mdx | 107 +++ .../reference/interfaces/AndroidProgress.mdx | 60 ++ .../interfaces/DisplayedNotification.mdx | 61 ++ .../reference/interfaces/Event.mdx | 36 + .../reference/interfaces/EventDetail.mdx | 131 +++ .../IOSAttachmentThumbnailClippingRect.mdx | 58 ++ .../interfaces/IOSCommunicationInfo.mdx | 63 ++ .../interfaces/IOSCommunicationInfoPerson.mdx | 37 + .../IOSForegroundPresentationOptions.mdx | 96 +++ .../reference/interfaces/IOSInput.mdx | 39 + .../interfaces/IOSNotificationAttachment.mdx | 106 +++ .../interfaces/IOSNotificationCategory.mdx | 117 +++ .../IOSNotificationCategoryAction.mdx | 97 +++ .../interfaces/IOSNotificationPermissions.mdx | 126 +++ .../interfaces/IOSNotificationSettings.mdx | 152 ++++ .../interfaces/InitialNotification.mdx | 65 ++ .../reference/interfaces/IntervalTrigger.mdx | 55 ++ .../interfaces/NativeAndroidChannel.mdx | 313 ++++++++ .../interfaces/NativeAndroidChannelGroup.mdx | 110 +++ .../reference/interfaces/NativeError.mdx | 93 +++ .../reference/interfaces/Notification.mdx | 150 ++++ .../interfaces/NotificationAndroid.mdx | 746 ++++++++++++++++++ .../NotificationFullScreenAction.mdx | 96 +++ .../reference/interfaces/NotificationIOS.mdx | 240 ++++++ .../interfaces/NotificationPressAction.mdx | 91 +++ .../interfaces/NotificationSettings.mdx | 59 ++ .../reference/interfaces/TimestampTrigger.mdx | 71 ++ .../TimestampTriggerAlarmManager.mdx | 46 ++ .../interfaces/TriggerNotification.mdx | 33 + .../type-aliases/ForegroundServiceTask.mdx | 34 + .../IOSNotificationInterruptionLevel.mdx | 20 + .../reference/type-aliases/Trigger.mdx | 13 + .../reference/variables/default.mdx | 13 + package.json | 5 +- typedoc.json | 8 + yarn.lock | 141 +++- 69 files changed, 6863 insertions(+), 35 deletions(-) create mode 100644 docs/react-native/reference/README.mdx create mode 100644 docs/react-native/reference/enumerations/AlarmType.mdx create mode 100644 docs/react-native/reference/enumerations/AndroidBadgeIconType.mdx create mode 100644 docs/react-native/reference/enumerations/AndroidCategory.mdx create mode 100644 docs/react-native/reference/enumerations/AndroidColor.mdx create mode 100644 docs/react-native/reference/enumerations/AndroidDefaults.mdx create mode 100644 docs/react-native/reference/enumerations/AndroidFlags.mdx create mode 100644 docs/react-native/reference/enumerations/AndroidForegroundServiceType.mdx create mode 100644 docs/react-native/reference/enumerations/AndroidGroupAlertBehavior.mdx create mode 100644 docs/react-native/reference/enumerations/AndroidImportance.mdx create mode 100644 docs/react-native/reference/enumerations/AndroidLaunchActivityFlag.mdx create mode 100644 docs/react-native/reference/enumerations/AndroidNotificationSetting.mdx create mode 100644 docs/react-native/reference/enumerations/AndroidStyle.mdx create mode 100644 docs/react-native/reference/enumerations/AndroidVisibility.mdx create mode 100644 docs/react-native/reference/enumerations/AuthorizationStatus.mdx create mode 100644 docs/react-native/reference/enumerations/EventType.mdx create mode 100644 docs/react-native/reference/enumerations/IOSIntentIdentifier.mdx create mode 100644 docs/react-native/reference/enumerations/IOSNotificationSetting.mdx create mode 100644 docs/react-native/reference/enumerations/IOSShowPreviewsSetting.mdx create mode 100644 docs/react-native/reference/enumerations/RepeatFrequency.mdx create mode 100644 docs/react-native/reference/enumerations/TimeUnit.mdx create mode 100644 docs/react-native/reference/enumerations/TriggerType.mdx create mode 100644 docs/react-native/reference/globals.mdx create mode 100644 docs/react-native/reference/interfaces/AndroidAction.mdx create mode 100644 docs/react-native/reference/interfaces/AndroidBigPictureStyle.mdx create mode 100644 docs/react-native/reference/interfaces/AndroidBigTextStyle.mdx create mode 100644 docs/react-native/reference/interfaces/AndroidChannel.mdx create mode 100644 docs/react-native/reference/interfaces/AndroidChannelGroup.mdx create mode 100644 docs/react-native/reference/interfaces/AndroidInboxStyle.mdx create mode 100644 docs/react-native/reference/interfaces/AndroidInput.mdx create mode 100644 docs/react-native/reference/interfaces/AndroidMessagingStyle.mdx create mode 100644 docs/react-native/reference/interfaces/AndroidMessagingStyleMessage.mdx create mode 100644 docs/react-native/reference/interfaces/AndroidNotificationSettings.mdx create mode 100644 docs/react-native/reference/interfaces/AndroidPerson.mdx create mode 100644 docs/react-native/reference/interfaces/AndroidProgress.mdx create mode 100644 docs/react-native/reference/interfaces/DisplayedNotification.mdx create mode 100644 docs/react-native/reference/interfaces/Event.mdx create mode 100644 docs/react-native/reference/interfaces/EventDetail.mdx create mode 100644 docs/react-native/reference/interfaces/IOSAttachmentThumbnailClippingRect.mdx create mode 100644 docs/react-native/reference/interfaces/IOSCommunicationInfo.mdx create mode 100644 docs/react-native/reference/interfaces/IOSCommunicationInfoPerson.mdx create mode 100644 docs/react-native/reference/interfaces/IOSForegroundPresentationOptions.mdx create mode 100644 docs/react-native/reference/interfaces/IOSInput.mdx create mode 100644 docs/react-native/reference/interfaces/IOSNotificationAttachment.mdx create mode 100644 docs/react-native/reference/interfaces/IOSNotificationCategory.mdx create mode 100644 docs/react-native/reference/interfaces/IOSNotificationCategoryAction.mdx create mode 100644 docs/react-native/reference/interfaces/IOSNotificationPermissions.mdx create mode 100644 docs/react-native/reference/interfaces/IOSNotificationSettings.mdx create mode 100644 docs/react-native/reference/interfaces/InitialNotification.mdx create mode 100644 docs/react-native/reference/interfaces/IntervalTrigger.mdx create mode 100644 docs/react-native/reference/interfaces/NativeAndroidChannel.mdx create mode 100644 docs/react-native/reference/interfaces/NativeAndroidChannelGroup.mdx create mode 100644 docs/react-native/reference/interfaces/NativeError.mdx create mode 100644 docs/react-native/reference/interfaces/Notification.mdx create mode 100644 docs/react-native/reference/interfaces/NotificationAndroid.mdx create mode 100644 docs/react-native/reference/interfaces/NotificationFullScreenAction.mdx create mode 100644 docs/react-native/reference/interfaces/NotificationIOS.mdx create mode 100644 docs/react-native/reference/interfaces/NotificationPressAction.mdx create mode 100644 docs/react-native/reference/interfaces/NotificationSettings.mdx create mode 100644 docs/react-native/reference/interfaces/TimestampTrigger.mdx create mode 100644 docs/react-native/reference/interfaces/TimestampTriggerAlarmManager.mdx create mode 100644 docs/react-native/reference/interfaces/TriggerNotification.mdx create mode 100644 docs/react-native/reference/type-aliases/ForegroundServiceTask.mdx create mode 100644 docs/react-native/reference/type-aliases/IOSNotificationInterruptionLevel.mdx create mode 100644 docs/react-native/reference/type-aliases/Trigger.mdx create mode 100644 docs/react-native/reference/variables/default.mdx create mode 100644 typedoc.json diff --git a/docs/react-native/reference/README.mdx b/docs/react-native/reference/README.mdx new file mode 100644 index 00000000..cbfba38b --- /dev/null +++ b/docs/react-native/reference/README.mdx @@ -0,0 +1,135 @@ +**@notifee/react-native** + +*** + +

+ +
+ +

Notifee - React Native

+

+ +--- + +A feature rich Android & iOS notifications library for React Native. + +[> Learn More](https://notifee.app/) + +## Installation + +```bash +yarn add @notifee/react-native +``` + +## Documentation + +- [Overview](https://notifee.app/react-native/docs/overview) +- [Licensing](https://notifee.app/react-native/docs/license-keys) +- [Reference](https://notifee.app/react-native/reference) + +### Android + +The APIs for Android allow for creating rich, styled and highly interactive notifications. Below you'll find guides that cover the supported Android features. + +| Topic | | +| ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | +| [Appearance](https://notifee.app/react-native/docs/android/appearance) | Change the appearance of a notification; icons, colors, visibility etc. | +| [Behaviour](https://notifee.app/react-native/docs/android/behaviour) | Customize how a notification behaves when it is delivered to a device; sound, vibration, lights etc. | +| [Channels & Groups](https://notifee.app/react-native/docs/android/channels) | Organize your notifications into channels & groups to allow users to control how notifications are handled on their device | +| [Foreground Service](https://notifee.app/react-native/docs/android/foreground-service) | Long running background tasks can take advantage of a Android Foreground Services to display an on-going, prominent notification. | +| [Grouping & Sorting](https://notifee.app/react-native/docs/android/grouping-and-sorting) | Group and sort related notifications in a single notification pane. | +| [Interaction](https://notifee.app/react-native/docs/android/interaction) | Allow users to interact with your application directly from the notification with actions. | +| [Progress Indicators](https://notifee.app/react-native/docs/android/progress-indicators) | Show users a progress indicator of an on-going background task, and learn how to keep it updated. | +| [Styles](https://notifee.app/react-native/docs/android/styles) | Style notifications to show richer content, such as expandable images/text, or message conversations. | +| [Timers](https://notifee.app/react-native/docs/android/timers) | Display counting timers on your notification, useful for on-going tasks such as a phone call, or event time remaining. | + +### iOS + +Below you'll find guides that cover the supported iOS features. + +| Topic | | +| ----------------------------------------------------------------- | ------------------------------------------------------------------------ | +| [Appearance](https://notifee.app/react-native/docs/ios/appearance) | Change now the notification is displayed to your users. | +| [Behaviour](https://notifee.app/react-native/docs/ios/behaviour) | Control how notifications behave when they are displayed to a device; sound, crtitial alerts etc. | +| [Categories](https://notifee.app/react-native/docs/ios/categories) | Create & assign categories to notifications. | +| [Interaction](https://notifee.app/react-native/docs/ios/interaction) | Handle user interaction with your notifications. | | +| [Permissions](https://notifee.app/react-native/docs/ios/permissions) | Request permission from your application users to display notifications. | | + +### Jest Testing + +To run jest tests after integrating this module, you will need to mock out the native parts of Notifee or you will get an error that looks like: + +```bash + ● Test suite failed to run + + Notifee native module not found. + + 59 | this._nativeModule = NativeModules[this._moduleConfig.nativeModuleName]; + 60 | if (this._nativeModule == null) { + > 61 | throw new Error('Notifee native module not found.'); + | ^ + 62 | } + 63 | + 64 | return this._nativeModule; +``` + +Add this to a setup file in your project e.g. `jest.setup.js`: + +If you don't already have a Jest setup file configured, please add the following to your Jest configuration file and create the new jest.setup.js file in project root: + +```js +setupFiles: ['/jest.setup.js'], +``` + +You can then add the following line to that setup file to mock `notifee`: + +```js +jest.mock('@notifee/react-native', () => require('@notifee/react-native/jest-mock')) +``` + +You will also need to add `@notifee` to `transformIgnorePatterns` in your config file (`jest.config.js`): + +```bash +transformIgnorePatterns: [ + 'node_modules/(?!(jest-)?react-native|@react-native|@notifee)' +] +``` + +### Detox Testing + +To utilise Detox's functionality to mock a local notification and trigger notifee's event handlers, you will need a payload with a key `__notifee_notification`: + +```js +{ + title: 'test', + body: 'Body', + payload: { + __notifee_notification: { + ios: { + foregroundPresentationOptions: { + banner: true, + list: true, + }, + }, + data: {} + }, + }, +} +``` + +The important part is to make sure you have a `__notifee_notification` object under `payload` with the default properties. + +## License + +- See [LICENSE](/LICENSE) + +--- + +

+ +

+ Built and maintained with 💛 by Invertase. +

+

+ +--- diff --git a/docs/react-native/reference/enumerations/AlarmType.mdx b/docs/react-native/reference/enumerations/AlarmType.mdx new file mode 100644 index 00000000..14996c22 --- /dev/null +++ b/docs/react-native/reference/enumerations/AlarmType.mdx @@ -0,0 +1,61 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / AlarmType + +# Enumeration: AlarmType + +An interface representing the different alarm types which can be used with `TimestampTrigger.alarmManager.type`. + +View the [Triggers](/react-native/docs/triggers) documentation to learn more. + +## Enumeration Members + +### SET + +> **SET**: `0` + +#### Defined in + +[packages/react-native/src/types/Trigger.ts:43](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Trigger.ts#L43) + +*** + +### SET\_ALARM\_CLOCK + +> **SET\_ALARM\_CLOCK**: `4` + +#### Defined in + +[packages/react-native/src/types/Trigger.ts:47](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Trigger.ts#L47) + +*** + +### SET\_AND\_ALLOW\_WHILE\_IDLE + +> **SET\_AND\_ALLOW\_WHILE\_IDLE**: `1` + +#### Defined in + +[packages/react-native/src/types/Trigger.ts:44](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Trigger.ts#L44) + +*** + +### SET\_EXACT + +> **SET\_EXACT**: `2` + +#### Defined in + +[packages/react-native/src/types/Trigger.ts:45](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Trigger.ts#L45) + +*** + +### SET\_EXACT\_AND\_ALLOW\_WHILE\_IDLE + +> **SET\_EXACT\_AND\_ALLOW\_WHILE\_IDLE**: `3` + +#### Defined in + +[packages/react-native/src/types/Trigger.ts:46](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Trigger.ts#L46) diff --git a/docs/react-native/reference/enumerations/AndroidBadgeIconType.mdx b/docs/react-native/reference/enumerations/AndroidBadgeIconType.mdx new file mode 100644 index 00000000..4f095082 --- /dev/null +++ b/docs/react-native/reference/enumerations/AndroidBadgeIconType.mdx @@ -0,0 +1,53 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / AndroidBadgeIconType + +# Enumeration: AndroidBadgeIconType + +Enum used to define how a notification badge is displayed in badge mode. + +View the [Badges](/react-native/docs/android/appearance#badges) documentation for more information. + +## Platform + +android + +## Enumeration Members + +### LARGE + +> **LARGE**: `2` + +Shows the badge as the notifications `largeIcon` (if available). + +This is the default value used by a notification if not provided. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1092](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1092) + +*** + +### NONE + +> **NONE**: `0` + +No badge is displayed, will always show as a number. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1080](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1080) + +*** + +### SMALL + +> **SMALL**: `1` + +Shows the badge as the notifications `smallIcon`. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1085](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1085) diff --git a/docs/react-native/reference/enumerations/AndroidCategory.mdx b/docs/react-native/reference/enumerations/AndroidCategory.mdx new file mode 100644 index 00000000..e53bf328 --- /dev/null +++ b/docs/react-native/reference/enumerations/AndroidCategory.mdx @@ -0,0 +1,179 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / AndroidCategory + +# Enumeration: AndroidCategory + +Enum used to describe the category of a notification. + +Setting a category on a notification helps the device to understand what the notification is for, +or what impact it will have on the user. The category can be used for ranking and filtering +the notification, however has no visual impact on the notification. + +## Platform + +android + +## Enumeration Members + +### ALARM + +> **ALARM**: `"alarm"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1105](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1105) + +*** + +### CALL + +> **CALL**: `"call"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1106](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1106) + +*** + +### EMAIL + +> **EMAIL**: `"email"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1107](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1107) + +*** + +### ERROR + +> **ERROR**: `"error"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1108](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1108) + +*** + +### EVENT + +> **EVENT**: `"event"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1109](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1109) + +*** + +### MESSAGE + +> **MESSAGE**: `"msg"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1110](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1110) + +*** + +### NAVIGATION + +> **NAVIGATION**: `"navigation"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1111](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1111) + +*** + +### PROGRESS + +> **PROGRESS**: `"progress"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1112](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1112) + +*** + +### PROMO + +> **PROMO**: `"promo"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1113](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1113) + +*** + +### RECOMMENDATION + +> **RECOMMENDATION**: `"recommendation"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1114](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1114) + +*** + +### REMINDER + +> **REMINDER**: `"reminder"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1115](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1115) + +*** + +### SERVICE + +> **SERVICE**: `"service"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1116](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1116) + +*** + +### SOCIAL + +> **SOCIAL**: `"social"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1117](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1117) + +*** + +### STATUS + +> **STATUS**: `"status"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1118](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1118) + +*** + +### SYSTEM + +> **SYSTEM**: `"sys"` + +Avoid using - generally used by the system. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1123](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1123) + +*** + +### TRANSPORT + +> **TRANSPORT**: `"transport"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1124](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1124) diff --git a/docs/react-native/reference/enumerations/AndroidColor.mdx b/docs/react-native/reference/enumerations/AndroidColor.mdx new file mode 100644 index 00000000..751a8793 --- /dev/null +++ b/docs/react-native/reference/enumerations/AndroidColor.mdx @@ -0,0 +1,235 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / AndroidColor + +# Enumeration: AndroidColor + +A set or predefined colors which can be used with Android Notifications. + +View the [Color](/react-native/docs/android/appearance#color) documentation to learn more. + +## Platform + +android + +## Enumeration Members + +### AQUA + +> **AQUA**: `"aqua"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1148](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1148) + +*** + +### BLACK + +> **BLACK**: `"black"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1138](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1138) + +*** + +### BLUE + +> **BLUE**: `"blue"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1136](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1136) + +*** + +### CYAN + +> **CYAN**: `"cyan"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1140](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1140) + +*** + +### DARKGRAY + +> **DARKGRAY**: `"darkgray"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1144](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1144) + +*** + +### DARKGREY + +> **DARKGREY**: `"darkgrey"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1147](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1147) + +*** + +### FUCHSIA + +> **FUCHSIA**: `"fuchsia"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1149](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1149) + +*** + +### GRAY + +> **GRAY**: `"gray"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1145](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1145) + +*** + +### GREEN + +> **GREEN**: `"green"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1137](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1137) + +*** + +### LIGHTGRAY + +> **LIGHTGRAY**: `"lightgray"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1143](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1143) + +*** + +### LIGHTGREY + +> **LIGHTGREY**: `"lightgrey"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1146](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1146) + +*** + +### LIME + +> **LIME**: `"lime"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1150](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1150) + +*** + +### MAGENTA + +> **MAGENTA**: `"magenta"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1141](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1141) + +*** + +### MAROON + +> **MAROON**: `"maroon"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1151](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1151) + +*** + +### NAVY + +> **NAVY**: `"navy"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1152](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1152) + +*** + +### OLIVE + +> **OLIVE**: `"olive"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1153](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1153) + +*** + +### PURPLE + +> **PURPLE**: `"purple"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1154](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1154) + +*** + +### RED + +> **RED**: `"red"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1135](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1135) + +*** + +### SILVER + +> **SILVER**: `"silver"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1155](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1155) + +*** + +### TEAL + +> **TEAL**: `"teal"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1156](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1156) + +*** + +### WHITE + +> **WHITE**: `"white"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1139](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1139) + +*** + +### YELLOW + +> **YELLOW**: `"yellow"` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1142](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1142) diff --git a/docs/react-native/reference/enumerations/AndroidDefaults.mdx b/docs/react-native/reference/enumerations/AndroidDefaults.mdx new file mode 100644 index 00000000..6a74271f --- /dev/null +++ b/docs/react-native/reference/enumerations/AndroidDefaults.mdx @@ -0,0 +1,66 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / AndroidDefaults + +# Enumeration: AndroidDefaults + +On devices which do not support notification channels (API Level < 26), the notification +by default will use all methods to alert the user (depending on the importance). + +To override the default behaviour, provide an array of defaults to the notification. + +On API Levels >= 26, this has no effect and notifications will use the channel behaviour. + +## Platform + +android API Level < 26 + +## Enumeration Members + +### ALL + +> **ALL**: `-1` + +All options will be used, where possible. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1173](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1173) + +*** + +### LIGHTS + +> **LIGHTS**: `4` + +The notification will use lights to alert the user. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1178](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1178) + +*** + +### SOUND + +> **SOUND**: `1` + +The notification will use sound to alert the user. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1183](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1183) + +*** + +### VIBRATE + +> **VIBRATE**: `2` + +The notification will vibrate to alert the user. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1188](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1188) diff --git a/docs/react-native/reference/enumerations/AndroidFlags.mdx b/docs/react-native/reference/enumerations/AndroidFlags.mdx new file mode 100644 index 00000000..e2c967dc --- /dev/null +++ b/docs/react-native/reference/enumerations/AndroidFlags.mdx @@ -0,0 +1,36 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / AndroidFlags + +# Enumeration: AndroidFlags + +Enum used to set any additional flags supported on Android. +See Android's [setFlag()](https://developer.android.com/reference/android/app/Notification.Builder#setFlag(int,%20boolean)) documentation. + +## Enumeration Members + +### FLAG\_INSISTENT + +> **FLAG\_INSISTENT**: `4` + +The audio will be repeated until the notification is cancelled or the notification window is opened. +This will be set for you by setting `loopSound`. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1200](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1200) + +*** + +### FLAG\_NO\_CLEAR + +> **FLAG\_NO\_CLEAR**: `32` + +Prevents the notification from being canceled when the user clicks the Clear all button. +This will be set for you by setting `ongoing`. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1206](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1206) diff --git a/docs/react-native/reference/enumerations/AndroidForegroundServiceType.mdx b/docs/react-native/reference/enumerations/AndroidForegroundServiceType.mdx new file mode 100644 index 00000000..51553737 --- /dev/null +++ b/docs/react-native/reference/enumerations/AndroidForegroundServiceType.mdx @@ -0,0 +1,164 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / AndroidForegroundServiceType + +# Enumeration: AndroidForegroundServiceType + +Enum used to set the foreground service types identifying the work done by the service. +See Android's [foreground service types](https://developer.android.com/develop/background-work/services/fg-service-types) documentation. + +## Platform + +android + +## Enumeration Members + +### FOREGROUND\_SERVICE\_TYPE\_CAMERA + +> **FOREGROUND\_SERVICE\_TYPE\_CAMERA**: `64` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1463](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1463) + +*** + +### FOREGROUND\_SERVICE\_TYPE\_CONNECTED\_DEVICE + +> **FOREGROUND\_SERVICE\_TYPE\_CONNECTED\_DEVICE**: `16` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1464](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1464) + +*** + +### FOREGROUND\_SERVICE\_TYPE\_DATA\_SYNC + +> **FOREGROUND\_SERVICE\_TYPE\_DATA\_SYNC**: `1` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1465](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1465) + +*** + +### FOREGROUND\_SERVICE\_TYPE\_HEALTH + +> **FOREGROUND\_SERVICE\_TYPE\_HEALTH**: `256` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1466](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1466) + +*** + +### FOREGROUND\_SERVICE\_TYPE\_LOCATION + +> **FOREGROUND\_SERVICE\_TYPE\_LOCATION**: `8` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1467](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1467) + +*** + +### FOREGROUND\_SERVICE\_TYPE\_MANIFEST + +> **FOREGROUND\_SERVICE\_TYPE\_MANIFEST**: `-1` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1477](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1477) + +*** + +### FOREGROUND\_SERVICE\_TYPE\_MEDIA\_PLAYBACK + +> **FOREGROUND\_SERVICE\_TYPE\_MEDIA\_PLAYBACK**: `2` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1468](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1468) + +*** + +### FOREGROUND\_SERVICE\_TYPE\_MEDIA\_PROCESSING + +> **FOREGROUND\_SERVICE\_TYPE\_MEDIA\_PROCESSING**: `8192` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1470](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1470) + +*** + +### FOREGROUND\_SERVICE\_TYPE\_MEDIA\_PROJECTION + +> **FOREGROUND\_SERVICE\_TYPE\_MEDIA\_PROJECTION**: `32` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1469](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1469) + +*** + +### FOREGROUND\_SERVICE\_TYPE\_MICROPHONE + +> **FOREGROUND\_SERVICE\_TYPE\_MICROPHONE**: `128` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1471](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1471) + +*** + +### FOREGROUND\_SERVICE\_TYPE\_PHONE\_CALL + +> **FOREGROUND\_SERVICE\_TYPE\_PHONE\_CALL**: `4` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1472](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1472) + +*** + +### FOREGROUND\_SERVICE\_TYPE\_REMOTE\_MESSAGING + +> **FOREGROUND\_SERVICE\_TYPE\_REMOTE\_MESSAGING**: `512` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1473](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1473) + +*** + +### FOREGROUND\_SERVICE\_TYPE\_SHORT\_SERVICE + +> **FOREGROUND\_SERVICE\_TYPE\_SHORT\_SERVICE**: `2048` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1474](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1474) + +*** + +### FOREGROUND\_SERVICE\_TYPE\_SPECIAL\_USE + +> **FOREGROUND\_SERVICE\_TYPE\_SPECIAL\_USE**: `1073741824` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1475](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1475) + +*** + +### FOREGROUND\_SERVICE\_TYPE\_SYSTEM\_EXEMPTED + +> **FOREGROUND\_SERVICE\_TYPE\_SYSTEM\_EXEMPTED**: `1024` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1476](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1476) diff --git a/docs/react-native/reference/enumerations/AndroidGroupAlertBehavior.mdx b/docs/react-native/reference/enumerations/AndroidGroupAlertBehavior.mdx new file mode 100644 index 00000000..795e8426 --- /dev/null +++ b/docs/react-native/reference/enumerations/AndroidGroupAlertBehavior.mdx @@ -0,0 +1,52 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / AndroidGroupAlertBehavior + +# Enumeration: AndroidGroupAlertBehavior + +Enum used to describe how a notification alerts the user when it apart of a group. + +View the [Grouping & Sorting](/react-native/docs/android/grouping-and-sorting#group-behaviour) documentation to +learn more. + +## Platform + +android + +## Enumeration Members + +### ALL + +> **ALL**: `0` + +All notifications will alert. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1221](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1221) + +*** + +### CHILDREN + +> **CHILDREN**: `2` + +Children of a group will alert the user. The summary notification will not alert when displayed. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1231](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1231) + +*** + +### SUMMARY + +> **SUMMARY**: `1` + +Only the summary notification will alert the user when displayed. The children of the group will not alert. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1226](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1226) diff --git a/docs/react-native/reference/enumerations/AndroidImportance.mdx b/docs/react-native/reference/enumerations/AndroidImportance.mdx new file mode 100644 index 00000000..de5dc0f5 --- /dev/null +++ b/docs/react-native/reference/enumerations/AndroidImportance.mdx @@ -0,0 +1,103 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / AndroidImportance + +# Enumeration: AndroidImportance + +The interface describing the importance levels of an incoming notification. + +The importance level can be set directly onto a notification channel for supported devices (API Level >= 26) +or directly onto the notification for devices which do not support channels. + +The importance is used to both change the visual prompt of a received notification +and also how it visually appears on the device. + +View the [Android Appearance](/react-native/docs/android/appearance#importance) documentation to learn more. + +## Platform + +android + +## Enumeration Members + +### DEFAULT + +> **DEFAULT**: `3` + +The default importance applied to a channel/notification. + +The application small icon will show in the device statusbar. When the user pulls down the +notification shade, the notification will show in it's expanded state (if applicable). + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1298](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1298) + +*** + +### HIGH + +> **HIGH**: `4` + +The highest importance level applied to a channel/notification. + +The notifications will appear on-top of applications, allowing direct interaction without pulling +down the notification shade. This level should only be used for urgent notifications, such as +incoming phone calls, messages etc, which require immediate attention. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1307](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1307) + +*** + +### LOW + +> **LOW**: `2` + +A low importance level applied to a channel/notification. + +On Android, the application small icon will show in the device statusbar, however the notification will not alert +the user (no sound or vibration). The notification will show in it's expanded state when the +notification shade is pulled down. + +On iOS, the notification will not display to the user or alert them. It will still be visible on the devices +notification center. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1319](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1319) + +*** + +### MIN + +> **MIN**: `1` + +The minimum importance level applied to a channel/notification. + +The application small icon will not show up in the statusbar, or alert the user. The notification +will be in a collapsed state in the notification shade and placed at the bottom of the list. + +This level should be used when the notification requires no immediate attention. An example of this +importance level is the Google app providing weather updates and only being visible when the +user pulls the notification shade down, + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1331](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1331) + +*** + +### NONE + +> **NONE**: `0` + +The notification will not be shown. This has the same effect as the user disabling notifications +in the application settings. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1337](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1337) diff --git a/docs/react-native/reference/enumerations/AndroidLaunchActivityFlag.mdx b/docs/react-native/reference/enumerations/AndroidLaunchActivityFlag.mdx new file mode 100644 index 00000000..17c09cfe --- /dev/null +++ b/docs/react-native/reference/enumerations/AndroidLaunchActivityFlag.mdx @@ -0,0 +1,269 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / AndroidLaunchActivityFlag + +# Enumeration: AndroidLaunchActivityFlag + +An enum representing the various flags that can be passed along to `launchActivityFlags` on `NotificationPressAction`. + +These flags are added to the Android [Intent](https://developer.android.com/reference/android/content/Intent.html) that launches your activity. + +These are only required if you need to customise the behaviour of your activities, in most cases you might not need these. + +## Platform + +android + +## Enumeration Members + +### BROUGHT\_TO\_FRONT + +> **BROUGHT\_TO\_FRONT**: `8` + +See [FLAG_ACTIVITY_BROUGHT_TO_FRONT](https://developer.android.com/reference/android/content/Intent.html#FLAG_ACTIVITY_BROUGHT_TO_FRONT) on the official Android documentation for more information. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1393](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1393) + +*** + +### CLEAR\_TASK + +> **CLEAR\_TASK**: `16` + +See [FLAG_ACTIVITY_CLEAR_TASK](https://developer.android.com/reference/android/content/Intent.html#FLAG_ACTIVITY_CLEAR_TASK) on the official Android documentation for more information. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1433](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1433) + +*** + +### CLEAR\_TOP + +> **CLEAR\_TOP**: `4` + +See [FLAG_ACTIVITY_CLEAR_TOP](https://developer.android.com/reference/android/content/Intent.html#FLAG_ACTIVITY_CLEAR_TOP) on the official Android documentation for more information. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1373](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1373) + +*** + +### CLEAR\_WHEN\_TASK\_RESET + +> **CLEAR\_WHEN\_TASK\_RESET**: `11` + +See [FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET](https://developer.android.com/reference/android/content/Intent.html#FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET) on the official Android documentation for more information. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1408](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1408) + +*** + +### EXCLUDE\_FROM\_RECENTS + +> **EXCLUDE\_FROM\_RECENTS**: `7` + +See [FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS](https://developer.android.com/reference/android/content/Intent.html#FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS) on the official Android documentation for more information. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1388](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1388) + +*** + +### FORWARD\_RESULT + +> **FORWARD\_RESULT**: `5` + +See [FLAG_ACTIVITY_FORWARD_RESULT](https://developer.android.com/reference/android/content/Intent.html#FLAG_ACTIVITY_FORWARD_RESULT) on the official Android documentation for more information. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1378](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1378) + +*** + +### LAUNCH\_ADJACENT + +> **LAUNCH\_ADJACENT**: `19` + +See [FLAG_ACTIVITY_LAUNCH_ADJACENT](https://developer.android.com/reference/android/content/Intent.html#FLAG_ACTIVITY_LAUNCH_ADJACENT) on the official Android documentation for more information. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1448](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1448) + +*** + +### LAUNCHED\_FROM\_HISTORY + +> **LAUNCHED\_FROM\_HISTORY**: `10` + +See [FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY](https://developer.android.com/reference/android/content/Intent.html#FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY) on the official Android documentation for more information. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1403](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1403) + +*** + +### MATCH\_EXTERNAL + +> **MATCH\_EXTERNAL**: `20` + +See [FLAG_ACTIVITY_MATCH_EXTERNAL](https://developer.android.com/reference/android/content/Intent.html#FLAG_ACTIVITY_MATCH_EXTERNAL) on the official Android documentation for more information. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1453](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1453) + +*** + +### MULTIPLE\_TASK + +> **MULTIPLE\_TASK**: `3` + +See [FLAG_ACTIVITY_MULTIPLE_TASK](https://developer.android.com/reference/android/content/Intent.html#FLAG_ACTIVITY_MULTIPLE_TASK) on the official Android documentation for more information. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1368](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1368) + +*** + +### NEW\_DOCUMENT + +> **NEW\_DOCUMENT**: `12` + +See [FLAG_ACTIVITY_NEW_DOCUMENT](https://developer.android.com/reference/android/content/Intent.html#FLAG_ACTIVITY_NEW_DOCUMENT) on the official Android documentation for more information. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1413](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1413) + +*** + +### NEW\_TASK + +> **NEW\_TASK**: `2` + +See [FLAG_ACTIVITY_NEW_TASK](https://developer.android.com/reference/android/content/Intent.html#FLAG_ACTIVITY_NEW_TASK) on the official Android documentation for more information. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1363](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1363) + +*** + +### NO\_ANIMATION + +> **NO\_ANIMATION**: `15` + +See [FLAG_ACTIVITY_NO_ANIMATION](https://developer.android.com/reference/android/content/Intent.html#FLAG_ACTIVITY_NO_ANIMATION) on the official Android documentation for more information. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1428](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1428) + +*** + +### NO\_HISTORY + +> **NO\_HISTORY**: `0` + +See [FLAG_ACTIVITY_NO_HISTORY](https://developer.android.com/reference/android/content/Intent.html#FLAG_ACTIVITY_NO_HISTORY) on the official Android documentation for more information. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1353](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1353) + +*** + +### NO\_USER\_ACTION + +> **NO\_USER\_ACTION**: `13` + +See [FLAG_ACTIVITY_NO_USER_ACTION](https://developer.android.com/reference/android/content/Intent.html#FLAG_ACTIVITY_NO_USER_ACTION) on the official Android documentation for more information. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1418](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1418) + +*** + +### PREVIOUS\_IS\_TOP + +> **PREVIOUS\_IS\_TOP**: `6` + +See [FLAG_ACTIVITY_PREVIOUS_IS_TOP](https://developer.android.com/reference/android/content/Intent.html#FLAG_ACTIVITY_PREVIOUS_IS_TOP) on the official Android documentation for more information. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1383](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1383) + +*** + +### REORDER\_TO\_FRONT + +> **REORDER\_TO\_FRONT**: `14` + +See [FLAG_ACTIVITY_REORDER_TO_FRONT](https://developer.android.com/reference/android/content/Intent.html#FLAG_ACTIVITY_REORDER_TO_FRONT) on the official Android documentation for more information. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1423](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1423) + +*** + +### RESET\_TASK\_IF\_NEEDED + +> **RESET\_TASK\_IF\_NEEDED**: `9` + +See [FLAG_ACTIVITY_RESET_TASK_IF_NEEDED](https://developer.android.com/reference/android/content/Intent.html#FLAG_ACTIVITY_RESET_TASK_IF_NEEDED) on the official Android documentation for more information. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1398](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1398) + +*** + +### RETAIN\_IN\_RECENTS + +> **RETAIN\_IN\_RECENTS**: `18` + +See [FLAG_ACTIVITY_RETAIN_IN_RECENTS](https://developer.android.com/reference/android/content/Intent.html#FLAG_ACTIVITY_RETAIN_IN_RECENTS) on the official Android documentation for more information. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1443](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1443) + +*** + +### SINGLE\_TOP + +> **SINGLE\_TOP**: `1` + +See [FLAG_ACTIVITY_SINGLE_TOP](https://developer.android.com/reference/android/content/Intent.html#FLAG_ACTIVITY_SINGLE_TOP) on the official Android documentation for more information. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1358](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1358) + +*** + +### TASK\_ON\_HOME + +> **TASK\_ON\_HOME**: `17` + +See [FLAG_ACTIVITY_TASK_ON_HOME](https://developer.android.com/reference/android/content/Intent.html#FLAG_ACTIVITY_TASK_ON_HOME) on the official Android documentation for more information. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1438](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1438) diff --git a/docs/react-native/reference/enumerations/AndroidNotificationSetting.mdx b/docs/react-native/reference/enumerations/AndroidNotificationSetting.mdx new file mode 100644 index 00000000..025f61d6 --- /dev/null +++ b/docs/react-native/reference/enumerations/AndroidNotificationSetting.mdx @@ -0,0 +1,55 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / AndroidNotificationSetting + +# Enumeration: AndroidNotificationSetting + +An interface representing the current android only notification-related settings for your app. + +This interface is returned from [`requestPermission`](/react-native/reference/requestpermission) +and [`getNotificationSettings`](/react-native/reference/getnotificationsettings). + +View the [Permissions](/react-native/docs/android/permissions) documentation to learn more. + +## Platform + +android + +## Enumeration Members + +### DISABLED + +> **DISABLED**: `0` + +This setting is currently disabled by the user. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:466](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L466) + +*** + +### ENABLED + +> **ENABLED**: `1` + +This setting is currently enabled. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:471](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L471) + +*** + +### NOT\_SUPPORTED + +> **NOT\_SUPPORTED**: `-1` + +This setting is not supported on this device. Usually this means that the Android version required +for this setting has not been met. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:461](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L461) diff --git a/docs/react-native/reference/enumerations/AndroidStyle.mdx b/docs/react-native/reference/enumerations/AndroidStyle.mdx new file mode 100644 index 00000000..53ce4514 --- /dev/null +++ b/docs/react-native/reference/enumerations/AndroidStyle.mdx @@ -0,0 +1,55 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / AndroidStyle + +# Enumeration: AndroidStyle + +Available Android Notification Styles. + +View the [Styles](/react-native/docs/android/styles) documentation to learn more with example usage. + +## Platform + +android + +## Enumeration Members + +### BIGPICTURE + +> **BIGPICTURE**: `0` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1242](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1242) + +*** + +### BIGTEXT + +> **BIGTEXT**: `1` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1243](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1243) + +*** + +### INBOX + +> **INBOX**: `2` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1244](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1244) + +*** + +### MESSAGING + +> **MESSAGING**: `3` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1245](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1245) diff --git a/docs/react-native/reference/enumerations/AndroidVisibility.mdx b/docs/react-native/reference/enumerations/AndroidVisibility.mdx new file mode 100644 index 00000000..23ebc37d --- /dev/null +++ b/docs/react-native/reference/enumerations/AndroidVisibility.mdx @@ -0,0 +1,57 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / AndroidVisibility + +# Enumeration: AndroidVisibility + +Interface used to define the visibility of an Android notification. + +Use with the `visibility` property on the notification. + +View the [Visibility](/react-native/docs/android/appearance#visibility) documentation to learn more. + +Default value is `AndroidVisibility.PRIVATE`. + +## Platform + +android + +## Enumeration Members + +### PRIVATE + +> **PRIVATE**: `0` + +Show the notification on all lockscreens, but conceal sensitive or private information on secure lockscreens. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1263](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1263) + +*** + +### PUBLIC + +> **PUBLIC**: `1` + +Show this notification in its entirety on all lockscreens. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1268](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1268) + +*** + +### SECRET + +> **SECRET**: `-1` + +Do not reveal any part of this notification on a secure lockscreen. + +Useful for notifications showing sensitive information such as banking apps. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1275](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1275) diff --git a/docs/react-native/reference/enumerations/AuthorizationStatus.mdx b/docs/react-native/reference/enumerations/AuthorizationStatus.mdx new file mode 100644 index 00000000..0fec1a14 --- /dev/null +++ b/docs/react-native/reference/enumerations/AuthorizationStatus.mdx @@ -0,0 +1,69 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / AuthorizationStatus + +# Enumeration: AuthorizationStatus + +An enum representing the notification authorization status for this app on the device. + +Value is greater than 0 if authorized, compare against an exact status (e.g. PROVISIONAL) for a more +granular status. + +## Enumeration Members + +### AUTHORIZED + +> **AUTHORIZED**: `1` + +The app is authorized to create notifications. + +#### Defined in + +[packages/react-native/src/types/Notification.ts:488](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L488) + +*** + +### DENIED + +> **DENIED**: `0` + +The app is not authorized to create notifications. + +#### Defined in + +[packages/react-native/src/types/Notification.ts:483](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L483) + +*** + +### NOT\_DETERMINED + +> **NOT\_DETERMINED**: `-1` + +The app user has not yet chosen whether to allow the application to create notifications. Usually +this status is returned prior to the first call of `requestPermission`. + +#### Platform + +ios + +#### Defined in + +[packages/react-native/src/types/Notification.ts:478](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L478) + +*** + +### PROVISIONAL + +> **PROVISIONAL**: `2` + +The app is currently authorized to post non-interrupting user notifications + +#### Platform + +ios iOS >= 12 + +#### Defined in + +[packages/react-native/src/types/Notification.ts:494](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L494) diff --git a/docs/react-native/reference/enumerations/EventType.mdx b/docs/react-native/reference/enumerations/EventType.mdx new file mode 100644 index 00000000..3c748d04 --- /dev/null +++ b/docs/react-native/reference/enumerations/EventType.mdx @@ -0,0 +1,163 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / EventType + +# Enumeration: EventType + +An enum representing an event type, defined on [`Event`](/react-native/reference/event). + +View the [Events](/react-native/docs/events) documentation to learn more about foreground and +background events. + +## Enumeration Members + +### ACTION\_PRESS + +> **ACTION\_PRESS**: `2` + +Event type is sent when a user presses a notification action. + +#### Defined in + +[packages/react-native/src/types/Notification.ts:341](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L341) + +*** + +### APP\_BLOCKED + +> **APP\_BLOCKED**: `4` + +Event is sent when the user changes the notification blocked state for the entire application or +when the user opens the application settings. + +#### Platform + +android API Level >= 28 + +#### Defined in + +[packages/react-native/src/types/Notification.ts:358](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L358) + +*** + +### CHANNEL\_BLOCKED + +> **CHANNEL\_BLOCKED**: `5` + +Event type is sent when the user changes the notification blocked state for a channel in the application. + +#### Platform + +android API Level >= 28 + +#### Defined in + +[packages/react-native/src/types/Notification.ts:365](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L365) + +*** + +### CHANNEL\_GROUP\_BLOCKED + +> **CHANNEL\_GROUP\_BLOCKED**: `6` + +Event type is sent when the user changes the notification blocked state for a channel group in the application. + +#### Platform + +android API Level >= 28 + +#### Defined in + +[packages/react-native/src/types/Notification.ts:372](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L372) + +*** + +### DELIVERED + +> **DELIVERED**: `3` + +Event type sent when a notification has been delivered to the device. For trigger notifications, +this event is sent at the point when the trigger executes, not when a the trigger notification is created. + +It's important to note even though a notification has been delivered, it may not be shown to the +user. For example, they may have notifications disabled on the device/channel/app. + +#### Defined in + +[packages/react-native/src/types/Notification.ts:350](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L350) + +*** + +### DISMISSED + +> **DISMISSED**: `0` + +Event type is sent when the user dismisses a notification. This is triggered via the user swiping +the notification from the notification shade. + +On Android, the event is also sent when performing "Clear all" notifications unlike on iOS. + +This event is **not** sent when a notification is cancelled or times out. + +#### Defined in + +[packages/react-native/src/types/Notification.ts:327](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L327) + +*** + +### FG\_ALREADY\_EXIST + +> **FG\_ALREADY\_EXIST**: `8` + +**ANDROID ONLY** + +Event type is sent when a notification wants to start a foreground service but a foreground service is already started. + +#### Defined in + +[packages/react-native/src/types/Notification.ts:384](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L384) + +*** + +### PRESS + +> **PRESS**: `1` + +Event type is sent when a notification has been pressed by the user. + +On Android, notifications must include an `android.pressAction` property for this event to trigger. + +On iOS, this event is always sent when the user presses a notification. + +#### Defined in + +[packages/react-native/src/types/Notification.ts:336](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L336) + +*** + +### TRIGGER\_NOTIFICATION\_CREATED + +> **TRIGGER\_NOTIFICATION\_CREATED**: `7` + +Event type is sent when a notification trigger is created. + +#### Defined in + +[packages/react-native/src/types/Notification.ts:377](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L377) + +*** + +### UNKNOWN + +> **UNKNOWN**: `-1` + +An unknown event was received. + +This event type is a failsafe to catch any unknown events from the device. Please +report an issue with a reproduction so it can be correctly handled. + +#### Defined in + +[packages/react-native/src/types/Notification.ts:317](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L317) diff --git a/docs/react-native/reference/enumerations/IOSIntentIdentifier.mdx b/docs/react-native/reference/enumerations/IOSIntentIdentifier.mdx new file mode 100644 index 00000000..2478104c --- /dev/null +++ b/docs/react-native/reference/enumerations/IOSIntentIdentifier.mdx @@ -0,0 +1,263 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / IOSIntentIdentifier + +# Enumeration: IOSIntentIdentifier + +TODO docs, used to provide context to Siri + +## Platform + +ios + +## Enumeration Members + +### CANCEL\_WORKOUT + +> **CANCEL\_WORKOUT**: `12` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:434](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L434) + +*** + +### END\_WORKOUT + +> **END\_WORKOUT**: `11` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:432](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L432) + +*** + +### GET\_RIDE\_STATUS + +> **GET\_RIDE\_STATUS**: `24` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:458](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L458) + +*** + +### LIST\_RIDE\_OPTIONS + +> **LIST\_RIDE\_OPTIONS**: `22` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:454](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L454) + +*** + +### PAUSE\_WORKOUT + +> **PAUSE\_WORKOUT**: `10` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:430](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L430) + +*** + +### REQUEST\_PAYMENT + +> **REQUEST\_PAYMENT**: `19` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:448](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L448) + +*** + +### REQUEST\_RIDE + +> **REQUEST\_RIDE**: `23` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:456](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L456) + +*** + +### RESUME\_WORKOUT + +> **RESUME\_WORKOUT**: `13` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:436](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L436) + +*** + +### SAVE\_PROFILE\_IN\_CAR + +> **SAVE\_PROFILE\_IN\_CAR**: `8` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:426](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L426) + +*** + +### SEARCH\_CALL\_HISTORY + +> **SEARCH\_CALL\_HISTORY**: `2` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:414](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L414) + +*** + +### SEARCH\_FOR\_MESSAGES + +> **SEARCH\_FOR\_MESSAGES**: `16` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:442](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L442) + +*** + +### SEARCH\_FOR\_PHOTOS + +> **SEARCH\_FOR\_PHOTOS**: `20` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:450](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L450) + +*** + +### SEND\_MESSAGE + +> **SEND\_MESSAGE**: `15` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:440](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L440) + +*** + +### SEND\_PAYMENT + +> **SEND\_PAYMENT**: `18` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:446](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L446) + +*** + +### SET\_AUDIO\_SOURCE\_IN\_CAR + +> **SET\_AUDIO\_SOURCE\_IN\_CAR**: `3` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:416](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L416) + +*** + +### SET\_CLIMATE\_SETTINGS\_IN\_CAR + +> **SET\_CLIMATE\_SETTINGS\_IN\_CAR**: `4` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:418](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L418) + +*** + +### SET\_DEFROSTER\_SETTINGS\_IN\_CAR + +> **SET\_DEFROSTER\_SETTINGS\_IN\_CAR**: `5` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:420](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L420) + +*** + +### SET\_MESSAGE\_ATTRIBUTE + +> **SET\_MESSAGE\_ATTRIBUTE**: `17` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:444](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L444) + +*** + +### SET\_PROFILE\_IN\_CAR + +> **SET\_PROFILE\_IN\_CAR**: `7` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:424](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L424) + +*** + +### SET\_RADIO\_STATION + +> **SET\_RADIO\_STATION**: `14` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:438](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L438) + +*** + +### SET\_SEAT\_SETTINGS\_IN\_CAR + +> **SET\_SEAT\_SETTINGS\_IN\_CAR**: `6` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:422](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L422) + +*** + +### START\_AUDIO\_CALL + +> **START\_AUDIO\_CALL**: `0` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:410](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L410) + +*** + +### START\_PHOTO\_PLAYBACK + +> **START\_PHOTO\_PLAYBACK**: `21` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:452](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L452) + +*** + +### START\_VIDEO\_CALL + +> **START\_VIDEO\_CALL**: `1` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:412](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L412) + +*** + +### START\_WORKOUT + +> **START\_WORKOUT**: `9` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:428](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L428) diff --git a/docs/react-native/reference/enumerations/IOSNotificationSetting.mdx b/docs/react-native/reference/enumerations/IOSNotificationSetting.mdx new file mode 100644 index 00000000..d245883d --- /dev/null +++ b/docs/react-native/reference/enumerations/IOSNotificationSetting.mdx @@ -0,0 +1,53 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / IOSNotificationSetting + +# Enumeration: IOSNotificationSetting + +An enum representing a notification setting for this app on the device. + +Value is greater than 0 if setting enabled, compare against an exact value (e.g. NOT_SUPPORTED) for more +granular control. + +## Platform + +ios + +## Enumeration Members + +### DISABLED + +> **DISABLED**: `0` + +This setting is currently disabled by the user. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:328](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L328) + +*** + +### ENABLED + +> **ENABLED**: `1` + +This setting is currently enabled. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:333](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L333) + +*** + +### NOT\_SUPPORTED + +> **NOT\_SUPPORTED**: `-1` + +This setting is not supported on this device. Usually this means that the iOS version required +for this setting has not been met. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:323](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L323) diff --git a/docs/react-native/reference/enumerations/IOSShowPreviewsSetting.mdx b/docs/react-native/reference/enumerations/IOSShowPreviewsSetting.mdx new file mode 100644 index 00000000..6c22a663 --- /dev/null +++ b/docs/react-native/reference/enumerations/IOSShowPreviewsSetting.mdx @@ -0,0 +1,65 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / IOSShowPreviewsSetting + +# Enumeration: IOSShowPreviewsSetting + +An enum representing the show previews notification setting for this app on the device. + +Value is greater than 0 if previews are to be shown, compare against an exact value +(e.g. WHEN_AUTHENTICATED) for more granular control. + +## Platform + +ios + +## Enumeration Members + +### ALWAYS + +> **ALWAYS**: `1` + +Always show previews even if the device is currently locked. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:302](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L302) + +*** + +### NEVER + +> **NEVER**: `0` + +Never show previews. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:297](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L297) + +*** + +### NOT\_SUPPORTED + +> **NOT\_SUPPORTED**: `-1` + +This setting is not supported on this device. Usually this means that the iOS version required +for this setting (iOS 11+) has not been met. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:292](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L292) + +*** + +### WHEN\_AUTHENTICATED + +> **WHEN\_AUTHENTICATED**: `2` + +Only show previews when the device is unlocked. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:307](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L307) diff --git a/docs/react-native/reference/enumerations/RepeatFrequency.mdx b/docs/react-native/reference/enumerations/RepeatFrequency.mdx new file mode 100644 index 00000000..1b12d6dc --- /dev/null +++ b/docs/react-native/reference/enumerations/RepeatFrequency.mdx @@ -0,0 +1,51 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / RepeatFrequency + +# Enumeration: RepeatFrequency + +An interface representing the different frequencies which can be used with `TimestampTrigger.repeatFrequency`. + +View the [Triggers](/react-native/docs/triggers) documentation to learn more. + +## Enumeration Members + +### DAILY + +> **DAILY**: `1` + +#### Defined in + +[packages/react-native/src/types/Trigger.ts:80](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Trigger.ts#L80) + +*** + +### HOURLY + +> **HOURLY**: `0` + +#### Defined in + +[packages/react-native/src/types/Trigger.ts:79](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Trigger.ts#L79) + +*** + +### NONE + +> **NONE**: `-1` + +#### Defined in + +[packages/react-native/src/types/Trigger.ts:78](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Trigger.ts#L78) + +*** + +### WEEKLY + +> **WEEKLY**: `2` + +#### Defined in + +[packages/react-native/src/types/Trigger.ts:81](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Trigger.ts#L81) diff --git a/docs/react-native/reference/enumerations/TimeUnit.mdx b/docs/react-native/reference/enumerations/TimeUnit.mdx new file mode 100644 index 00000000..6f30d9db --- /dev/null +++ b/docs/react-native/reference/enumerations/TimeUnit.mdx @@ -0,0 +1,51 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / TimeUnit + +# Enumeration: TimeUnit + +An interface representing the different units of time which can be used with `IntervalTrigger.timeUnit`. + +View the [Triggers](/react-native/docs/triggers) documentation to learn more. + +## Enumeration Members + +### DAYS + +> **DAYS**: `"DAYS"` + +#### Defined in + +[packages/react-native/src/types/Trigger.ts:123](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Trigger.ts#L123) + +*** + +### HOURS + +> **HOURS**: `"HOURS"` + +#### Defined in + +[packages/react-native/src/types/Trigger.ts:122](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Trigger.ts#L122) + +*** + +### MINUTES + +> **MINUTES**: `"MINUTES"` + +#### Defined in + +[packages/react-native/src/types/Trigger.ts:121](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Trigger.ts#L121) + +*** + +### SECONDS + +> **SECONDS**: `"SECONDS"` + +#### Defined in + +[packages/react-native/src/types/Trigger.ts:120](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Trigger.ts#L120) diff --git a/docs/react-native/reference/enumerations/TriggerType.mdx b/docs/react-native/reference/enumerations/TriggerType.mdx new file mode 100644 index 00000000..76e77a4b --- /dev/null +++ b/docs/react-native/reference/enumerations/TriggerType.mdx @@ -0,0 +1,31 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / TriggerType + +# Enumeration: TriggerType + +Available Trigger Types. + +View the [Triggers](/react-native/docs/triggers) documentation to learn more with example usage. + +## Enumeration Members + +### INTERVAL + +> **INTERVAL**: `1` + +#### Defined in + +[packages/react-native/src/types/Trigger.ts:133](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Trigger.ts#L133) + +*** + +### TIMESTAMP + +> **TIMESTAMP**: `0` + +#### Defined in + +[packages/react-native/src/types/Trigger.ts:132](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Trigger.ts#L132) diff --git a/docs/react-native/reference/globals.mdx b/docs/react-native/reference/globals.mdx new file mode 100644 index 00000000..923efb80 --- /dev/null +++ b/docs/react-native/reference/globals.mdx @@ -0,0 +1,81 @@ +[**@notifee/react-native**](README.mdx) + +*** + +# @notifee/react-native + +## Enumerations + +- [AlarmType](enumerations/AlarmType.mdx) +- [AndroidBadgeIconType](enumerations/AndroidBadgeIconType.mdx) +- [AndroidCategory](enumerations/AndroidCategory.mdx) +- [AndroidColor](enumerations/AndroidColor.mdx) +- [AndroidDefaults](enumerations/AndroidDefaults.mdx) +- [AndroidFlags](enumerations/AndroidFlags.mdx) +- [AndroidForegroundServiceType](enumerations/AndroidForegroundServiceType.mdx) +- [AndroidGroupAlertBehavior](enumerations/AndroidGroupAlertBehavior.mdx) +- [AndroidImportance](enumerations/AndroidImportance.mdx) +- [AndroidLaunchActivityFlag](enumerations/AndroidLaunchActivityFlag.mdx) +- [AndroidNotificationSetting](enumerations/AndroidNotificationSetting.mdx) +- [AndroidStyle](enumerations/AndroidStyle.mdx) +- [AndroidVisibility](enumerations/AndroidVisibility.mdx) +- [AuthorizationStatus](enumerations/AuthorizationStatus.mdx) +- [EventType](enumerations/EventType.mdx) +- [IOSIntentIdentifier](enumerations/IOSIntentIdentifier.mdx) +- [IOSNotificationSetting](enumerations/IOSNotificationSetting.mdx) +- [IOSShowPreviewsSetting](enumerations/IOSShowPreviewsSetting.mdx) +- [RepeatFrequency](enumerations/RepeatFrequency.mdx) +- [TimeUnit](enumerations/TimeUnit.mdx) +- [TriggerType](enumerations/TriggerType.mdx) + +## Interfaces + +- [AndroidAction](interfaces/AndroidAction.mdx) +- [AndroidBigPictureStyle](interfaces/AndroidBigPictureStyle.mdx) +- [AndroidBigTextStyle](interfaces/AndroidBigTextStyle.mdx) +- [AndroidChannel](interfaces/AndroidChannel.mdx) +- [AndroidChannelGroup](interfaces/AndroidChannelGroup.mdx) +- [AndroidInboxStyle](interfaces/AndroidInboxStyle.mdx) +- [AndroidInput](interfaces/AndroidInput.mdx) +- [AndroidMessagingStyle](interfaces/AndroidMessagingStyle.mdx) +- [AndroidMessagingStyleMessage](interfaces/AndroidMessagingStyleMessage.mdx) +- [AndroidNotificationSettings](interfaces/AndroidNotificationSettings.mdx) +- [AndroidPerson](interfaces/AndroidPerson.mdx) +- [AndroidProgress](interfaces/AndroidProgress.mdx) +- [DisplayedNotification](interfaces/DisplayedNotification.mdx) +- [Event](interfaces/Event.mdx) +- [EventDetail](interfaces/EventDetail.mdx) +- [InitialNotification](interfaces/InitialNotification.mdx) +- [IntervalTrigger](interfaces/IntervalTrigger.mdx) +- [IOSAttachmentThumbnailClippingRect](interfaces/IOSAttachmentThumbnailClippingRect.mdx) +- [IOSCommunicationInfo](interfaces/IOSCommunicationInfo.mdx) +- [IOSCommunicationInfoPerson](interfaces/IOSCommunicationInfoPerson.mdx) +- [IOSForegroundPresentationOptions](interfaces/IOSForegroundPresentationOptions.mdx) +- [IOSInput](interfaces/IOSInput.mdx) +- [IOSNotificationAttachment](interfaces/IOSNotificationAttachment.mdx) +- [IOSNotificationCategory](interfaces/IOSNotificationCategory.mdx) +- [IOSNotificationCategoryAction](interfaces/IOSNotificationCategoryAction.mdx) +- [IOSNotificationPermissions](interfaces/IOSNotificationPermissions.mdx) +- [IOSNotificationSettings](interfaces/IOSNotificationSettings.mdx) +- [NativeAndroidChannel](interfaces/NativeAndroidChannel.mdx) +- [NativeAndroidChannelGroup](interfaces/NativeAndroidChannelGroup.mdx) +- [NativeError](interfaces/NativeError.mdx) +- [Notification](interfaces/Notification.mdx) +- [NotificationAndroid](interfaces/NotificationAndroid.mdx) +- [NotificationFullScreenAction](interfaces/NotificationFullScreenAction.mdx) +- [NotificationIOS](interfaces/NotificationIOS.mdx) +- [NotificationPressAction](interfaces/NotificationPressAction.mdx) +- [NotificationSettings](interfaces/NotificationSettings.mdx) +- [TimestampTrigger](interfaces/TimestampTrigger.mdx) +- [TimestampTriggerAlarmManager](interfaces/TimestampTriggerAlarmManager.mdx) +- [TriggerNotification](interfaces/TriggerNotification.mdx) + +## Type Aliases + +- [ForegroundServiceTask](type-aliases/ForegroundServiceTask.mdx) +- [IOSNotificationInterruptionLevel](type-aliases/IOSNotificationInterruptionLevel.mdx) +- [Trigger](type-aliases/Trigger.mdx) + +## Variables + +- [default](variables/default.mdx) diff --git a/docs/react-native/reference/interfaces/AndroidAction.mdx b/docs/react-native/reference/interfaces/AndroidAction.mdx new file mode 100644 index 00000000..c1f05f5d --- /dev/null +++ b/docs/react-native/reference/interfaces/AndroidAction.mdx @@ -0,0 +1,79 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / AndroidAction + +# Interface: AndroidAction + +The interface used to describe a notification quick action for Android. + +Notification actions allow users to interact with notifications, allowing you to handle events +within your application. When an action completes (e.g. pressing an action, or filling out an input +box) an event is sent. + +View the [Quick Actions](/react-native/docs/android/interaction#quick-actions) documentation to learn more. + +## Platform + +android + +## Properties + +### icon? + +> `optional` **icon**: `string` + +An remote http or local icon path representing the action. Newer devices may not show the icon. + +Recommended icon size is 24x24 px. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:516](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L516) + +*** + +### input? + +> `optional` **input**: `true` \| [`AndroidInput`](AndroidInput.mdx) + +If provided, the action accepts user input. + +If `true`, the user will be able to provide free text input when the action is pressed. This +property can be further configured for advanced inputs. + +View the [Action Input](/react-native/docs/android/interaction#action-input) documentation to +learn more. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:527](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L527) + +*** + +### pressAction + +> **pressAction**: [`NotificationPressAction`](NotificationPressAction.mdx) + +The press action interface describing what happens when an action completes. + +Note; unlike the `pressAction` in the notification body, an action does not need to open the application +and can perform background tasks. See the [AndroidPressAction](/react-native/reference/androidpressaction) reference +or [Quick Actions](/react-native/docs/android/interaction#quick-actions) documentation to learn more. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:504](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L504) + +*** + +### title + +> **title**: `string` + +The title of the action, e.g. "Reply", "Mark as read" etc. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:509](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L509) diff --git a/docs/react-native/reference/interfaces/AndroidBigPictureStyle.mdx b/docs/react-native/reference/interfaces/AndroidBigPictureStyle.mdx new file mode 100644 index 00000000..d70e965a --- /dev/null +++ b/docs/react-native/reference/interfaces/AndroidBigPictureStyle.mdx @@ -0,0 +1,84 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / AndroidBigPictureStyle + +# Interface: AndroidBigPictureStyle + +The interface used when displaying a Big Picture Style notification. + + + +View the [Big Picture](/react-native/docs/android/styles#big-picture) documentation to learn more. + +## Platform + +android + +## Properties + +### largeIcon? + +> `optional` **largeIcon**: `null` \| `string` \| `number` \| `object` + +A local file path using the 'require()' method or a HTTP or file URL to the picture to display. + +If set, overrides the main notification `largeIcon` when the notification is expanded. + +To hide the `largeIcon` when the notification is expanded, set to null. Similar to `thumbnailHidden` for attachments on iOS. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:617](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L617) + +*** + +### picture + +> **picture**: `string` \| `number` \| `object` + +A local file path using the 'require()' method or a HTTP or file URL to the picture to display. + +The image will be automatically resized depending on the device and it's size. If the image could +not be found a blank space will appear. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:603](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L603) + +*** + +### summary? + +> `optional` **summary**: `string` + +If set, overrides the main notification `summary` when the notification is expanded. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:622](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L622) + +*** + +### title? + +> `optional` **title**: `string` + +If set, overrides the main notification `title` when the notification is expanded. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:608](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L608) + +*** + +### type + +> **type**: [`BIGPICTURE`](../enumerations/AndroidStyle.mdx#bigpicture) + +Constant enum value used to identify the style type. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:595](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L595) diff --git a/docs/react-native/reference/interfaces/AndroidBigTextStyle.mdx b/docs/react-native/reference/interfaces/AndroidBigTextStyle.mdx new file mode 100644 index 00000000..3ace5151 --- /dev/null +++ b/docs/react-native/reference/interfaces/AndroidBigTextStyle.mdx @@ -0,0 +1,65 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / AndroidBigTextStyle + +# Interface: AndroidBigTextStyle + +The interface used when displaying a Big Text Style notification. + + + +View the [Big Text](/react-native/docs/android/styles#big-text) documentation to learn more. + +## Platform + +android + +## Properties + +### summary? + +> `optional` **summary**: `string` + +If set, overrides the main notification `summary` when the notification is expanded. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:653](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L653) + +*** + +### text + +> **text**: `string` + +The text to display when the notification is expanded. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:643](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L643) + +*** + +### title? + +> `optional` **title**: `string` + +If set, overrides the main notification `title` when the notification is expanded. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:648](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L648) + +*** + +### type + +> **type**: [`BIGTEXT`](../enumerations/AndroidStyle.mdx#bigtext) + +Constant enum value used to identify the style type. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:638](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L638) diff --git a/docs/react-native/reference/interfaces/AndroidChannel.mdx b/docs/react-native/reference/interfaces/AndroidChannel.mdx new file mode 100644 index 00000000..d7705a26 --- /dev/null +++ b/docs/react-native/reference/interfaces/AndroidChannel.mdx @@ -0,0 +1,250 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / AndroidChannel + +# Interface: AndroidChannel + +An interface for describing an Android Channel. + +Channels override any individual notification preferences (e.g. lights/vibration) and the user +has final control over the setting. Once created, only channel metadata can be updated (e.g. name). + +View the [Channels & Groups](/react-native/docs/android/channels) documentation to learn more. + +## Platform + +android + +## Extended by + +- [`NativeAndroidChannel`](NativeAndroidChannel.mdx) + +## Properties + +### badge? + +> `optional` **badge**: `boolean` + +Sets whether badges are enabled for the channel. + +View the [Badges](/react-native/docs/android/appearance#badges) documentation to learn more. + +Defaults to `true`. + +This setting cannot be overridden once the channel is created. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:881](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L881) + +*** + +### bypassDnd? + +> `optional` **bypassDnd**: `boolean` + +Sets whether or not notifications posted to this channel can interrupt the user in +'Do Not Disturb' mode. + +Defaults to `false`. + +This setting cannot be overridden once the channel is created. + +#### Platform + +android API Level >= 29 + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:893](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L893) + +*** + +### description? + +> `optional` **description**: `string` + +Sets the user visible description of this channel. + +The recommended maximum length is 300 characters; the value may be truncated if it is too long. + +This setting can be updated after creation. + +#### Platform + +android API Level >= 28 + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:904](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L904) + +*** + +### groupId? + +> `optional` **groupId**: `string` + +Sets what group this channel belongs to. Group information is only used for presentation, not for behavior. + +Groups can be created via via [`createChannelGroup`](/react-native/reference/createchannelgroup). + +This setting cannot be overridden once the channel is created. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:931](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L931) + +*** + +### id + +> **id**: `string` + +The unique channel ID. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:862](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L862) + +*** + +### importance? + +> `optional` **importance**: [`AndroidImportance`](../enumerations/AndroidImportance.mdx) + +Sets the level of interruption of this notification channel. + +Defaults to `AndroidImportance.DEFAULT`. + +This setting can only be set to a lower importance level once set. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:940](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L940) + +*** + +### lightColor? + +> `optional` **lightColor**: `string` + +If lights are enabled (via `lights`), sets/overrides the light color for notifications +posted to this channel. + +This setting cannot be overridden once the channel is created. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:948](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L948) + +*** + +### lights? + +> `optional` **lights**: `boolean` + +Sets whether notifications posted to this channel should display notification lights, on devices that support that feature. + +Defaults to `true`. + +This setting cannot be overridden once the channel is created. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:913](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L913) + +*** + +### name + +> **name**: `string` + +The channel name. This is shown to the user so must be descriptive and relate to the notifications +which will be delivered under this channel. + +This setting can be updated after creation. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:870](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L870) + +*** + +### sound? + +> `optional` **sound**: `string` + +Overrides the sound the notification is displayed with. + +The default value is to play no sound. To play the default system sound use 'default'. + +This setting cannot be overridden once the channel is created. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:976](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L976) + +*** + +### soundURI? + +> `optional` **soundURI**: `string` + +The URI of the notification sound associated with the channel, if any. + +This is a read-only value, and is under user control after the channel is created + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:983](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L983) + +*** + +### vibration? + +> `optional` **vibration**: `boolean` + +Sets whether notification posted to this channel should vibrate. + +Defaults to `true`. + +This setting cannot be overridden once the channel is created. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:922](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L922) + +*** + +### vibrationPattern? + +> `optional` **vibrationPattern**: `number`[] + +Sets/overrides the vibration pattern for notifications posted to this channel. + +The pattern in milliseconds. Must be an even amount of numbers. + +This setting cannot be overridden once the channel is created. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:967](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L967) + +*** + +### visibility? + +> `optional` **visibility**: [`AndroidVisibility`](../enumerations/AndroidVisibility.mdx) + +Sets whether notifications posted to this channel appear on the lockscreen or not, +and if so, whether they appear in a redacted form. + +Defaults to `AndroidVisibility.PRIVATE`. + +This setting cannot be overridden once the channel is created. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:958](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L958) diff --git a/docs/react-native/reference/interfaces/AndroidChannelGroup.mdx b/docs/react-native/reference/interfaces/AndroidChannelGroup.mdx new file mode 100644 index 00000000..78e25bc8 --- /dev/null +++ b/docs/react-native/reference/interfaces/AndroidChannelGroup.mdx @@ -0,0 +1,67 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / AndroidChannelGroup + +# Interface: AndroidChannelGroup + +An interface for describing an Android Channel Group. + +Channel groups have no impact on the notification, they are used to help group channels in the applications +settings UI. + +View the [Channels & Groups](/react-native/docs/android/channels) documentation to learn more. + +## Platform + +android API Level >= 26 + +## Extended by + +- [`NativeAndroidChannelGroup`](NativeAndroidChannelGroup.mdx) + +## Properties + +### description? + +> `optional` **description**: `string` + +An optional description of the group. This is visible to the user. + +On Android APIs less than 28 this will always be undefined. + +#### Platform + +android API Level >= 28 + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1039](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1039) + +*** + +### id + +> **id**: `string` + +Unique id for this channel group. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1022](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1022) + +*** + +### name + +> **name**: `string` + +The name of the group. This is visible to the user so should be a descriptive name which +categorizes other channels (e.g. reminders). + +The recommended maximum length is 40 characters; the value may be truncated if it is too long. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1030](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1030) diff --git a/docs/react-native/reference/interfaces/AndroidInboxStyle.mdx b/docs/react-native/reference/interfaces/AndroidInboxStyle.mdx new file mode 100644 index 00000000..0d9feeff --- /dev/null +++ b/docs/react-native/reference/interfaces/AndroidInboxStyle.mdx @@ -0,0 +1,68 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / AndroidInboxStyle + +# Interface: AndroidInboxStyle + +The interface used when displaying a Inbox Style notification. + + + +View the [Inbox](/react-native/docs/android/styles#inbox) documentation to learn more. + +## Platform + +android + +## Properties + +### lines + +> **lines**: `string`[] + +An array of messages to display, in order provided. + +The device will automatically handle displaying the lines visible depending on space in the notification +shade. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:677](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L677) + +*** + +### summary? + +> `optional` **summary**: `string` + +If set, overrides the main notification `summary` when the notification is expanded. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:687](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L687) + +*** + +### title? + +> `optional` **title**: `string` + +If set, overrides the main notification `title` when the notification is expanded. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:682](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L682) + +*** + +### type + +> **type**: [`INBOX`](../enumerations/AndroidStyle.mdx#inbox) + +Constant enum value used to identify the style type. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:669](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L669) diff --git a/docs/react-native/reference/interfaces/AndroidInput.mdx b/docs/react-native/reference/interfaces/AndroidInput.mdx new file mode 100644 index 00000000..b43d5331 --- /dev/null +++ b/docs/react-native/reference/interfaces/AndroidInput.mdx @@ -0,0 +1,93 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / AndroidInput + +# Interface: AndroidInput + +The interface used to enable advanced user input on a notification. + +View the [Action Input](/react-native/docs/android/interaction#action-input) documentation to learn more. + +## Platform + +android + +## Properties + +### allowFreeFormInput? + +> `optional` **allowFreeFormInput**: `boolean` + +Sets whether the user can freely enter text into the input. + +This value changes the behaviour of the notification: + +- If `true`, when an action is pressed this allows the user to type free form text into the input area. +- If `false`, you must provide an array of `choices` the user is allowed to use as the input. + +Defaults to `true`. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:548](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L548) + +*** + +### allowGeneratedReplies? + +> `optional` **allowGeneratedReplies**: `boolean` + +Sets whether generated replies can be added to the action. + +Generated replies will only be shown if the input has `choices` and whether the device +is able to generate replies. + +Defaults to `true`. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:558](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L558) + +*** + +### choices? + +> `optional` **choices**: `string`[] + +An array of pre-defined input choices the user can select. + +If `allowFreeFormInput` is `false`, this property must contain at least one choice. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:565](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L565) + +*** + +### editableChoices? + +> `optional` **editableChoices**: `boolean` + +If `true`, the user will be able to edit the selected choice before sending the action event, however +`allowFreeFormInput` must also be `true`. + +By default, the platform will decide whether choices can be editable. To explicitly enable or disable +this, provide `true` or `false`. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:574](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L574) + +*** + +### placeholder? + +> `optional` **placeholder**: `string` + +The placeholder text to display inside of the user input area. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:579](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L579) diff --git a/docs/react-native/reference/interfaces/AndroidMessagingStyle.mdx b/docs/react-native/reference/interfaces/AndroidMessagingStyle.mdx new file mode 100644 index 00000000..21ef4e33 --- /dev/null +++ b/docs/react-native/reference/interfaces/AndroidMessagingStyle.mdx @@ -0,0 +1,77 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / AndroidMessagingStyle + +# Interface: AndroidMessagingStyle + +The interface used when displaying a Messaging Style notification. + + + +View the [Messaging](/react-native/docs/android/styles#messaging) documentation to learn more. + +## Platform + +android + +## Properties + +### group? + +> `optional` **group**: `boolean` + +Sets whether this conversation notification represents a group (3 or more persons). + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:723](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L723) + +*** + +### messages + +> **messages**: [`AndroidMessagingStyleMessage`](AndroidMessagingStyleMessage.mdx)[] + +An array of messages to display inside the notification. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:713](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L713) + +*** + +### person + +> **person**: [`AndroidPerson`](AndroidPerson.mdx) + +The person who is receiving a message on the current device. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:708](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L708) + +*** + +### title? + +> `optional` **title**: `string` + +If set, overrides the main notification `title` when the notification is expanded. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:718](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L718) + +*** + +### type + +> **type**: [`MESSAGING`](../enumerations/AndroidStyle.mdx#messaging) + +Constant enum value used to identify the style type. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:703](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L703) diff --git a/docs/react-native/reference/interfaces/AndroidMessagingStyleMessage.mdx b/docs/react-native/reference/interfaces/AndroidMessagingStyleMessage.mdx new file mode 100644 index 00000000..16d57f3c --- /dev/null +++ b/docs/react-native/reference/interfaces/AndroidMessagingStyleMessage.mdx @@ -0,0 +1,57 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / AndroidMessagingStyleMessage + +# Interface: AndroidMessagingStyleMessage + +The interface for messages when constructing a Messaging Style notification. + + + +View the [`AndroidMessagingStyle`](/react-native/reference/androidmessagingstyle) reference +and [Messaging](/react-native/docs/android/styles#messaging) documentation to learn more. + +## Platform + +android + +## Properties + +### person? + +> `optional` **person**: [`AndroidPerson`](AndroidPerson.mdx) + +The sender of this message. See [`AndroidPerson`](/react-native/reference/androidperson) reference +for more information on the properties available. + +This property should only be provided if the message is from an external person, and not the person receiving the message. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:753](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L753) + +*** + +### text + +> **text**: `string` + +The content of the message. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:740](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L740) + +*** + +### timestamp + +> **timestamp**: `number` + +The timestamp of when the message arrived in milliseconds. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:745](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L745) diff --git a/docs/react-native/reference/interfaces/AndroidNotificationSettings.mdx b/docs/react-native/reference/interfaces/AndroidNotificationSettings.mdx new file mode 100644 index 00000000..b7d3d051 --- /dev/null +++ b/docs/react-native/reference/interfaces/AndroidNotificationSettings.mdx @@ -0,0 +1,23 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / AndroidNotificationSettings + +# Interface: AndroidNotificationSettings + +## Properties + +### alarm + +> **alarm**: [`AndroidNotificationSetting`](../enumerations/AndroidNotificationSetting.mdx) + +Enum describing if you can create triggers + +For Android < 12 / API < 31, this will default to true + +View the [Trigger](/react-native/docs/android/triggers#android-12-limitations) documentation for more information. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:482](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L482) diff --git a/docs/react-native/reference/interfaces/AndroidPerson.mdx b/docs/react-native/reference/interfaces/AndroidPerson.mdx new file mode 100644 index 00000000..be24e771 --- /dev/null +++ b/docs/react-native/reference/interfaces/AndroidPerson.mdx @@ -0,0 +1,107 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / AndroidPerson + +# Interface: AndroidPerson + +The interface used to describe a person shown in notifications. + +Currently used with [`AndroidMessagingStyle`](/react-native/reference/androidmessagingstyle) notifications. + +## Platform + +android + +## Properties + +### bot? + +> `optional` **bot**: `boolean` + +If `true` this person represents a machine rather than a human. This is used primarily for testing and automated tooling. + +Defaults to `false`. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:782](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L782) + +*** + +### icon? + +> `optional` **icon**: `string` + +The icon to display next to the person in the notification. The icon can be URL or local +Android resource. + +If not provided, an icon will be automatically creating using the `name` property. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:801](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L801) + +*** + +### id? + +> `optional` **id**: `string` + +An optional unique ID of the person. Setting this property is preferred for unique identification, +however not required. If no value is provided, the `name` will be used instead.. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:775](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L775) + +*** + +### important? + +> `optional` **important**: `boolean` + +If `true` this person will be marked as important. + +Important users are those who frequently contact the receiving person. If the app is in +"Do not disturb" mode, a notification containing an important person may override this mode +if the person has been whitelisted on the device. + +Defaults to `false`. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:793](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L793) + +*** + +### name + +> **name**: `string` + +The name of the person. + +If no `id` is provided, the name will be used as the unique identifier. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:769](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L769) + +*** + +### uri? + +> `optional` **uri**: `string` + +URI contact of the person. + +The URI can be any of the following: + + - The representation of a contact URI, e.g. `android.provider.ContactsContract.Contacts#CONTENT_LOOKUP_URI` + - A `mailto:` string + - A `tel:` string + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:812](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L812) diff --git a/docs/react-native/reference/interfaces/AndroidProgress.mdx b/docs/react-native/reference/interfaces/AndroidProgress.mdx new file mode 100644 index 00000000..76c0ce9a --- /dev/null +++ b/docs/react-native/reference/interfaces/AndroidProgress.mdx @@ -0,0 +1,60 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / AndroidProgress + +# Interface: AndroidProgress + +Interface for defining the progress of an Android Notification. + + + +View the [Progress Indicators](/react-native/docs/android/progress-indicators) documentation to learn more. + +## Platform + +android + +## Properties + +### current? + +> `optional` **current**: `number` + +The current progress value. + +E.g. setting to `4` with a `max` value of `10` would set a fixed progress bar on the notification at 40% complete. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:837](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L837) + +*** + +### indeterminate? + +> `optional` **indeterminate**: `boolean` + +If `true`, overrides the `max` and `current` values and displays an unknown progress style. Useful when you have no +knowledge of a tasks completion state. + +Defaults to `false`. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:845](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L845) + +*** + +### max? + +> `optional` **max**: `number` + +The maximum progress number. E.g `10`. + +Must be greater than the `current` value. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:830](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L830) diff --git a/docs/react-native/reference/interfaces/DisplayedNotification.mdx b/docs/react-native/reference/interfaces/DisplayedNotification.mdx new file mode 100644 index 00000000..f9e3857a --- /dev/null +++ b/docs/react-native/reference/interfaces/DisplayedNotification.mdx @@ -0,0 +1,61 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / DisplayedNotification + +# Interface: DisplayedNotification + +An interface representing a notification that is currently displayed in the notification tray. + +## Properties + +### date? + +> `optional` **date**: `string` + +Date the notification was shown to the user + +#### Defined in + +[packages/react-native/src/types/Notification.ts:133](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L133) + +*** + +### id? + +> `optional` **id**: `string` + +ID of the notification + +#### Defined in + +[packages/react-native/src/types/Notification.ts:128](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L128) + +*** + +### notification + +> **notification**: [`Notification`](Notification.mdx) + +The payload that was used to create the notification (if available) + +#### Defined in + +[packages/react-native/src/types/Notification.ts:138](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L138) + +*** + +### trigger + +> **trigger**: [`Trigger`](../type-aliases/Trigger.mdx) + +The trigger that was used to schedule the notification (if available) + +#### Platform + +iOS + +#### Defined in + +[packages/react-native/src/types/Notification.ts:145](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L145) diff --git a/docs/react-native/reference/interfaces/Event.mdx b/docs/react-native/reference/interfaces/Event.mdx new file mode 100644 index 00000000..4433d3bf --- /dev/null +++ b/docs/react-native/reference/interfaces/Event.mdx @@ -0,0 +1,36 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / Event + +# Interface: Event + +An interface representing a Notifee event. + +View the [Events](/react-native/docs/events) documentation to learn more about foreground and +background events. + +## Properties + +### detail + +> **detail**: [`EventDetail`](EventDetail.mdx) + +An object containing event detail. + +#### Defined in + +[packages/react-native/src/types/Notification.ts:178](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L178) + +*** + +### type + +> **type**: [`EventType`](../enumerations/EventType.mdx) + +The type of notification event. + +#### Defined in + +[packages/react-native/src/types/Notification.ts:173](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L173) diff --git a/docs/react-native/reference/interfaces/EventDetail.mdx b/docs/react-native/reference/interfaces/EventDetail.mdx new file mode 100644 index 00000000..71c73397 --- /dev/null +++ b/docs/react-native/reference/interfaces/EventDetail.mdx @@ -0,0 +1,131 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / EventDetail + +# Interface: EventDetail + +An interface representing the different detail values which can be provided with a notification event. + +View the [Events](/react-native/docs/events) documentation to learn more. + +## Properties + +### blocked? + +> `optional` **blocked**: `boolean` + +The notification blocked status of your entire application. + +The blocked detail is available when the event type is [`EventType.APP_BLOCKED`](/react-native/reference/eventtype#app_blocked). + +#### Platform + +android API Level >= 28 + +#### Defined in + +[packages/react-native/src/types/Notification.ts:461](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L461) + +*** + +### channel? + +> `optional` **channel**: [`NativeAndroidChannel`](NativeAndroidChannel.mdx) + +The channel that had its block state changed. + +Note that if the channel no longer exists during the time the event was sent the channel property will be undefined. + +The channel detail is available when the event type is [`EventType.CHANNEL_BLOCKED`](/react-native/reference/eventtype#channel_blocked). + +#### Platform + +android API Level >= 28 + +#### Defined in + +[packages/react-native/src/types/Notification.ts:441](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L441) + +*** + +### channelGroup? + +> `optional` **channelGroup**: [`NativeAndroidChannelGroup`](NativeAndroidChannelGroup.mdx) + +The channel group that had its block state changed. + +Note that if the channel no longer exists during the time the event was sent the channel group property will be undefined. + +The channel group detail is available when the event type is [`EventType.CHANNEL_GROUP_BLOCKED`](/react-native/reference/eventtype#channel_group_blocked). + +#### Platform + +android API Level >= 28 + +#### Defined in + +[packages/react-native/src/types/Notification.ts:452](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L452) + +*** + +### input? + +> `optional` **input**: `string` + +The input from a notification action. + +The input detail is available when the [`EventType`](/react-native/reference/eventtype) is: + +- [`EventType.ACTION_PRESS`](/react-native/reference/eventtype#action_press) +- The notification quick action has input enabled. View [`AndroidInput`](/react-native/reference/androidinput) for more details. + +#### Platform + +android API Level >= 20 + +#### Defined in + +[packages/react-native/src/types/Notification.ts:430](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L430) + +*** + +### notification? + +> `optional` **notification**: [`Notification`](Notification.mdx) + +The notification this event relates to. + +The notification details is available when the [`EventType`](/react-native/reference/eventtype) is one of: + + - [`EventType.DISMISSED`](/react-native/reference/eventtype#dismissed) + - [`EventType.PRESS`](/react-native/reference/eventtype#press) + - [`EventType.ACTION_PRESS`](/react-native/reference/eventtype#action_press) + - [`EventType.DELIVERED`](/react-native/reference/eventtype#delivered) + - [`EventType.TRIGGER_NOTIFICATION_CREATED`](/react-native/reference/eventtype#trigger_notification_created) + - [`EventType.FG_ALREADY_EXIST`](/react-native/reference/eventtype#fg_already_exist) + +#### Defined in + +[packages/react-native/src/types/Notification.ts:405](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L405) + +*** + +### pressAction? + +> `optional` **pressAction**: [`NotificationPressAction`](NotificationPressAction.mdx) + +The press action which triggered the event. + +If a press action caused the event, this property will be available allowing you to retrieve the +action ID and perform logic. + +The press action details is available when the [`EventType`](/react-native/reference/eventtype) is one of: + +- [`EventType.PRESS`](/react-native/reference/eventtype#press) +- [`EventType.ACTION_PRESS`](/react-native/reference/eventtype#action_press) + +#### Defined in + +[packages/react-native/src/types/Notification.ts:418](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L418) diff --git a/docs/react-native/reference/interfaces/IOSAttachmentThumbnailClippingRect.mdx b/docs/react-native/reference/interfaces/IOSAttachmentThumbnailClippingRect.mdx new file mode 100644 index 00000000..4034f792 --- /dev/null +++ b/docs/react-native/reference/interfaces/IOSAttachmentThumbnailClippingRect.mdx @@ -0,0 +1,58 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / IOSAttachmentThumbnailClippingRect + +# Interface: IOSAttachmentThumbnailClippingRect + +The interface used to specify the portion of your image that you want to be displayed as the thumbnail + +Values are in the range 0.0 to 1.0. + +For example, specifying an origin (x,y) of (0.25, 0.25) and a size (width, height) of (0.5, 0.5) +defines a clipping rectangle that shows only the center portion of the image. + +## Platform + +ios + +## Properties + +### height + +> **height**: `number` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:674](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L674) + +*** + +### width + +> **width**: `number` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:673](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L673) + +*** + +### x + +> **x**: `number` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:671](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L671) + +*** + +### y + +> **y**: `number` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:672](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L672) diff --git a/docs/react-native/reference/interfaces/IOSCommunicationInfo.mdx b/docs/react-native/reference/interfaces/IOSCommunicationInfo.mdx new file mode 100644 index 00000000..519b0a3e --- /dev/null +++ b/docs/react-native/reference/interfaces/IOSCommunicationInfo.mdx @@ -0,0 +1,63 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / IOSCommunicationInfo + +# Interface: IOSCommunicationInfo + +An interface to support communication notifications on iOS 15 and above + +## Platform + +ios + +## Properties + +### body? + +> `optional` **body**: `string` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:135](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L135) + +*** + +### conversationId + +> **conversationId**: `string` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:134](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L134) + +*** + +### groupAvatar? + +> `optional` **groupAvatar**: `string` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:137](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L137) + +*** + +### groupName? + +> `optional` **groupName**: `string` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:136](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L136) + +*** + +### sender + +> **sender**: [`IOSCommunicationInfoPerson`](IOSCommunicationInfoPerson.mdx) + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:138](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L138) diff --git a/docs/react-native/reference/interfaces/IOSCommunicationInfoPerson.mdx b/docs/react-native/reference/interfaces/IOSCommunicationInfoPerson.mdx new file mode 100644 index 00000000..31da45f6 --- /dev/null +++ b/docs/react-native/reference/interfaces/IOSCommunicationInfoPerson.mdx @@ -0,0 +1,37 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / IOSCommunicationInfoPerson + +# Interface: IOSCommunicationInfoPerson + +## Properties + +### avatar? + +> `optional` **avatar**: `string` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:144](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L144) + +*** + +### displayName + +> **displayName**: `string` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:143](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L143) + +*** + +### id + +> **id**: `string` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:142](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L142) diff --git a/docs/react-native/reference/interfaces/IOSForegroundPresentationOptions.mdx b/docs/react-native/reference/interfaces/IOSForegroundPresentationOptions.mdx new file mode 100644 index 00000000..bf68b9cd --- /dev/null +++ b/docs/react-native/reference/interfaces/IOSForegroundPresentationOptions.mdx @@ -0,0 +1,96 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / IOSForegroundPresentationOptions + +# Interface: IOSForegroundPresentationOptions + +An interface to customise how notifications are shown when the app is in the foreground. + +By default, Notifee will show iOS notifications in heads-up mode if your app is currently in the foreground. + +View the [Foreground Notifications](/react-native/docs/ios/appearance#foreground-notifications) to learn +more. + +## Platform + +ios + +## Properties + +### ~~alert?~~ + +> `optional` **alert**: `boolean` + +App in foreground dialog box which indicates when a decision has to be made + +Defaults to true + +#### Deprecated + +Use `banner` and `list` instead + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:164](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L164) + +*** + +### badge? + +> `optional` **badge**: `boolean` + +App in foreground badge update + +Defaults to true + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:178](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L178) + +*** + +### banner? + +> `optional` **banner**: `boolean` + +Present the notification as a banner + +For iOS 13 and lower, will be equivalent to setting `alert` to true + +Defaults to true + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:187](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L187) + +*** + +### list? + +> `optional` **list**: `boolean` + +Show the notification in Notification Center + +For iOS 13 and lower, will be equivalent to setting `alert` to true + +Defaults to true + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:196](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L196) + +*** + +### sound? + +> `optional` **sound**: `boolean` + +App in foreground notification sound + +Defaults to true + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:171](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L171) diff --git a/docs/react-native/reference/interfaces/IOSInput.mdx b/docs/react-native/reference/interfaces/IOSInput.mdx new file mode 100644 index 00000000..808b66be --- /dev/null +++ b/docs/react-native/reference/interfaces/IOSInput.mdx @@ -0,0 +1,39 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / IOSInput + +# Interface: IOSInput + +The interface used to enable advanced user input on a notification. + +View the [Action input](/react-native/docs/ios/interaction#action-input) documentation to learn more. + +## Platform + +ios + +## Properties + +### buttonText? + +> `optional` **buttonText**: `string` + +Overrides the default button text "Send", next to the input box. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:594](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L594) + +*** + +### placeholderText? + +> `optional` **placeholderText**: `string` + +The placeholder text displayed in the text input field for this action. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:599](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L599) diff --git a/docs/react-native/reference/interfaces/IOSNotificationAttachment.mdx b/docs/react-native/reference/interfaces/IOSNotificationAttachment.mdx new file mode 100644 index 00000000..3d9ce0d0 --- /dev/null +++ b/docs/react-native/reference/interfaces/IOSNotificationAttachment.mdx @@ -0,0 +1,106 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / IOSNotificationAttachment + +# Interface: IOSNotificationAttachment + +An interface for describing an iOS Notification Attachment. + +View the [Attachments](/react-native/docs/ios/appearance#attachments) documentation to learn more. + +## Platform + +ios + +## Properties + +### id? + +> `optional` **id**: `string` + +A optional unique identifier of the attachment. +If no `id` is provided, a unique id is created for you. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:614](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L614) + +*** + +### thumbnailClippingRect? + +> `optional` **thumbnailClippingRect**: [`IOSAttachmentThumbnailClippingRect`](IOSAttachmentThumbnailClippingRect.mdx) + +An optional clipping rectangle for a thumbnail image. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:646](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L646) + +*** + +### thumbnailHidden? + +> `optional` **thumbnailHidden**: `boolean` + +When set to `true` the thumbnail will be hidden. +Defaults to `false`. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:641](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L641) + +*** + +### thumbnailTime? + +> `optional` **thumbnailTime**: `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. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:657](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L657) + +*** + +### typeHint? + +> `optional` **typeHint**: `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](https://developer.apple.com/library/archive/documentation/Miscellaneous/Reference/UTIRef/Articles/System-DeclaredUniformTypeIdentifiers.html) 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. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:635](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L635) + +*** + +### 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](https://developer.apple.com/documentation/usernotifications/unnotificationattachment#1682051) on the official Apple documentation for more information. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:626](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L626) diff --git a/docs/react-native/reference/interfaces/IOSNotificationCategory.mdx b/docs/react-native/reference/interfaces/IOSNotificationCategory.mdx new file mode 100644 index 00000000..b0502b7d --- /dev/null +++ b/docs/react-native/reference/interfaces/IOSNotificationCategory.mdx @@ -0,0 +1,117 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / IOSNotificationCategory + +# Interface: IOSNotificationCategory + +A interface representing a notification category created via [`setNotificationCategories`](/react-native/reference/setnotificationcategories). + +At minimum, a category must be created with a unique identifier, all other properties are optional. + +View the [Categories](/react-native/docs/ios/categories) documentation to learn more. + +## Platform + +ios + +## Properties + +### actions? + +> `optional` **actions**: [`IOSNotificationCategoryAction`](IOSNotificationCategoryAction.mdx)[] + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:532](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L532) + +*** + +### allowAnnouncement? + +> `optional` **allowAnnouncement**: `boolean` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:499](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L499) + +*** + +### allowInCarPlay? + +> `optional` **allowInCarPlay**: `boolean` + +Allow notifications in this category to be displayed in a CarPlay environment. + +Defaults to `false`. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:488](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L488) + +*** + +### hiddenPreviewsBodyPlaceholder? + +> `optional` **hiddenPreviewsBodyPlaceholder**: `string` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:520](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L520) + +*** + +### hiddenPreviewsShowSubtitle? + +> `optional` **hiddenPreviewsShowSubtitle**: `boolean` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:513](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L513) + +*** + +### hiddenPreviewsShowTitle? + +> `optional` **hiddenPreviewsShowTitle**: `boolean` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:506](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L506) + +*** + +### id + +> **id**: `string` + +The unique ID for the category. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:474](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L474) + +*** + +### intentIdentifiers? + +> `optional` **intentIdentifiers**: [`IOSIntentIdentifier`](../enumerations/IOSIntentIdentifier.mdx)[] + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:522](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L522) + +*** + +### summaryFormat? + +> `optional` **summaryFormat**: `string` + +Specify a custom format for the summary text, which is visible when notifications are grouped together. + +View the [Summary Text](/react-native/docs/ios/categories#category-summary-text) documentation to learn more. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:481](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L481) diff --git a/docs/react-native/reference/interfaces/IOSNotificationCategoryAction.mdx b/docs/react-native/reference/interfaces/IOSNotificationCategoryAction.mdx new file mode 100644 index 00000000..2a3ec02d --- /dev/null +++ b/docs/react-native/reference/interfaces/IOSNotificationCategoryAction.mdx @@ -0,0 +1,97 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / IOSNotificationCategoryAction + +# Interface: IOSNotificationCategoryAction + +The interface used to describe a notification quick action for iOS. + +Quick actions allow users to interact with notifications, allowing you to handle events +within your application. When an action completes (e.g. pressing an action, or filling out an input +box) an event is sent. + +View the [Quick Actions](/react-native/docs/ios/interaction#quick-actions) documentation to learn more. + +## Platform + +ios + +## Properties + +### authenticationRequired? + +> `optional` **authenticationRequired**: `boolean` + +Whether this action should require unlocking before being performed. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:580](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L580) + +*** + +### destructive? + +> `optional` **destructive**: `boolean` + +Makes the action red, indicating that the action is destructive. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:570](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L570) + +*** + +### foreground? + +> `optional` **foreground**: `boolean` + +Whether this action should cause the application to launch in the foreground. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:575](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L575) + +*** + +### id + +> **id**: `string` + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:547](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L547) + +*** + +### input? + +> `optional` **input**: `true` \| [`IOSInput`](IOSInput.mdx) + +If provided, the action accepts custom user input. + +If `true`, the user will be able to provide free text input when the action is pressed. + +The placeholder and button text can be customized by providing an object +of type [`IOSInput`](/react-native/reference/iosinput). + +View the [Action Input](/react-native/docs/ios/interaction#action-input) documentation to +learn more. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:565](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L565) + +*** + +### title + +> **title**: `string` + +The title of the action, e.g. "Reply", "Mark as read" etc. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:552](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L552) diff --git a/docs/react-native/reference/interfaces/IOSNotificationPermissions.mdx b/docs/react-native/reference/interfaces/IOSNotificationPermissions.mdx new file mode 100644 index 00000000..a639824c --- /dev/null +++ b/docs/react-native/reference/interfaces/IOSNotificationPermissions.mdx @@ -0,0 +1,126 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / IOSNotificationPermissions + +# Interface: IOSNotificationPermissions + +An interface representing all the available permissions that can be requested by your app via +the [`requestPermission`](/react-native/reference/requestpermission) API. + +View the [Permissions](/react-native/docs/ios/permissions) to learn +more. + +## Platform + +ios + +## Properties + +### alert? + +> `optional` **alert**: `boolean` + +Request permission to display alerts. + +Defaults to true. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:214](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L214) + +*** + +### announcement? + +> `optional` **announcement**: `boolean` + +Request permission for Siri to automatically read out notification messages over AirPods. + +Defaults to false. + +#### Platform + +ios iOS >= 13 + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:263](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L263) + +*** + +### badge? + +> `optional` **badge**: `boolean` + +Request permission to update the application badge. + +Defaults to true. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:231](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L231) + +*** + +### carPlay? + +> `optional` **carPlay**: `boolean` + +Request permission to display notifications in a CarPlay environment. + +Defaults to true. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:245](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L245) + +*** + +### criticalAlert? + +> `optional` **criticalAlert**: `boolean` + +Request permission to display critical notifications. + +View the [Critical Notifications](/react-native/docs/ios/behaviour#critical-notifications) documentation for more information +and usage examples. + +Defaults to false. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:224](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L224) + +*** + +### provisional? + +> `optional` **provisional**: `boolean` + +Request permission to provisionally create non-interrupting notifications. + +Defaults to false. + +#### Platform + +ios iOS >= 12 + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:254](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L254) + +*** + +### sound? + +> `optional` **sound**: `boolean` + +Request permission to play sounds. + +Defaults to true. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:238](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L238) diff --git a/docs/react-native/reference/interfaces/IOSNotificationSettings.mdx b/docs/react-native/reference/interfaces/IOSNotificationSettings.mdx new file mode 100644 index 00000000..ca897c9d --- /dev/null +++ b/docs/react-native/reference/interfaces/IOSNotificationSettings.mdx @@ -0,0 +1,152 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / IOSNotificationSettings + +# Interface: IOSNotificationSettings + +An interface representing the current authorization status and notification-related settings for your app. + +This interface is returned from [`requestPermission`](/react-native/reference/requestpermission) +and [`getNotificationSettings`](/react-native/reference/getnotificationsettings). + +View the [Observing Settings](/react-native/docs/ios/permissions#observing-settings) documentation to learn more. + +## Platform + +ios + +## Properties + +### alert + +> **alert**: [`IOSNotificationSetting`](../enumerations/IOSNotificationSetting.mdx) + +Enum describing if notifications will alert the user. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:350](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L350) + +*** + +### announcement + +> **announcement**: [`IOSNotificationSetting`](../enumerations/IOSNotificationSetting.mdx) + +Enum describing if notifications can be announced to the user +via 3rd party services such as Siri. + +For example, if the notification can be automatically read by Siri +while the user is wearing AirPods. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:389](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L389) + +*** + +### authorizationStatus + +> **authorizationStatus**: [`AuthorizationStatus`](../enumerations/AuthorizationStatus.mdx) + +Overall notification authorization status for the application. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:401](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L401) + +*** + +### badge + +> **badge**: [`IOSNotificationSetting`](../enumerations/IOSNotificationSetting.mdx) + +Enum describing if notifications can update the application badge. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:355](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L355) + +*** + +### carPlay + +> **carPlay**: [`IOSNotificationSetting`](../enumerations/IOSNotificationSetting.mdx) + +Enum describing if notifications can be displayed in a CarPlay environment. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:375](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L375) + +*** + +### criticalAlert + +> **criticalAlert**: [`IOSNotificationSetting`](../enumerations/IOSNotificationSetting.mdx) + +Enum describing if critical notifications are allowed. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:360](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L360) + +*** + +### inAppNotificationSettings + +> **inAppNotificationSettings**: [`IOSNotificationSetting`](../enumerations/IOSNotificationSetting.mdx) + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:396](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L396) + +*** + +### lockScreen + +> **lockScreen**: [`IOSNotificationSetting`](../enumerations/IOSNotificationSetting.mdx) + +Enum describing if notifications will be displayed on the lock screen. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:380](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L380) + +*** + +### notificationCenter + +> **notificationCenter**: [`IOSNotificationSetting`](../enumerations/IOSNotificationSetting.mdx) + +Enum describing if notifications will be displayed in the notification center. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:394](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L394) + +*** + +### showPreviews + +> **showPreviews**: [`IOSShowPreviewsSetting`](../enumerations/IOSShowPreviewsSetting.mdx) + +Enum describing if notification previews will be shown. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:365](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L365) + +*** + +### sound + +> **sound**: [`IOSNotificationSetting`](../enumerations/IOSNotificationSetting.mdx) + +Enum describing if notifications can trigger a sound. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:370](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L370) diff --git a/docs/react-native/reference/interfaces/InitialNotification.mdx b/docs/react-native/reference/interfaces/InitialNotification.mdx new file mode 100644 index 00000000..0e23c71c --- /dev/null +++ b/docs/react-native/reference/interfaces/InitialNotification.mdx @@ -0,0 +1,65 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / InitialNotification + +# Interface: InitialNotification + +An interface representing a notification & action that launched the current app / or Android activity. + +View the [App open events](/react-native/docs/events#app-open-events) documentation to learn more. + +This interface is returned from [`getInitialNotification`](/react-native/reference/getinitialnotification) when +an initial notification is available. + +Deprecated for iOS in favour of `onForegroundEvent` + +## Platform + +android + +## Properties + +### input? + +> `optional` **input**: `string` + +The input from a notification action. + +The input detail is available when the [`EventType`](/react-native/reference/eventtype) is: + +- [`EventType.ACTION_PRESS`](/react-native/reference/eventtype#action_press) +- The notification quick action has input enabled. View [`AndroidInput`](/react-native/reference/androidinput) for more details. + +#### Platform + +android API Level >= 20 + +#### Defined in + +[packages/react-native/src/types/Notification.ts:118](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L118) + +*** + +### notification + +> **notification**: [`Notification`](Notification.mdx) + +The notification which the user interacted with, which caused the application to open. + +#### Defined in + +[packages/react-native/src/types/Notification.ts:101](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L101) + +*** + +### pressAction + +> **pressAction**: [`NotificationPressAction`](NotificationPressAction.mdx) + +The press action which the user interacted with, on the notification, which caused the application to open. + +#### Defined in + +[packages/react-native/src/types/Notification.ts:106](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L106) diff --git a/docs/react-native/reference/interfaces/IntervalTrigger.mdx b/docs/react-native/reference/interfaces/IntervalTrigger.mdx new file mode 100644 index 00000000..4653ce4d --- /dev/null +++ b/docs/react-native/reference/interfaces/IntervalTrigger.mdx @@ -0,0 +1,55 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / IntervalTrigger + +# Interface: IntervalTrigger + +Interface for building a trigger that repeats at a specified interval. + +View the [Triggers](/react-native/docs/triggers) documentation to learn more. + +## Properties + +### interval + +> **interval**: `number` + +How frequently the notification should be repeated. + +For example, if set to 30, the notification will be displayed every 30 minutes. + +Must be set to a minimum of 15 minutes. + +#### Defined in + +[packages/react-native/src/types/Trigger.ts:102](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Trigger.ts#L102) + +*** + +### timeUnit? + +> `optional` **timeUnit**: [`TimeUnit`](../enumerations/TimeUnit.mdx) + +The unit of time that the `interval` is measured in. + +For example, if set to `TimeUnit.DAYS` and repeat interval is set to 3, the notification will repeat every 3 days. + +Defaults to `TimeUnit.SECONDS` + +#### Defined in + +[packages/react-native/src/types/Trigger.ts:111](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Trigger.ts#L111) + +*** + +### type + +> **type**: [`INTERVAL`](../enumerations/TriggerType.mdx#interval) + +Constant enum value used to identify the trigger type. + +#### Defined in + +[packages/react-native/src/types/Trigger.ts:93](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Trigger.ts#L93) diff --git a/docs/react-native/reference/interfaces/NativeAndroidChannel.mdx b/docs/react-native/reference/interfaces/NativeAndroidChannel.mdx new file mode 100644 index 00000000..c36d5aec --- /dev/null +++ b/docs/react-native/reference/interfaces/NativeAndroidChannel.mdx @@ -0,0 +1,313 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / NativeAndroidChannel + +# Interface: NativeAndroidChannel + +An interface which describes a channel which has been fetched from the device. + +Contains additional information which is only available when fetching the channel from the device. + +## Platform + +android + +## Extends + +- [`AndroidChannel`](AndroidChannel.mdx) + +## Properties + +### badge? + +> `optional` **badge**: `boolean` + +Sets whether badges are enabled for the channel. + +View the [Badges](/react-native/docs/android/appearance#badges) documentation to learn more. + +Defaults to `true`. + +This setting cannot be overridden once the channel is created. + +#### Inherited from + +[`AndroidChannel`](AndroidChannel.mdx).[`badge`](AndroidChannel.mdx#badge) + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:881](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L881) + +*** + +### blocked + +> **blocked**: `boolean` + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1005](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1005) + +*** + +### bypassDnd? + +> `optional` **bypassDnd**: `boolean` + +Sets whether or not notifications posted to this channel can interrupt the user in +'Do Not Disturb' mode. + +Defaults to `false`. + +This setting cannot be overridden once the channel is created. + +#### Platform + +android API Level >= 29 + +#### Inherited from + +[`AndroidChannel`](AndroidChannel.mdx).[`bypassDnd`](AndroidChannel.mdx#bypassdnd) + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:893](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L893) + +*** + +### description? + +> `optional` **description**: `string` + +Sets the user visible description of this channel. + +The recommended maximum length is 300 characters; the value may be truncated if it is too long. + +This setting can be updated after creation. + +#### Platform + +android API Level >= 28 + +#### Inherited from + +[`AndroidChannel`](AndroidChannel.mdx).[`description`](AndroidChannel.mdx#description) + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:904](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L904) + +*** + +### groupId? + +> `optional` **groupId**: `string` + +Sets what group this channel belongs to. Group information is only used for presentation, not for behavior. + +Groups can be created via via [`createChannelGroup`](/react-native/reference/createchannelgroup). + +This setting cannot be overridden once the channel is created. + +#### Inherited from + +[`AndroidChannel`](AndroidChannel.mdx).[`groupId`](AndroidChannel.mdx#groupid) + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:931](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L931) + +*** + +### id + +> **id**: `string` + +The unique channel ID. + +#### Inherited from + +[`AndroidChannel`](AndroidChannel.mdx).[`id`](AndroidChannel.mdx#id) + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:862](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L862) + +*** + +### importance? + +> `optional` **importance**: [`AndroidImportance`](../enumerations/AndroidImportance.mdx) + +Sets the level of interruption of this notification channel. + +Defaults to `AndroidImportance.DEFAULT`. + +This setting can only be set to a lower importance level once set. + +#### Inherited from + +[`AndroidChannel`](AndroidChannel.mdx).[`importance`](AndroidChannel.mdx#importance) + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:940](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L940) + +*** + +### lightColor? + +> `optional` **lightColor**: `string` + +If lights are enabled (via `lights`), sets/overrides the light color for notifications +posted to this channel. + +This setting cannot be overridden once the channel is created. + +#### Inherited from + +[`AndroidChannel`](AndroidChannel.mdx).[`lightColor`](AndroidChannel.mdx#lightcolor) + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:948](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L948) + +*** + +### lights? + +> `optional` **lights**: `boolean` + +Sets whether notifications posted to this channel should display notification lights, on devices that support that feature. + +Defaults to `true`. + +This setting cannot be overridden once the channel is created. + +#### Inherited from + +[`AndroidChannel`](AndroidChannel.mdx).[`lights`](AndroidChannel.mdx#lights) + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:913](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L913) + +*** + +### name + +> **name**: `string` + +The channel name. This is shown to the user so must be descriptive and relate to the notifications +which will be delivered under this channel. + +This setting can be updated after creation. + +#### Inherited from + +[`AndroidChannel`](AndroidChannel.mdx).[`name`](AndroidChannel.mdx#name) + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:870](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L870) + +*** + +### sound? + +> `optional` **sound**: `string` + +Overrides the sound the notification is displayed with. + +The default value is to play no sound. To play the default system sound use 'default'. + +This setting cannot be overridden once the channel is created. + +#### Inherited from + +[`AndroidChannel`](AndroidChannel.mdx).[`sound`](AndroidChannel.mdx#sound) + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:976](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L976) + +*** + +### soundURI? + +> `optional` **soundURI**: `string` + +The URI of the notification sound associated with the channel, if any. + +This is a read-only value, and is under user control after the channel is created + +#### Inherited from + +[`AndroidChannel`](AndroidChannel.mdx).[`soundURI`](AndroidChannel.mdx#sounduri) + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:983](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L983) + +*** + +### vibration? + +> `optional` **vibration**: `boolean` + +Sets whether notification posted to this channel should vibrate. + +Defaults to `true`. + +This setting cannot be overridden once the channel is created. + +#### Inherited from + +[`AndroidChannel`](AndroidChannel.mdx).[`vibration`](AndroidChannel.mdx#vibration) + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:922](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L922) + +*** + +### vibrationPattern? + +> `optional` **vibrationPattern**: `number`[] + +Sets/overrides the vibration pattern for notifications posted to this channel. + +The pattern in milliseconds. Must be an even amount of numbers. + +This setting cannot be overridden once the channel is created. + +#### Inherited from + +[`AndroidChannel`](AndroidChannel.mdx).[`vibrationPattern`](AndroidChannel.mdx#vibrationpattern) + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:967](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L967) + +*** + +### visibility? + +> `optional` **visibility**: [`AndroidVisibility`](../enumerations/AndroidVisibility.mdx) + +Sets whether notifications posted to this channel appear on the lockscreen or not, +and if so, whether they appear in a redacted form. + +Defaults to `AndroidVisibility.PRIVATE`. + +This setting cannot be overridden once the channel is created. + +#### Inherited from + +[`AndroidChannel`](AndroidChannel.mdx).[`visibility`](AndroidChannel.mdx#visibility) + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:958](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L958) diff --git a/docs/react-native/reference/interfaces/NativeAndroidChannelGroup.mdx b/docs/react-native/reference/interfaces/NativeAndroidChannelGroup.mdx new file mode 100644 index 00000000..9ffd5979 --- /dev/null +++ b/docs/react-native/reference/interfaces/NativeAndroidChannelGroup.mdx @@ -0,0 +1,110 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / NativeAndroidChannelGroup + +# Interface: NativeAndroidChannelGroup + +An interface which describes a channel group which has been fetched from the device. + +Contains additional information which is only available when fetching the channel group from the device. + +## Platform + +android API Level >= 26 + +## Extends + +- [`AndroidChannelGroup`](AndroidChannelGroup.mdx) + +## Properties + +### blocked + +> **blocked**: `boolean` + +Returns whether or not notifications posted to a Channel belonging to this group are +blocked by the user. + +On API levels < 28, returns `false`. + +View the [Listening to channel events](/react-native/docs/android/channels#listening-to-channel-events) +documentation to learn more about subscribing to when a channel is blocked by the user. + +#### Platform + +android API Level >= 28 + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1061](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1061) + +*** + +### channels + +> **channels**: [`NativeAndroidChannel`](NativeAndroidChannel.mdx)[] + +Returns a list of channels assigned to this channel group. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1066](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1066) + +*** + +### description? + +> `optional` **description**: `string` + +An optional description of the group. This is visible to the user. + +On Android APIs less than 28 this will always be undefined. + +#### Platform + +android API Level >= 28 + +#### Inherited from + +[`AndroidChannelGroup`](AndroidChannelGroup.mdx).[`description`](AndroidChannelGroup.mdx#description) + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1039](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1039) + +*** + +### id + +> **id**: `string` + +Unique id for this channel group. + +#### Inherited from + +[`AndroidChannelGroup`](AndroidChannelGroup.mdx).[`id`](AndroidChannelGroup.mdx#id) + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1022](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1022) + +*** + +### name + +> **name**: `string` + +The name of the group. This is visible to the user so should be a descriptive name which +categorizes other channels (e.g. reminders). + +The recommended maximum length is 40 characters; the value may be truncated if it is too long. + +#### Inherited from + +[`AndroidChannelGroup`](AndroidChannelGroup.mdx).[`name`](AndroidChannelGroup.mdx#name) + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:1030](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L1030) diff --git a/docs/react-native/reference/interfaces/NativeError.mdx b/docs/react-native/reference/interfaces/NativeError.mdx new file mode 100644 index 00000000..ec47afa5 --- /dev/null +++ b/docs/react-native/reference/interfaces/NativeError.mdx @@ -0,0 +1,93 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / NativeError + +# Interface: NativeError + +An Error that has occurred in native Android or iOS code converted into a JavaScript Error. + +## Extends + +- `Error` + +## Properties + +### code + +> `readonly` **code**: `string` + +Error code, e.g. `invalid-parameter` + +#### Defined in + +[packages/react-native/src/types/Library.ts:12](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Library.ts#L12) + +*** + +### message + +> `readonly` **message**: `string` + +Error message + +#### Overrides + +`Error.message` + +#### Defined in + +[packages/react-native/src/types/Library.ts:17](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Library.ts#L17) + +*** + +### name + +> **name**: `string` + +#### Inherited from + +`Error.name` + +#### Defined in + +node\_modules/typescript/lib/lib.es5.d.ts:1053 + +*** + +### nativeErrorCode + +> `readonly` **nativeErrorCode**: `string` \| `number` + +The native returned error code, different per platform + +#### Defined in + +[packages/react-native/src/types/Library.ts:22](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Library.ts#L22) + +*** + +### nativeErrorMessage + +> `readonly` **nativeErrorMessage**: `string` + +The native returned error message, different per platform + +#### Defined in + +[packages/react-native/src/types/Library.ts:27](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Library.ts#L27) + +*** + +### stack? + +> `optional` **stack**: `string` + +#### Inherited from + +`Error.stack` + +#### Defined in + +node\_modules/typescript/lib/lib.es5.d.ts:1055 diff --git a/docs/react-native/reference/interfaces/Notification.mdx b/docs/react-native/reference/interfaces/Notification.mdx new file mode 100644 index 00000000..c52cfd4b --- /dev/null +++ b/docs/react-native/reference/interfaces/Notification.mdx @@ -0,0 +1,150 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / Notification + +# Interface: Notification + +Interface for building a local notification for both Android & iOS devices. + +To learn more about displaying a notification, view the [Displaying a Notification](/react-native/docs/displaying-a-notification) +documentation. + +## Properties + +### android? + +> `optional` **android**: [`NotificationAndroid`](NotificationAndroid.mdx) + +Android specific notification options. See the [`NotificationAndroid`](/react-native/reference/notificationandroid) +interface for more information and default options which are applied to a notification. + +#### Platform + +android + +#### Defined in + +[packages/react-native/src/types/Notification.ts:62](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L62) + +*** + +### body? + +> `optional` **body**: `string` + +The main body content of a notification. + +#### Defined in + +[packages/react-native/src/types/Notification.ts:46](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L46) + +*** + +### data? + +> `optional` **data**: `object` + +Additional data to store on the notification. + +Data can be used to provide additional context to your notification which can be retrieved +at a later point in time (e.g. via an event). + +#### Index Signature + + \[`key`: `string`\]: `string` \| `number` \| `object` + +#### Defined in + +[packages/react-native/src/types/Notification.ts:54](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L54) + +*** + +### id? + +> `optional` **id**: `string` + +A unique identifier for your notification. + +Notifications with the same ID will be created as the same instance, allowing you to update +a notification which already exists on the device. + +Defaults to a random string if not provided. + +#### Defined in + +[packages/react-native/src/types/Notification.ts:31](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L31) + +*** + +### ios? + +> `optional` **ios**: [`NotificationIOS`](NotificationIOS.mdx) + +iOS specific notification options. See the [`NotificationIOS`](/react-native/reference/notificationios) +interface for more information and default options which are applied to a notification. + +#### Platform + +ios + +#### Defined in + +[packages/react-native/src/types/Notification.ts:70](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L70) + +*** + +### remote? + +> `readonly` `optional` **remote**: `object` + +Will be populated if it's a remote notification + +#### contentAvailable? + +> `optional` **contentAvailable**: `number` + +#### messageId + +> **messageId**: `string` + +#### mutableContent? + +> `optional` **mutableContent**: `number` + +#### senderId + +> **senderId**: `string` + +#### Platform + +ios + +#### Defined in + +[packages/react-native/src/types/Notification.ts:77](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L77) + +*** + +### subtitle? + +> `optional` **subtitle**: `string` + +The notification subtitle, which appears on a new line below/next the title. + +#### Defined in + +[packages/react-native/src/types/Notification.ts:41](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L41) + +*** + +### title? + +> `optional` **title**: `string` + +The notification title which appears above the body text. + +#### Defined in + +[packages/react-native/src/types/Notification.ts:36](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L36) diff --git a/docs/react-native/reference/interfaces/NotificationAndroid.mdx b/docs/react-native/reference/interfaces/NotificationAndroid.mdx new file mode 100644 index 00000000..37f3e0ca --- /dev/null +++ b/docs/react-native/reference/interfaces/NotificationAndroid.mdx @@ -0,0 +1,746 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / NotificationAndroid + +# Interface: NotificationAndroid + +The interface for Android specific options which are applied to a notification. + +To learn more about Android notifications, view the [Android](/react-native/docs/android/introduction) +documentation for full examples and usage. + +## Platform + +android + +## Properties + +### actions? + +> `optional` **actions**: [`AndroidAction`](AndroidAction.mdx)[] + +An array of [AndroidAction](/react-native/reference/androidaction) interfaces. + +Adds quick actions to a notification. Quick Actions enable users to interact with your application +directly from the notification body, providing an overall greater user experience. + +View the [Quick Actions](/react-native/docs/android/interaction#quick-actions) documentation for more information. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:24](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L24) + +*** + +### asForegroundService? + +> `optional` **asForegroundService**: `boolean` + +When set to `true` this notification will be shown as a foreground service. + +The application can only display one foreground service notification at once. If a +foreground service notification is already running and a new notification with this flag set to +`true` is provided, the service will stop the existing service and start a new one. + +Ensure a foreground service runner function has been provided to `registerForegroundService`. +Without one, the notification will not be displayed. + +View the [Foreground Service](/react-native/docs/android/foreground-service) documentation for more information. + +Defaults to `false`. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:40](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L40) + +*** + +### autoCancel? + +> `optional` **autoCancel**: `boolean` + +Setting this flag will make it so the notification is automatically canceled when the user +presses it in the panel. + +By default when the user taps a notification it is automatically removed from the notification +panel. Setting this to `false` will keep the notification in the panel. + +If `false`, the notification will persist in the notification panel after being pressed. It will +remain there until the user removes it (e.g. swipes away) or is cancelled via +[`cancelNotification`](/react-native/reference/cancelNotification). + +Defaults to `true`. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:62](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L62) + +*** + +### badgeCount? + +> `optional` **badgeCount**: `number` + +Overrides the current number of active notifications shown on the device. + +If no number is provided, the system displays the current number of active notifications. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:69](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L69) + +*** + +### badgeIconType? + +> `optional` **badgeIconType**: [`AndroidBadgeIconType`](../enumerations/AndroidBadgeIconType.mdx) + +Sets the type of badge used when the notification is being displayed in badge mode. + +View the [Badges](/react-native/docs/android/appearance#badges) documentation for more information +and usage examples. + +Defaults to `AndroidBadgeIconType.LARGE`. + +#### Platform + +android API Level >= 26 + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:81](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L81) + +*** + +### category? + +> `optional` **category**: [`AndroidCategory`](../enumerations/AndroidCategory.mdx) + +Assigns the notification to a category. Use the one which best describes the notification. + +The category may be used by the device for ranking and filtering. It has no visual or behavioural +impact. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:89](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L89) + +*** + +### channelId? + +> `optional` **channelId**: `string` + +Specifies the `AndroidChannel` which the notification will be delivered on. + +On Android 8.0 (API 26) the channel ID is required. Providing a invalid channel ID will throw +an error. View the [Channels & Groups](/react-native/docs/android/channels) documentation for +more information and usage examples. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:98](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L98) + +*** + +### chronometerDirection? + +> `optional` **chronometerDirection**: `"up"` \| `"down"` + +If `showChronometer` is `true`, the direction of the chronometer can be changed to count down instead of up. + +Has no effect if `showChronometer` is `false`. + +Defaults to `up`. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:131](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L131) + +*** + +### circularLargeIcon? + +> `optional` **circularLargeIcon**: `boolean` + +Whether the large icon should be circular. + +If `true`, the large icon will be rounded in the shape of a circle. + +Defaults to `false`. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:205](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L205) + +*** + +### color? + +> `optional` **color**: `string` + +Set an custom accent color for the notification. If not provided, the default notification +system color will be used. + +The color can be a predefined system `AndroidColor` or [hexadecimal](https://gist.github.com/lopspower/03fb1cc0ac9f32ef38f4). + +View the [Color](/react-native/docs/android/appearance#color) documentation for more information. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:108](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L108) + +*** + +### colorized? + +> `optional` **colorized**: `boolean` + +When `asForegroundService` is `true`, the notification will use the provided `color` property +to set a background color on the notification. This property has no effect when `asForegroundService` +is `false`. + +This should only be used for high priority ongoing tasks like navigation, an ongoing call, +or other similarly high-priority events for the user. + +View the [Foreground Service](/react-native/docs/android/foreground-service) documentation for more information. + +Defaults to `false`. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:122](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L122) + +*** + +### defaults? + +> `optional` **defaults**: [`AndroidDefaults`](../enumerations/AndroidDefaults.mdx)[] + +For devices without notification channel support, this property sets the default behaviour +for a notification. + +On API Level >= 26, this has no effect. + +See [AndroidDefaults](/react-native/reference/androiddefaults) for more information. + +#### Platform + +android API Level < 26 + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:143](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L143) + +*** + +### flags? + +> `optional` **flags**: [`AndroidFlags`](../enumerations/AndroidFlags.mdx)[] + +Set any additional flags + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:251](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L251) + +*** + +### foregroundServiceTypes? + +> `optional` **foregroundServiceTypes**: [`AndroidForegroundServiceType`](../enumerations/AndroidForegroundServiceType.mdx)[] + +Set the foreground service types identifying the work done by the service + +View the [Foreground service types](https://developer.android.com/develop/background-work/services/fg-service-types) documentation to learn +more. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:289](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L289) + +*** + +### fullScreenAction? + +> `optional` **fullScreenAction**: [`NotificationFullScreenAction`](NotificationFullScreenAction.mdx) + +The `fullScreenAction` property allows you to show a custom UI +in full screen when the notification is displayed. + +View the [FullScreenAction](/react-native/docs/android/behaviour#full-screen) documentation to learn +more. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:281](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L281) + +*** + +### groupAlertBehavior? + +> `optional` **groupAlertBehavior**: [`AndroidGroupAlertBehavior`](../enumerations/AndroidGroupAlertBehavior.mdx) + +Sets the group alert behavior for this notification. Use this method to mute this notification +if alerts for this notification's group should be handled by a different notification. This is +only applicable for notifications that belong to a `groupId`. This must be called on all notifications +you want to mute. For example, if you want only the summary of your group to make noise, all +children in the group should have the group alert behavior `AndroidGroupAlertBehavior.SUMMARY`. + +View the [Android Grouping & Sorting guide](/react-native/docs/android/grouping-and-sorting#group-behaviour) +documentation to learn more. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:166](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L166) + +*** + +### groupId? + +> `optional` **groupId**: `string` + +Set this notification to be part of a group of notifications sharing the same key. Grouped notifications may +display in a cluster or stack on devices which support such rendering. + +On some devices, the system may automatically group notifications. + +View the [Android Grouping & Sorting guide](/react-native/docs/android/grouping-and-sorting) documentation to +learn more. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:154](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L154) + +*** + +### groupSummary? + +> `optional` **groupSummary**: `boolean` + +Whether this notification should be a group summary. + +If `true`, Set this notification to be the group summary for a group of notifications. Grouped notifications may display in +a cluster or stack on devices which support such rendering. Requires a `groupId` key to be set. + +Defaults to `false`. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:176](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L176) + +*** + +### importance? + +> `optional` **importance**: [`AndroidImportance`](../enumerations/AndroidImportance.mdx) + +Set a notification importance for devices without channel support. + +Devices using Android API Level < 26 have no channel support, meaning incoming notifications +won't be assigned an importance level from the channel. If your application supports devices +without channel support, set this property to directly assign an importance level to the incoming +notification. + +Defaults to `AndroidImportance.DEFAULT`. + +View the [Appearance](/react-native/docs/android/appearance#importance) documentation to learn +more. + +#### Platform + +android API Level < 26 + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:306](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L306) + +*** + +### inputHistory? + +> `optional` **inputHistory**: `string`[] + +The local user input history for this notification. + +Input history is shown on supported devices below the main notification body. History of the +users input with the notification should be shown when receiving action input by updating +the existing notification. It is recommended to clear the history when it is no longer +relevant (e.g. someone has responded to the users input). + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:186](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L186) + +*** + +### largeIcon? + +> `optional` **largeIcon**: `string` \| `number` \| `object` + +A local file path using the 'require()' method or a remote http to the picture to display. + +Sets a large icon on the notification. + +View the [Android Appearance](/react-native/docs/android/appearance#large-icons) documentation to learn +more about this property. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:196](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L196) + +*** + +### lights? + +> `optional` **lights**: [`string`, `number`, `number`] + +Sets the color and frequency of the light pattern. This only has effect on supported devices. + +The option takes an array containing a hexadecimal color value or predefined `AndroidColor`, +along with the number of milliseconds to show the light, and the number of milliseconds to +turn off the light. The light frequency pattern is repeated. + +View the [Lights](/react-native/docs/android/behaviour#lights) documentation for more information. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:216](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L216) + +*** + +### lightUpScreen? + +> `optional` **lightUpScreen**: `boolean` + +When set to `true` the screen will light up when the notification is displayed. + +Defaults to `false`. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:47](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L47) + +*** + +### localOnly? + +> `optional` **localOnly**: `boolean` + +Sets whether the notification will only appear on the local device. + +Users who have connected devices which support notifications (such as a smart watch) will +receive an alert for the notification on that device. If set to `true`, the notification will +only alert on the main device. + +Defaults to `false`. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:227](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L227) + +*** + +### loopSound? + +> `optional` **loopSound**: `boolean` + +Set whether the sound should loop, by default, the sound will only play once. + +This property is useful if you have an ongoing notification. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:246](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L246) + +*** + +### ongoing? + +> `optional` **ongoing**: `boolean` + +Set whether this is an on-going notification. + +Setting this value to `true` changes the default behaviour of a notification: + +- Ongoing notifications are sorted above the regular notifications in the notification panel. +- Ongoing notifications do not have an 'X' close button, and are not affected by the "Clear all" button. + +View the [Ongoing](/react-native/docs/android/behaviour#ongoing) documentation for more information. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:239](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L239) + +*** + +### onlyAlertOnce? + +> `optional` **onlyAlertOnce**: `boolean` + +Notifications with the same `id` will only show a single instance at any one time on your device, +however will still alert the user (for example, by making a sound). + +If this flag is set to `true`, notifications with the same `id` will only alert the user once whilst +the notification is visible. + +This property is commonly used when frequently updating a notification (such as updating the progress bar). + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:262](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L262) + +*** + +### pressAction? + +> `optional` **pressAction**: [`NotificationPressAction`](NotificationPressAction.mdx) + +By default notifications have no behaviour when a user presses them. The +`pressAction` property allows you to set what happens when a user presses +the notification. + +View the [Interaction](/react-native/docs/android/interaction) documentation to learn +more. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:272](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L272) + +*** + +### progress? + +> `optional` **progress**: [`AndroidProgress`](AndroidProgress.mdx) + +A notification can show current progress of a task. The progress state can either be fixed or +indeterminate (unknown). + +View the [Progress Indicators](/react-native/docs/android/progress-indicators) documentation +to learn more. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:315](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L315) + +*** + +### showChronometer? + +> `optional` **showChronometer**: `boolean` + +Shows a counting timer on the notification, useful for on-going notifications such as a phone call. + +If no `timestamp` is provided, a counter will display on the notification starting from 00:00. If a `timestamp` is +provided, the number of hours/minutes/seconds since that have elapsed since that value will be shown instead. + +Defaults to `false`. + +View the [Timers](/react-native/docs/android/timers#timers) documentation to learn more. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:390](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L390) + +*** + +### showTimestamp? + +> `optional` **showTimestamp**: `boolean` + +Sets whether the `timestamp` provided is shown in the notification. + +Setting this field is useful for notifications which are more informative with a timestamp, +such as an E-Mail. + +If no `timestamp` is set, this field has no effect. + +View the [Timestamps](/react-native/docs/android/timers#timestamps) documentation to learn more. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:327](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L327) + +*** + +### smallIcon? + +> `optional` **smallIcon**: `string` + +The small icon to show in the heads-up notification. + +View the [Icons](/react-native/docs/android/appearance#small-icons) documentation to learn +more. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:335](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L335) + +*** + +### smallIconLevel? + +> `optional` **smallIconLevel**: `number` + +An additional level parameter for when the icon is an instance of a Android `LevelListDrawable`. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:340](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L340) + +*** + +### sortKey? + +> `optional` **sortKey**: `string` + +Set a sort key that orders this notification among other notifications from the same package. +This can be useful if an external sort was already applied and an app would like to preserve +this. Notifications will be sorted lexicographically using this value, although providing +different priorities in addition to providing sort key may cause this value to be ignored. + +If a `groupId` has been set, the sort key can also be used to order members of a notification group. + +View the [Android Grouping & Sorting](/react-native/docs/android/grouping-and-sorting#sorting) +documentation to learn more. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:353](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L353) + +*** + +### sound? + +> `optional` **sound**: `string` + +Overrides the sound the notification is displayed with. + +The default value is to play no sound. To play the default system sound use 'default'. + +This setting has no behaviour on Android after API level version 26, instead you can set the +sound on the notification channels. + +View the [Sound](/react-native/docs/android/behaviour#sound) documentation for more information. + +#### Platform + +android API Level < 26 + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:442](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L442) + +*** + +### style? + +> `optional` **style**: [`AndroidBigPictureStyle`](AndroidBigPictureStyle.mdx) \| [`AndroidBigTextStyle`](AndroidBigTextStyle.mdx) \| [`AndroidInboxStyle`](AndroidInboxStyle.mdx) \| [`AndroidMessagingStyle`](AndroidMessagingStyle.mdx) + +Styled notifications provide users with more informative content and additional functionality. + +Android supports different styles, however only one can be used with a notification. + +View the [Styles](/react-native/docs/android/styles) documentation to learn more +view usage examples. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:363](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L363) + +*** + +### tag? + +> `optional` **tag**: `string` + +Sets a tag on the notification. + +Tags can be used to query groups notifications by the tag value. Setting a tag has no +impact on the notification itself. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:416](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L416) + +*** + +### ticker? + +> `optional` **ticker**: `string` + +Text that summarizes this notification for accessibility services. As of the Android L release, this +text is no longer shown on screen, but it is still useful to accessibility services +(where it serves as an audible announcement of the notification's appearance). + +Ticker text does not show in the notification. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:372](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L372) + +*** + +### timeoutAfter? + +> `optional` **timeoutAfter**: `number` + +Sets the time in milliseconds at which the notification should be +automatically cancelled once displayed, if it is not already cancelled. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:378](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L378) + +*** + +### timestamp? + +> `optional` **timestamp**: `number` + +The timestamp in milliseconds for this notification. Notifications in the panel are sorted by this time. + +The timestamp can be used with other properties to change the behaviour of a notification: + +- Use with `showTimestamp` to show the timestamp to the users. +- Use with `showChronometer` to create a on-going timer. + +View the [Timers](/react-native/docs/android/timers) documentation to learn more. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:428](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L428) + +*** + +### vibrationPattern? + +> `optional` **vibrationPattern**: `number`[] + +Sets the vibration pattern the notification uses when displayed. Must be an even amount of numbers. + +View the [Vibration](/react-native/docs/android/behaviour#vibration) documentation to learn more. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:397](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L397) + +*** + +### visibility? + +> `optional` **visibility**: [`AndroidVisibility`](../enumerations/AndroidVisibility.mdx) + +Sets the visibility for this notification. This may be used for apps which show user +sensitive information (e.g. a banking app). + +Defaults to `AndroidVisibility.PRIVATE`. + +View the [Visibility](/react-native/docs/android/appearance#visibility) documentation to learn +more. + +#### Defined in + +[packages/react-native/src/types/NotificationAndroid.ts:408](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationAndroid.ts#L408) diff --git a/docs/react-native/reference/interfaces/NotificationFullScreenAction.mdx b/docs/react-native/reference/interfaces/NotificationFullScreenAction.mdx new file mode 100644 index 00000000..4e670211 --- /dev/null +++ b/docs/react-native/reference/interfaces/NotificationFullScreenAction.mdx @@ -0,0 +1,96 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / NotificationFullScreenAction + +# Interface: NotificationFullScreenAction + +The interface used to describe a full-screen action for a notification. + +By setting a `fullScreenAction`, when the notification is displayed, it will launch a full-screen intent. + +On Android; when provided to a notification action, the action will only open you application if +a `launchActivity` and/or a `mainComponent` is provided. + +Requires the following permission to be added to your `AndroidManifest.xml`: +```xml + +``` + +Please see the [FullScreen Action](/react-native/docs/android/behaviour#full-screen) document to learn more. + +## Properties + +### id + +> **id**: `string` + +The unique ID for the action. + +The `id` property is used to differentiate between full-screen actions. When listening to notification +events, the ID can be read from the `event.detail.notification.android.fullScreenAction` object. + +#### Defined in + +[packages/react-native/src/types/Notification.ts:268](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L268) + +*** + +### launchActivity? + +> `optional` **launchActivity**: `string` + +The custom Android Activity to launch on a full-screen action. + +This property can be used in advanced scenarios to launch a custom Android Activity when the user +performs a full-screen action. + +View the [Android Full Screen](/react-native/docs/android/behaviour#full-screen) docs to learn more. + +#### Platform + +android + +#### Defined in + +[packages/react-native/src/types/Notification.ts:280](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L280) + +*** + +### launchActivityFlags? + +> `optional` **launchActivityFlags**: [`AndroidLaunchActivityFlag`](../enumerations/AndroidLaunchActivityFlag.mdx)[] + +Custom flags that are added to the Android [Intent](https://developer.android.com/reference/android/content/Intent.html) that launches your Activity. + +These are only required if you need to customise the behaviour of how your activities are launched; by default these are not required. + +#### Platform + +android + +#### Defined in + +[packages/react-native/src/types/Notification.ts:289](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L289) + +*** + +### mainComponent? + +> `optional` **mainComponent**: `string` + +A custom registered React component to launch on press action. + +This property can be used to open a custom React component when the notification is displayed. +For this to correctly function on Android, a minor native code change is required. + +View the [Full-screen Action](/react-native/docs/android/behaviour#full-screen) document to learn more. + +#### Platform + +android + +#### Defined in + +[packages/react-native/src/types/Notification.ts:301](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L301) diff --git a/docs/react-native/reference/interfaces/NotificationIOS.mdx b/docs/react-native/reference/interfaces/NotificationIOS.mdx new file mode 100644 index 00000000..46f9e8f0 --- /dev/null +++ b/docs/react-native/reference/interfaces/NotificationIOS.mdx @@ -0,0 +1,240 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / NotificationIOS + +# Interface: NotificationIOS + +The interface for iOS specific options which are applied to a notification. + +To learn more about iOS notifications, view the [iOS](/react-native/docs/iOS/introduction) +documentation for full examples and usage. + +## Platform + +ios + +## Properties + +### attachments? + +> `optional` **attachments**: [`IOSNotificationAttachment`](IOSNotificationAttachment.mdx)[] + +Optional array of [IOSNotificationAttachment](/react-native/reference/iosnotificationattachment) interfaces. + +Attachments allow audio, image, or video content to be displayed with the notification, enriching the user's experience. + +View the [Attachments](/react-native/docs/ios/appearances#attachments) documentation for more information +and usage examples. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:23](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L23) + +*** + +### badgeCount? + +> `optional` **badgeCount**: `null` \| `number` + +The application badge count number. Set to null to indicate no change, or 0 to hide. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:28](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L28) + +*** + +### categoryId? + +> `optional` **categoryId**: `string` + +The id of a registered `IOSCategory` (via the `setNotificationCategories` API) that will be used to determine the +appropriate actions to display for the notification. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:34](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L34) + +*** + +### communicationInfo? + +> `optional` **communicationInfo**: [`IOSCommunicationInfo`](IOSCommunicationInfo.mdx) + +Optional property for communication notifications + +#### Platform + +ios iOS >= 15 + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:125](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L125) + +*** + +### critical? + +> `optional` **critical**: `boolean` + +If the notification is a critical alert set this property to true; critical alerts will bypass +the mute switch and also bypass Do Not Disturb. + +#### Platform + +ios iOS >= 12 + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:64](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L64) + +*** + +### criticalVolume? + +> `optional` **criticalVolume**: `number` + +The optional audio volume of the critical sound; a float value between 0.0 and 1.0. + +This property is not used unless the `critical: true` option is also set. + +#### Platform + +ios iOS >= 12 + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:73](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L73) + +*** + +### foregroundPresentationOptions? + +> `optional` **foregroundPresentationOptions**: [`IOSForegroundPresentationOptions`](IOSForegroundPresentationOptions.mdx) + +Optional property to customise how notifications are presented when the app is in the foreground. + +By default, Notifee will show iOS notifications in heads-up mode if your app is currently in the foreground. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:118](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L118) + +*** + +### interruptionLevel? + +> `optional` **interruptionLevel**: [`IOSNotificationInterruptionLevel`](../type-aliases/IOSNotificationInterruptionLevel.mdx) + +Value that indicate the importance and delivery timing of a notification. + +#### Platform + +ios iOS >= 15 + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:56](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L56) + +*** + +### launchImageName? + +> `optional` **launchImageName**: `string` + +The launch image that will be used when the app is opened from this notification. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:39](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L39) + +*** + +### sound? + +> `optional` **sound**: `string` + +The name of the sound file to be played. The sound must be in the Library/Sounds folder of the +app's data container or the Library/Sounds folder of an app group data container. + +If the file is not found in a container, the system will look in the app's bundle. + +Use 'default' to use the default system sound. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:49](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L49) + +*** + +### summaryArgument? + +> `optional` **summaryArgument**: `string` + +The argument that is inserted in the IOSCategory.summaryFormat for this notification. + +See `IOSCategory.summaryFormat`. + +#### Platform + +ios iOS >= 12 + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:88](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L88) + +*** + +### summaryArgumentCount? + +> `optional` **summaryArgumentCount**: `number` + +A number that indicates how many items in the summary are being represented. + +For example if a messages app sends one notification for 3 new messages in a group chat, +the summaryArgument could be the name of the group chat and the summaryArgumentCount should be 3. + +If set, value cannot be 0 or less. + +See `IOSCategory.summaryFormat`. + +#### Platform + +ios iOS >= 12 + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:102](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L102) + +*** + +### targetContentId? + +> `optional` **targetContentId**: `string` + +The identifier for the window to be opened when the user taps a notification. + +This value determines the window brought forward when the user taps this notification on iPadOS. + +#### Platform + +ios iOS >= 13 + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:111](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L111) + +*** + +### threadId? + +> `optional` **threadId**: `string` + +A unique id for the thread or conversation related to this notification. +This will be used to visually group notifications together. + +#### Defined in + +[packages/react-native/src/types/NotificationIOS.ts:79](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L79) diff --git a/docs/react-native/reference/interfaces/NotificationPressAction.mdx b/docs/react-native/reference/interfaces/NotificationPressAction.mdx new file mode 100644 index 00000000..d85a66b7 --- /dev/null +++ b/docs/react-native/reference/interfaces/NotificationPressAction.mdx @@ -0,0 +1,91 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / NotificationPressAction + +# Interface: NotificationPressAction + +The interface used to describe a press action for a notification. + +There are various ways a user can interact with a notification, the most common being pressing +the notification, pressing an action or providing text input. This interface defines what happens +when a user performs such interaction. + +On Android; when provided to a notification action, the action will only open you application if +a `launchActivity` and/or a `mainComponent` is provided. + +## Properties + +### id + +> **id**: `string` + +The unique ID for the action. + +The `id` property is used to differentiate between user press actions. When listening to notification +events, the ID can be read from the `event.detail.pressAction` object. + +#### Defined in + +[packages/react-native/src/types/Notification.ts:210](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L210) + +*** + +### launchActivity? + +> `optional` **launchActivity**: `string` + +The custom Android Activity to launch on a press action. + +This property can be used in advanced scenarios to launch a custom Android Activity when the user +performs a press action. + +View the [Android Interaction](/react-native/docs/android/interaction) docs to learn more. + +#### Platform + +android + +#### Defined in + +[packages/react-native/src/types/Notification.ts:222](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L222) + +*** + +### launchActivityFlags? + +> `optional` **launchActivityFlags**: [`AndroidLaunchActivityFlag`](../enumerations/AndroidLaunchActivityFlag.mdx)[] + +Custom flags that are added to the Android [Intent](https://developer.android.com/reference/android/content/Intent.html) that launches your Activity. + +These are only required if you need to customise the behaviour of how your activities are launched; by default these are not required. + +#### Platform + +android + +#### Defined in + +[packages/react-native/src/types/Notification.ts:231](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L231) + +*** + +### mainComponent? + +> `optional` **mainComponent**: `string` + +A custom registered React component to launch on press action. + +This property can be used to open a custom React component when the user performs a press action. +For this to correctly function on Android, a minor native code change is required. + +View the [Press Action](/react-native/docs/android/interaction#press-action) document to learn more. + +#### Platform + +android + +#### Defined in + +[packages/react-native/src/types/Notification.ts:243](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L243) diff --git a/docs/react-native/reference/interfaces/NotificationSettings.mdx b/docs/react-native/reference/interfaces/NotificationSettings.mdx new file mode 100644 index 00000000..42ff0b85 --- /dev/null +++ b/docs/react-native/reference/interfaces/NotificationSettings.mdx @@ -0,0 +1,59 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / NotificationSettings + +# Interface: NotificationSettings + +## Properties + +### android + +> **android**: [`AndroidNotificationSettings`](AndroidNotificationSettings.mdx) + +Overall notification settings for the application in android. +On non-Android platforms, this will be populated with default values + +#### Defined in + +[packages/react-native/src/types/Notification.ts:512](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L512) + +*** + +### authorizationStatus + +> **authorizationStatus**: [`AuthorizationStatus`](../enumerations/AuthorizationStatus.mdx) + +Overall notification authorization status for the application. +On Android, `authorizationStatus` will return only either `AuthorizationStatus.DENIED` or `AuthorizationStatus.AUTHORIZED`. + +#### Defined in + +[packages/react-native/src/types/Notification.ts:502](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L502) + +*** + +### ios + +> **ios**: [`IOSNotificationSettings`](IOSNotificationSettings.mdx) + +Overall notification settings for the application in iOS. +On non-iOS platforms, this will be populated with default values + +#### Defined in + +[packages/react-native/src/types/Notification.ts:507](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L507) + +*** + +### web + +> **web**: `WebNotificationSettings` + +Overall notification settings for the application in web. +On non-Web platforms, this will be populated with default values + +#### Defined in + +[packages/react-native/src/types/Notification.ts:517](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L517) diff --git a/docs/react-native/reference/interfaces/TimestampTrigger.mdx b/docs/react-native/reference/interfaces/TimestampTrigger.mdx new file mode 100644 index 00000000..4ecc4fcb --- /dev/null +++ b/docs/react-native/reference/interfaces/TimestampTrigger.mdx @@ -0,0 +1,71 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / TimestampTrigger + +# Interface: TimestampTrigger + +Interface for building a trigger with a timestamp. + +View the [Triggers](/react-native/docs/triggers) documentation to learn more. + +## Properties + +### alarmManager? + +> `optional` **alarmManager**: `boolean` \| [`TimestampTriggerAlarmManager`](TimestampTriggerAlarmManager.mdx) + +Choose to schedule your trigger notification with Android's AlarmManager API. + +By default, trigger notifications are created with Android's WorkManager API. + +#### Platform + +android + +#### Defined in + +[packages/react-native/src/types/Trigger.ts:34](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Trigger.ts#L34) + +*** + +### repeatFrequency? + +> `optional` **repeatFrequency**: [`RepeatFrequency`](../enumerations/RepeatFrequency.mdx) + +The frequency at which the trigger repeats. +If unset, the notification will only be displayed once. + +For example: + if set to `RepeatFrequency.HOURLY`, the notification will repeat every hour from the timestamp specified. + if set to `RepeatFrequency.DAILY`, the notification will repeat every day from the timestamp specified. + if set to `RepeatFrequency.WEEKLY`, the notification will repeat every week from the timestamp specified. + +#### Defined in + +[packages/react-native/src/types/Trigger.ts:25](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Trigger.ts#L25) + +*** + +### timestamp + +> **timestamp**: `number` + +The timestamp when the notification should first be shown, in milliseconds since 1970. + +#### Defined in + +[packages/react-native/src/types/Trigger.ts:14](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Trigger.ts#L14) + +*** + +### type + +> **type**: [`TIMESTAMP`](../enumerations/TriggerType.mdx#timestamp) + +Constant enum value used to identify the trigger type. + +#### Defined in + +[packages/react-native/src/types/Trigger.ts:10](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Trigger.ts#L10) diff --git a/docs/react-native/reference/interfaces/TimestampTriggerAlarmManager.mdx b/docs/react-native/reference/interfaces/TimestampTriggerAlarmManager.mdx new file mode 100644 index 00000000..a894b221 --- /dev/null +++ b/docs/react-native/reference/interfaces/TimestampTriggerAlarmManager.mdx @@ -0,0 +1,46 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / TimestampTriggerAlarmManager + +# Interface: TimestampTriggerAlarmManager + +Interface to specify additional options for the AlarmManager which can be used with `TimestampTrigger.alarmManager`. + +View the [Triggers](/react-native/docs/triggers) documentation to learn more. + +## Platform + +android + +## Properties + +### ~~allowWhileIdle?~~ + +> `optional` **allowWhileIdle**: `boolean` + +#### Deprecated + +use `type` instead +----- + +Sets whether your trigger notification should be displayed even when the system is in low-power idle modes. + +Defaults to `false`. + +#### Defined in + +[packages/react-native/src/types/Trigger.ts:66](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Trigger.ts#L66) + +*** + +### type? + +> `optional` **type**: [`AlarmType`](../enumerations/AlarmType.mdx) + +The type of alarm set by alarm manager of android + +#### Defined in + +[packages/react-native/src/types/Trigger.ts:69](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Trigger.ts#L69) diff --git a/docs/react-native/reference/interfaces/TriggerNotification.mdx b/docs/react-native/reference/interfaces/TriggerNotification.mdx new file mode 100644 index 00000000..edc4e725 --- /dev/null +++ b/docs/react-native/reference/interfaces/TriggerNotification.mdx @@ -0,0 +1,33 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / TriggerNotification + +# Interface: TriggerNotification + +An interface representing a notification that is pending. + +## Properties + +### notification + +> **notification**: [`Notification`](Notification.mdx) + +The notification + +#### Defined in + +[packages/react-native/src/types/Notification.ts:155](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L155) + +*** + +### trigger + +> **trigger**: [`Trigger`](../type-aliases/Trigger.mdx) + +The trigger that is used to schedule the notification + +#### Defined in + +[packages/react-native/src/types/Notification.ts:160](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L160) diff --git a/docs/react-native/reference/type-aliases/ForegroundServiceTask.mdx b/docs/react-native/reference/type-aliases/ForegroundServiceTask.mdx new file mode 100644 index 00000000..d4d7158c --- /dev/null +++ b/docs/react-native/reference/type-aliases/ForegroundServiceTask.mdx @@ -0,0 +1,34 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / ForegroundServiceTask + +# Type Alias: ForegroundServiceTask() + +> **ForegroundServiceTask**: (`notification`) => `Promise`\<`void`\> + +A representation of a Foreground Service task registered via [`registerForegroundService`](/react-native/reference/registerforegroundservice). + +The task must resolve a promise once complete, and in turn removes the notification. + +View the [Foreground Service](/react-native/docs/android/foreground-service) documentation to +learn more. + +## Parameters + +### notification + +[`Notification`](../interfaces/Notification.mdx) + +## Returns + +`Promise`\<`void`\> + +## Platform + +android + +## Defined in + +[packages/react-native/src/types/Notification.ts:191](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Notification.ts#L191) diff --git a/docs/react-native/reference/type-aliases/IOSNotificationInterruptionLevel.mdx b/docs/react-native/reference/type-aliases/IOSNotificationInterruptionLevel.mdx new file mode 100644 index 00000000..1f2c8e3c --- /dev/null +++ b/docs/react-native/reference/type-aliases/IOSNotificationInterruptionLevel.mdx @@ -0,0 +1,20 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / IOSNotificationInterruptionLevel + +# Type Alias: IOSNotificationInterruptionLevel + +> **IOSNotificationInterruptionLevel**: `"active"` \| `"critical"` \| `"passive"` \| `"timeSensitive"` + +Constants that indicate the importance and delivery timing of a notification. +https://developer.apple.com/documentation/usernotifications/unnotificationinterruptionlevel + +## Platform + +ios + +## Defined in + +[packages/react-native/src/types/NotificationIOS.ts:683](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/NotificationIOS.ts#L683) diff --git a/docs/react-native/reference/type-aliases/Trigger.mdx b/docs/react-native/reference/type-aliases/Trigger.mdx new file mode 100644 index 00000000..444ca95c --- /dev/null +++ b/docs/react-native/reference/type-aliases/Trigger.mdx @@ -0,0 +1,13 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / Trigger + +# Type Alias: Trigger + +> **Trigger**: [`TimestampTrigger`](../interfaces/TimestampTrigger.mdx) \| [`IntervalTrigger`](../interfaces/IntervalTrigger.mdx) + +## Defined in + +[packages/react-native/src/types/Trigger.ts:136](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/types/Trigger.ts#L136) diff --git a/docs/react-native/reference/variables/default.mdx b/docs/react-native/reference/variables/default.mdx new file mode 100644 index 00000000..22c9026c --- /dev/null +++ b/docs/react-native/reference/variables/default.mdx @@ -0,0 +1,13 @@ +[**@notifee/react-native**](../README.mdx) + +*** + +[@notifee/react-native](../globals.mdx) / default + +# Variable: default + +> `const` **default**: `ModuleWithStatics` + +## Defined in + +[packages/react-native/src/index.ts:26](https://github.com/invertase/notifee/blob/bf6deb3c72c777c677e21f5eda602131249f4f83/packages/react-native/src/index.ts#L26) diff --git a/package.json b/package.json index 16d2d152..86f124b9 100644 --- a/package.json +++ b/package.json @@ -36,7 +36,7 @@ "lerna:bootstrap": "lerna bootstrap", "lerna:link": "lerna link && lerna exec -- yarn link", "lerna:clean": "lerna clean", - "gen:reference": "rimraf docs/typedoc.json docs/typedoc.min.json && node scripts/generate-typedoc.js", + "gen:reference": "rimraf docs/react-native/reference && yarn typedoc", "test:all": "yarn test:core:android && yarn tests_rn:test && yarn tests_rn:android:test && yarn tests_rn:ios:test", "test:core:android": "cd android && ./gradlew testDebugUnit", "tests_rn:packager": "cd tests_react_native && npx react-native start", @@ -75,7 +75,8 @@ "prettier": "^2.5.1", "rimraf": "^3.0.2", "semantic-release": "^24.2.0", - "typedoc": "^0.19.2", + "typedoc": "^0.27.5", + "typedoc-plugin-markdown": "^4.3.3", "typescript": "^4.6.2" }, "resolutions": { diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 00000000..b0cacd4f --- /dev/null +++ b/typedoc.json @@ -0,0 +1,8 @@ +{ + "$schema": "https://typedoc-plugin-markdown.org/schema.json", + "entryPoints": ["./packages/react-native/src/index.ts"], + "plugin": ["typedoc-plugin-markdown"], + "out": "./docs/react-native/reference", + "fileExtension": ".mdx" + +} \ No newline at end of file diff --git a/yarn.lock b/yarn.lock index bcce5415..e3d21377 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1280,6 +1280,15 @@ resolved "https://registry.yarnpkg.com/@gar/promisify/-/promisify-1.1.3.tgz#555193ab2e3bb3b6adc3d551c9c030d9e860daf6" integrity sha512-k2Ty1JcVojjJFwrg/ThKi2ujJ7XNLYaFGNB/bWT9wGR+oSMJHMa5w+CUq6p/pVrKeNNgA7pCqEcjSnHVoqJQFw== +"@gerrit0/mini-shiki@^1.24.0": + version "1.24.4" + resolved "https://registry.yarnpkg.com/@gerrit0/mini-shiki/-/mini-shiki-1.24.4.tgz#e5328ca0dccc094460c03701d62158137a5a2eda" + integrity sha512-YEHW1QeAg6UmxEmswiQbOVEg1CW22b1XUD/lNTliOsu0LD0wqoyleFMnmbTp697QE0pcadQiR5cVtbbAPncvpw== + dependencies: + "@shikijs/engine-oniguruma" "^1.24.2" + "@shikijs/types" "^1.24.2" + "@shikijs/vscode-textmate" "^9.3.1" + "@google-cloud/firestore@^4.15.1": version "4.15.1" resolved "https://registry.yarnpkg.com/@google-cloud/firestore/-/firestore-4.15.1.tgz#ed764fc76823ce120e68fe8c27ef1edd0650cd93" @@ -3330,6 +3339,27 @@ lodash-es "^4.17.21" read-package-up "^11.0.0" +"@shikijs/engine-oniguruma@^1.24.2": + version "1.24.3" + resolved "https://registry.yarnpkg.com/@shikijs/engine-oniguruma/-/engine-oniguruma-1.24.3.tgz#e549cb6f2050113ac65994b4e98f4704c3e427e8" + integrity sha512-iNnx950gs/5Nk+zrp1LuF+S+L7SKEhn8k9eXgFYPGhVshKppsYwRmW8tpmAMvILIMSDfrgqZ0w+3xWVQB//1Xw== + dependencies: + "@shikijs/types" "1.24.3" + "@shikijs/vscode-textmate" "^9.3.1" + +"@shikijs/types@1.24.3", "@shikijs/types@^1.24.2": + version "1.24.3" + resolved "https://registry.yarnpkg.com/@shikijs/types/-/types-1.24.3.tgz#6700007019cc5c2fa5db32ab1595f01b1e79d969" + integrity sha512-FPMrJ69MNxhRtldRk69CghvaGlbbN3pKRuvko0zvbfa2dXp4pAngByToqS5OY5jvN8D7LKR4RJE8UvzlCOuViw== + dependencies: + "@shikijs/vscode-textmate" "^9.3.1" + "@types/hast" "^3.0.4" + +"@shikijs/vscode-textmate@^9.3.1": + version "9.3.1" + resolved "https://registry.yarnpkg.com/@shikijs/vscode-textmate/-/vscode-textmate-9.3.1.tgz#afda31f8f42cab70a26f3603f52eae3f1c35d2f7" + integrity sha512-79QfK1393x9Ho60QFyLti+QfdJzRQCVLFb97kOIV7Eo9vQU/roINgk7m24uv0a7AUvN//RDH36FLjjK48v0s9g== + "@sideway/address@^4.1.5": version "4.1.5" resolved "https://registry.yarnpkg.com/@sideway/address/-/address-4.1.5.tgz#4bc149a0076623ced99ca8208ba780d65a99b9d5" @@ -3532,6 +3562,13 @@ dependencies: "@types/node" "*" +"@types/hast@^3.0.4": + version "3.0.4" + resolved "https://registry.yarnpkg.com/@types/hast/-/hast-3.0.4.tgz#1d6b39993b82cea6ad783945b0508c25903e15aa" + integrity sha512-WPs+bbQw5aCj+x6laNGWLH3wviHtoCv/P3+otBhbOhJgG8qtpdAMlTCxLtsTWA7LH1Oh/bFCHsBn0TPS5m30EQ== + dependencies: + "@types/unist" "*" + "@types/http-errors@*": version "2.0.4" resolved "https://registry.yarnpkg.com/@types/http-errors/-/http-errors-2.0.4.tgz#7eb47726c391b7345a6ec35ad7f4de469cf5ba4f" @@ -3674,6 +3711,11 @@ resolved "https://registry.yarnpkg.com/@types/stack-utils/-/stack-utils-2.0.3.tgz#6209321eb2c1712a7e7466422b8cb1fc0d9dd5d8" integrity sha512-9aEbYZ3TbYMznPdcdr3SmIrLXwC/AKZXQeCf9Pgao5CKb8CyHuEX5jzWPTkvregvhRJHcpRO6BFoGW9ycaOkYw== +"@types/unist@*": + version "3.0.3" + resolved "https://registry.yarnpkg.com/@types/unist/-/unist-3.0.3.tgz#acaab0f919ce69cce629c2d4ed2eb4adc1b6c20c" + integrity sha512-ko/gIFJRv177XgZsZcBwnqJN5x/Gien8qNOn0D5bQU/zAzVf9Zt3BlcUiLqhV9y4ARk0GbT3tnUiPNgnTXzc/Q== + "@types/yargs-parser@*": version "21.0.3" resolved "https://registry.yarnpkg.com/@types/yargs-parser/-/yargs-parser-21.0.3.tgz#815e30b786d2e8f0dcd85fd5bcf5e1a04d008f15" @@ -5873,6 +5915,11 @@ ent@^2.2.0: dependencies: punycode "^1.4.1" +entities@^4.4.0: + version "4.5.0" + resolved "https://registry.yarnpkg.com/entities/-/entities-4.5.0.tgz#5d268ea5e7113ec74c4d033b79ea5a35a488fb48" + integrity sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw== + env-ci@^11.0.0: version "11.1.0" resolved "https://registry.yarnpkg.com/env-ci/-/env-ci-11.1.0.tgz#b26eeb692f76c1f69ddc1fb2d4a3d371088a54f9" @@ -6809,7 +6856,7 @@ fs-extra@^8.1.0: jsonfile "^4.0.0" universalify "^0.1.0" -fs-extra@^9.0.0, fs-extra@^9.0.1, fs-extra@^9.1.0: +fs-extra@^9.0.0, fs-extra@^9.1.0: version "9.1.0" resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-9.1.0.tgz#5954460c764a8da2094ba3554bf839e6b9a7c86d" integrity sha512-hcg3ZmepS30/7BSFqRvoo3DOMQu7IjqxO5nCDt+zM9XWjb33Wg7ziNT+Qvqbuc3+gWpzO02JubVyk2G4Zvo1OQ== @@ -7268,7 +7315,7 @@ gtoken@^5.0.4: google-p12-pem "^3.1.3" jws "^4.0.0" -handlebars@^4.7.6, handlebars@^4.7.7: +handlebars@^4.7.7: version "4.7.8" resolved "https://registry.yarnpkg.com/handlebars/-/handlebars-4.7.8.tgz#41c42c18b1be2365439188c77c6afae71c0cd9e9" integrity sha512-vafaFqs8MZkRrSX7sFVUdo3ap/eNiLnb4IakshzvP56X5Nr1iGKAIqdX6tMlm6HcNRIkr6AxO5jFEoJzzpT8aQ== @@ -7423,7 +7470,7 @@ hermes-profile-transformer@^0.0.6: dependencies: source-map "^0.7.3" -highlight.js@^10.2.0, highlight.js@^10.7.1: +highlight.js@^10.7.1: version "10.7.3" resolved "https://registry.yarnpkg.com/highlight.js/-/highlight.js-10.7.3.tgz#697272e3991356e40c3cac566a74eef681756531" integrity sha512-tzcUFauisWKNHaRkN4Wjl/ZA07gENAjFl3J/c480dprkGTg5EQstgaNFqBfUqCq54kZRIEcreTsAgF/m2quD7A== @@ -9306,6 +9353,13 @@ lines-and-columns@^1.1.6: resolved "https://registry.yarnpkg.com/lines-and-columns/-/lines-and-columns-1.2.4.tgz#eca284f75d2965079309dc0ad9255abb2ebc1632" integrity sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg== +linkify-it@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/linkify-it/-/linkify-it-5.0.0.tgz#9ef238bfa6dc70bd8e7f9572b52d369af569b421" + integrity sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ== + dependencies: + uc.micro "^2.0.0" + load-json-file@^4.0.0: version "4.0.0" resolved "https://registry.yarnpkg.com/load-json-file/-/load-json-file-4.0.0.tgz#2f5f45ab91e33216234fd53adab668eb4ec0993b" @@ -9471,7 +9525,7 @@ lodash.uniqby@^4.7.0: resolved "https://registry.yarnpkg.com/lodash.uniqby/-/lodash.uniqby-4.7.0.tgz#d99c07a669e9e6d24e1362dfe266c67616af1302" integrity sha512-e/zcLx6CSbmaEgFHCA7BnoQKyCtKMxnuWrJygbwPs/AIn+IMKl66L8/s+wBUn5LRw2pZx3bUHibiV1b6aTWIww== -lodash@^4.17.14, lodash@^4.17.15, lodash@^4.17.19, lodash@^4.17.20, lodash@^4.17.21, lodash@^4.17.4, lodash@^4.7.0: +lodash@^4.17.14, lodash@^4.17.15, lodash@^4.17.19, lodash@^4.17.21, lodash@^4.17.4, lodash@^4.7.0: version "4.17.21" resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.21.tgz#679591c564c3bffaae8454cf0b3df370c3d6911c" integrity sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg== @@ -9672,6 +9726,18 @@ map-visit@^1.0.0: dependencies: object-visit "^1.0.0" +markdown-it@^14.1.0: + version "14.1.0" + resolved "https://registry.yarnpkg.com/markdown-it/-/markdown-it-14.1.0.tgz#3c3c5992883c633db4714ccb4d7b5935d98b7d45" + integrity sha512-a54IwgWPaeBCAAsv13YgmALOF1elABB08FxO9i+r4VFk5Vl4pKokRPeX8u5TCgSsPi6ec1otfLjdOpVcgbpshg== + dependencies: + argparse "^2.0.1" + entities "^4.4.0" + linkify-it "^5.0.0" + mdurl "^2.0.0" + punycode.js "^2.3.1" + uc.micro "^2.1.0" + marked-terminal@^7.0.0: version "7.2.1" resolved "https://registry.yarnpkg.com/marked-terminal/-/marked-terminal-7.2.1.tgz#9c1ae073a245a03c6a13e3eeac6f586f29856068" @@ -9685,11 +9751,6 @@ marked-terminal@^7.0.0: node-emoji "^2.1.3" supports-hyperlinks "^3.1.0" -marked@^1.1.1: - version "1.2.9" - resolved "https://registry.yarnpkg.com/marked/-/marked-1.2.9.tgz#53786f8b05d4c01a2a5a76b7d1ec9943d29d72dc" - integrity sha512-H8lIX2SvyitGX+TRdtS06m1jHMijKN/XjfH6Ooii9fvxMlh8QdqBfBDkGUpMWH2kQNrtixjzYUa3SH8ROTgRRw== - marked@^12.0.0: version "12.0.2" resolved "https://registry.yarnpkg.com/marked/-/marked-12.0.2.tgz#b31578fe608b599944c69807b00f18edab84647e" @@ -9705,6 +9766,11 @@ math-intrinsics@^1.0.0: resolved "https://registry.yarnpkg.com/math-intrinsics/-/math-intrinsics-1.0.0.tgz#4e04bf87c85aa51e90d078dac2252b4eb5260817" integrity sha512-4MqMiKP90ybymYvsut0CH2g4XWbfLtmlCkXmtmdcDCxNB+mQcu1w/1+L/VD7vi/PSv7X2JYV7SCcR+jiPXnQtA== +mdurl@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/mdurl/-/mdurl-2.0.0.tgz#80676ec0433025dd3e17ee983d0fe8de5a2237e0" + integrity sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w== + memoize-one@^5.0.0: version "5.2.1" resolved "https://registry.yarnpkg.com/memoize-one/-/memoize-one-5.2.1.tgz#8337aa3c4335581839ec01c3d594090cebe8f00e" @@ -10328,7 +10394,7 @@ min-indent@^1.0.0: resolved "https://registry.yarnpkg.com/min-indent/-/min-indent-1.0.1.tgz#a63f681673b30571fbe8bc25686ae746eefa9869" integrity sha512-I9jwMn07Sy/IwOj3zVkVik2JTvgpaykDZEigL6Rx6N9LbMywwUSMtxET+7lVoDLLd3O3IXwJwvuuns8UB/HeAg== -minimatch@^3.0.0, minimatch@^3.0.2, minimatch@^3.0.4, minimatch@^3.1.1, minimatch@^3.1.2: +minimatch@^3.0.2, minimatch@^3.0.4, minimatch@^3.1.1, minimatch@^3.1.2: version "3.1.2" resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.1.2.tgz#19cd194bfd3e428f049a70817c038d89ab4be35b" integrity sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw== @@ -11875,7 +11941,7 @@ proggy@^3.0.0: resolved "https://registry.yarnpkg.com/proggy/-/proggy-3.0.0.tgz#874e91fed27fe00a511758e83216a6b65148bd6c" integrity sha512-QE8RApCM3IaRRxVzxrjbgNMpQEX6Wu0p0KBeoSiSEw5/bsGwZHsshF4LCxH2jp/r6BU+bqA3LrMDEYNfJnpD8Q== -progress@^2.0.0, progress@^2.0.3: +progress@^2.0.0: version "2.0.3" resolved "https://registry.yarnpkg.com/progress/-/progress-2.0.3.tgz#7e8cf8d8f5b8f239c1bc68beb4eb78567d572ef8" integrity sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA== @@ -12043,6 +12109,11 @@ pumpify@^2.0.0: inherits "^2.0.3" pump "^3.0.0" +punycode.js@^2.3.1: + version "2.3.1" + resolved "https://registry.yarnpkg.com/punycode.js/-/punycode.js-2.3.1.tgz#6b53e56ad75588234e79f4affa90972c7dd8cdb7" + integrity sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA== + punycode@^1.4.1: version "1.4.1" resolved "https://registry.yarnpkg.com/punycode/-/punycode-1.4.1.tgz#c0d5a63b2718800ad8e1eb0fa5269c84dd41845e" @@ -12952,7 +13023,7 @@ shell-quote@^1.6.1, shell-quote@^1.7.3: resolved "https://registry.yarnpkg.com/shell-quote/-/shell-quote-1.8.2.tgz#d2d83e057959d53ec261311e9e9b8f51dcb2934a" integrity sha512-AzqKpGKjrj7EM6rKVQEPpB288oCfnrEIuyoT9cyF4nmGa7V8Zk6f7RRqYisX8X9m+Q7bd632aZW4ky7EhbQztA== -shelljs@^0.8.4, shelljs@^0.8.5: +shelljs@^0.8.5: version "0.8.5" resolved "https://registry.yarnpkg.com/shelljs/-/shelljs-0.8.5.tgz#de055408d8361bed66c669d2f000538ced8ee20c" integrity sha512-TiwcRcrkhHvbrZbnRcFYMLl30Dfov3HKqzp5tO5b4pt6G/SezKcYhmDg15zXVBswHmctSAQKznqNW2LO5tTDow== @@ -14154,11 +14225,6 @@ typedarray@^0.0.6: resolved "https://registry.yarnpkg.com/typedarray/-/typedarray-0.0.6.tgz#867ac74e3864187b1d3d47d996a78ec5c8830777" integrity sha512-/aCDEGatGvZ2BIk+HmLf4ifCJFwvKFNb9/JeZPMulfgFracn9QFcAf5GO8B/mweUjSoblS5In0cWhqpfs/5PQA== -typedoc-default-themes@^0.11.4: - version "0.11.4" - resolved "https://registry.yarnpkg.com/typedoc-default-themes/-/typedoc-default-themes-0.11.4.tgz#1bc55b7c8d1132844616ff6f570e1e2cd0eb7343" - integrity sha512-Y4Lf+qIb9NTydrexlazAM46SSLrmrQRqWiD52593g53SsmUFioAsMWt8m834J6qsp+7wHRjxCXSZeiiW5cMUdw== - typedoc-plugin-markdown@^3.11.14: version "3.17.1" resolved "https://registry.yarnpkg.com/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.17.1.tgz#c33f42363c185adf842f4699166015f7fe0ed02b" @@ -14166,22 +14232,10 @@ typedoc-plugin-markdown@^3.11.14: dependencies: handlebars "^4.7.7" -typedoc@^0.19.2: - version "0.19.2" - resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.19.2.tgz#842a63a581f4920f76b0346bb80eb2a49afc2c28" - integrity sha512-oDEg1BLEzi1qvgdQXc658EYgJ5qJLVSeZ0hQ57Eq4JXy6Vj2VX4RVo18qYxRWz75ifAaYuYNBUCnbhjd37TfOg== - dependencies: - fs-extra "^9.0.1" - handlebars "^4.7.6" - highlight.js "^10.2.0" - lodash "^4.17.20" - lunr "^2.3.9" - marked "^1.1.1" - minimatch "^3.0.0" - progress "^2.0.3" - semver "^7.3.2" - shelljs "^0.8.4" - typedoc-default-themes "^0.11.4" +typedoc-plugin-markdown@^4.3.3: + version "4.3.3" + resolved "https://registry.yarnpkg.com/typedoc-plugin-markdown/-/typedoc-plugin-markdown-4.3.3.tgz#212f51faf742f8cc918e7ae239fd814b5b096317" + integrity sha512-kESCcNRzOcFJATLML2FoCfaTF9c0ujmbZ+UXsJvmNlFLS3v8tDKfDifreJXvXWa9d8gUcetZqOqFcZ/7+Ba34Q== typedoc@^0.22.13: version "0.22.18" @@ -14194,11 +14248,27 @@ typedoc@^0.22.13: minimatch "^5.1.0" shiki "^0.10.1" +typedoc@^0.27.5: + version "0.27.5" + resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.27.5.tgz#a86c89589213d7b36301eeafb4ddf6ad9dfd1ab3" + integrity sha512-x+fhKJtTg4ozXwKayh/ek4wxZQI/+2hmZUdO2i2NGDBRUflDble70z+ewHod3d4gRpXSO6fnlnjbDTnJk7HlkQ== + dependencies: + "@gerrit0/mini-shiki" "^1.24.0" + lunr "^2.3.9" + markdown-it "^14.1.0" + minimatch "^9.0.5" + yaml "^2.6.1" + typescript@^4.6.2: version "4.9.5" resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.9.5.tgz#095979f9bcc0d09da324d58d03ce8f8374cbe65a" integrity sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g== +uc.micro@^2.0.0, uc.micro@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/uc.micro/-/uc.micro-2.1.0.tgz#f8d3f7d0ec4c3dea35a7e3c8efa4cb8b45c9e7ee" + integrity sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A== + uglify-es@^3.1.9: version "3.3.9" resolved "https://registry.yarnpkg.com/uglify-es/-/uglify-es-3.3.9.tgz#0c1c4f0700bed8dbc124cdb304d2592ca203e677" @@ -14894,6 +14964,11 @@ yaml@^1.10.0, yaml@^1.10.2: resolved "https://registry.yarnpkg.com/yaml/-/yaml-1.10.2.tgz#2301c5ffbf12b467de8da2333a459e29e7920e4b" integrity sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg== +yaml@^2.6.1: + version "2.6.1" + resolved "https://registry.yarnpkg.com/yaml/-/yaml-2.6.1.tgz#42f2b1ba89203f374609572d5349fb8686500773" + integrity sha512-7r0XPzioN/Q9kXBro/XPnA6kznR73DHq+GXh5ON7ZozRO6aMjbmiBuKste2wslTFkC5d1dw0GooOCepZXJ2SAg== + yargs-parser@20.2.4: version "20.2.4" resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-20.2.4.tgz#b42890f14566796f85ae8e3a25290d205f154a54"