@capgo/capacitor-alarm 7.1.3 → 7.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/docs.json +1 -1
- package/dist/esm/definitions.d.ts +1 -1
- package/dist/esm/definitions.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -45,7 +45,7 @@ createAlarm(options: NativeAlarmCreateOptions) => Promise<NativeActionResult>
|
|
|
45
45
|
```
|
|
46
46
|
|
|
47
47
|
Create a native OS alarm using the platform clock app.
|
|
48
|
-
On Android this uses the Alarm Clock intent; on iOS this
|
|
48
|
+
On Android this uses the Alarm Clock intent; on iOS this use AlarmKit if available (iOS 26+).
|
|
49
49
|
|
|
50
50
|
| Param | Type |
|
|
51
51
|
| ------------- | ----------------------------------------------------------------------------- |
|
package/dist/docs.json
CHANGED
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
],
|
|
18
18
|
"returns": "Promise<NativeActionResult>",
|
|
19
19
|
"tags": [],
|
|
20
|
-
"docs": "Create a native OS alarm using the platform clock app.\nOn Android this uses the Alarm Clock intent; on iOS this
|
|
20
|
+
"docs": "Create a native OS alarm using the platform clock app.\nOn Android this uses the Alarm Clock intent; on iOS this use AlarmKit if available (iOS 26+).",
|
|
21
21
|
"complexTypes": [
|
|
22
22
|
"NativeActionResult",
|
|
23
23
|
"NativeAlarmCreateOptions"
|
|
@@ -38,7 +38,7 @@ export interface PermissionResult {
|
|
|
38
38
|
export interface CapgoAlarmPlugin {
|
|
39
39
|
/**
|
|
40
40
|
* Create a native OS alarm using the platform clock app.
|
|
41
|
-
* On Android this uses the Alarm Clock intent; on iOS this
|
|
41
|
+
* On Android this uses the Alarm Clock intent; on iOS this use AlarmKit if available (iOS 26+).
|
|
42
42
|
*/
|
|
43
43
|
createAlarm(options: NativeAlarmCreateOptions): Promise<NativeActionResult>;
|
|
44
44
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["/** Options for creating a native OS alarm via the platform clock app. */\nexport interface NativeAlarmCreateOptions {\n /** Hour of day in 24h format (0-23) */\n hour: number;\n /** Minute of hour (0-59) */\n minute: number;\n /** Optional label for the alarm */\n label?: string;\n /** Android only: attempt to skip UI if possible */\n skipUi?: boolean;\n /** Android only: set alarm to vibrate */\n vibrate?: boolean;\n}\n\nexport interface NativeActionResult {\n success: boolean;\n message?: string;\n}\n\n/** Returned info about current OS and capabilities. */\nexport interface OSInfo {\n /** 'ios' | 'android' | 'web' */\n platform: string;\n /** OS version string */\n version: string;\n /** Whether the platform exposes a native alarm app integration */\n supportsNativeAlarms: boolean;\n /** Whether scheduling local notifications is supported */\n supportsScheduledNotifications: boolean;\n /** Android only: whether exact alarms are allowed */\n canScheduleExactAlarms?: boolean;\n}\n\n/** Result of a permissions request. */\nexport interface PermissionResult {\n /** Overall grant for requested scope */\n granted: boolean;\n /** Optional details by permission key */\n details?: Record<string, boolean>;\n}\n\nexport interface CapgoAlarmPlugin {\n /**\n * Create a native OS alarm using the platform clock app.\n * On Android this uses the Alarm Clock intent; on iOS this
|
|
1
|
+
{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["/** Options for creating a native OS alarm via the platform clock app. */\nexport interface NativeAlarmCreateOptions {\n /** Hour of day in 24h format (0-23) */\n hour: number;\n /** Minute of hour (0-59) */\n minute: number;\n /** Optional label for the alarm */\n label?: string;\n /** Android only: attempt to skip UI if possible */\n skipUi?: boolean;\n /** Android only: set alarm to vibrate */\n vibrate?: boolean;\n}\n\nexport interface NativeActionResult {\n success: boolean;\n message?: string;\n}\n\n/** Returned info about current OS and capabilities. */\nexport interface OSInfo {\n /** 'ios' | 'android' | 'web' */\n platform: string;\n /** OS version string */\n version: string;\n /** Whether the platform exposes a native alarm app integration */\n supportsNativeAlarms: boolean;\n /** Whether scheduling local notifications is supported */\n supportsScheduledNotifications: boolean;\n /** Android only: whether exact alarms are allowed */\n canScheduleExactAlarms?: boolean;\n}\n\n/** Result of a permissions request. */\nexport interface PermissionResult {\n /** Overall grant for requested scope */\n granted: boolean;\n /** Optional details by permission key */\n details?: Record<string, boolean>;\n}\n\nexport interface CapgoAlarmPlugin {\n /**\n * Create a native OS alarm using the platform clock app.\n * On Android this uses the Alarm Clock intent; on iOS this use AlarmKit if available (iOS 26+).\n */\n createAlarm(options: NativeAlarmCreateOptions): Promise<NativeActionResult>;\n\n /**\n * Open the platform's native alarm list UI, if available.\n */\n openAlarms(): Promise<NativeActionResult>;\n\n /**\n * Get information about the OS and capabilities.\n */\n getOSInfo(): Promise<OSInfo>;\n\n /**\n * Request relevant permissions for alarm usage on the platform.\n * On Android, may route to settings for exact alarms.\n */\n requestPermissions(options?: { exactAlarm?: boolean }): Promise<PermissionResult>;\n}\n"]}
|