docs: use typedoc+markdown plugin for docs.page compatible reference

- use mdx file extension since that's what docs.page expects - use flat output so relative links don't have pathing issues on docs.page
invertase · Dec 19, 2024 · 6ed9bcd · 6ed9bcd
1 parent 090ab68
commit 6ed9bcd
Show file tree

Hide file tree

Showing 69 changed files with 6,864 additions and 35 deletions.
diff --git a/docs/react-native/reference/Enumeration.AlarmType.mdx b/docs/react-native/reference/Enumeration.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/41542153ee2edae7e06eac819c9933e6c280f1b4/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/41542153ee2edae7e06eac819c9933e6c280f1b4/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/41542153ee2edae7e06eac819c9933e6c280f1b4/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/41542153ee2edae7e06eac819c9933e6c280f1b4/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/41542153ee2edae7e06eac819c9933e6c280f1b4/packages/react-native/src/types/Trigger.ts#L46)
diff --git a/docs/react-native/reference/Enumeration.AndroidBadgeIconType.mdx b/docs/react-native/reference/Enumeration.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/41542153ee2edae7e06eac819c9933e6c280f1b4/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/41542153ee2edae7e06eac819c9933e6c280f1b4/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/41542153ee2edae7e06eac819c9933e6c280f1b4/packages/react-native/src/types/NotificationAndroid.ts#L1085)
diff --git a/docs/react-native/reference/Enumeration.AndroidCategory.mdx b/docs/react-native/reference/Enumeration.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/41542153ee2edae7e06eac819c9933e6c280f1b4/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/41542153ee2edae7e06eac819c9933e6c280f1b4/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/41542153ee2edae7e06eac819c9933e6c280f1b4/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/41542153ee2edae7e06eac819c9933e6c280f1b4/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/41542153ee2edae7e06eac819c9933e6c280f1b4/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/41542153ee2edae7e06eac819c9933e6c280f1b4/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/41542153ee2edae7e06eac819c9933e6c280f1b4/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/41542153ee2edae7e06eac819c9933e6c280f1b4/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/41542153ee2edae7e06eac819c9933e6c280f1b4/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/41542153ee2edae7e06eac819c9933e6c280f1b4/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/41542153ee2edae7e06eac819c9933e6c280f1b4/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/41542153ee2edae7e06eac819c9933e6c280f1b4/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/41542153ee2edae7e06eac819c9933e6c280f1b4/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/41542153ee2edae7e06eac819c9933e6c280f1b4/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/41542153ee2edae7e06eac819c9933e6c280f1b4/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/41542153ee2edae7e06eac819c9933e6c280f1b4/packages/react-native/src/types/NotificationAndroid.ts#L1124)