{"id":31433417,"url":"https://github.com/cap-go/capacitor-alarm","last_synced_at":"2025-09-30T11:14:28.821Z","repository":{"id":314937329,"uuid":"1057254746","full_name":"Cap-go/capacitor-alarm","owner":"Cap-go","description":"Plugin to set and open the native alarms for Capacitor apps","archived":false,"fork":false,"pushed_at":"2025-09-15T18:05:09.000Z","size":364,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-15T19:27:33.029Z","etag":null,"topics":["capacitor","ionic"],"latest_commit_sha":null,"homepage":"https://capgo.app","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Cap-go.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"Cap-go","patreon":null,"open_collective":"capgo","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2025-09-15T13:34:31.000Z","updated_at":"2025-09-15T18:05:13.000Z","dependencies_parsed_at":"2025-09-15T19:27:39.912Z","dependency_job_id":"ef143604-8ea1-4440-8237-08d4447fb01d","html_url":"https://github.com/Cap-go/capacitor-alarm","commit_stats":null,"previous_names":["cap-go/capacitor-alarm"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/Cap-go/capacitor-alarm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-alarm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-alarm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-alarm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-alarm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Cap-go","download_url":"https://codeload.github.com/Cap-go/capacitor-alarm/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-alarm/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":277675014,"owners_count":25857715,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-30T02:00:09.208Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["capacitor","ionic"],"created_at":"2025-09-30T11:14:24.049Z","updated_at":"2025-09-30T11:14:28.805Z","avatar_url":"https://github.com/Cap-go.png","language":"Swift","funding_links":["https://github.com/sponsors/Cap-go","https://opencollective.com/capgo"],"categories":[],"sub_categories":[],"readme":"# @capgo/capacitor-alarm\n \u003ca href=\"https://capgo.app/\"\u003e\u003cimg src='https://raw.githubusercontent.com/Cap-go/capgo/main/assets/capgo_banner.png' alt='Capgo - Instant updates for capacitor'/\u003e\u003c/a\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ch2\u003e\u003ca href=\"https://capgo.app/?ref=plugin\"\u003e ➡️ Get Instant updates for your App with Capgo\u003c/a\u003e\u003c/h2\u003e\n  \u003ch2\u003e\u003ca href=\"https://capgo.app/consulting/?ref=plugin\"\u003e Missing a feature? We’ll build the plugin for you 💪\u003c/a\u003e\u003c/h2\u003e\n\u003c/div\u003e\n\nManage native alarm Capacitor plugin\n\n## Install\n\n```bash\nnpm install @capgo/capacitor-alarm\nnpx cap sync\n```\n\n## Requirements\n\n- iOS: iOS 26+ only. This plugin relies on `AlarmKit` APIs and will report unsupported on earlier versions or when the framework is unavailable.\n- Android: Uses `AlarmClock` intents; behavior depends on the default Clock app and OEM policies.\n\nNote: This plugin only exposes native alarm actions (create/open). It does not implement any custom in-app alarm scheduling/CRUD.\n\n## API\n\n\u003cdocgen-index\u003e\n\n* [`createAlarm(...)`](#createalarm)\n* [`openAlarms()`](#openalarms)\n* [`getOSInfo()`](#getosinfo)\n* [`requestPermissions(...)`](#requestpermissions)\n* [Interfaces](#interfaces)\n* [Type Aliases](#type-aliases)\n\n\u003c/docgen-index\u003e\n\n\u003cdocgen-api\u003e\n\u003c!--Update the source file JSDoc comments and rerun docgen to update the docs below--\u003e\n\n### createAlarm(...)\n\n```typescript\ncreateAlarm(options: NativeAlarmCreateOptions) =\u003e Promise\u003cNativeActionResult\u003e\n```\n\nCreate 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+).\n\n| Param         | Type                                                                          |\n| ------------- | ----------------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#nativealarmcreateoptions\"\u003eNativeAlarmCreateOptions\u003c/a\u003e\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#nativeactionresult\"\u003eNativeActionResult\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n### openAlarms()\n\n```typescript\nopenAlarms() =\u003e Promise\u003cNativeActionResult\u003e\n```\n\nOpen the platform's native alarm list UI, if available.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#nativeactionresult\"\u003eNativeActionResult\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n### getOSInfo()\n\n```typescript\ngetOSInfo() =\u003e Promise\u003cOSInfo\u003e\n```\n\nGet information about the OS and capabilities.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#osinfo\"\u003eOSInfo\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n### requestPermissions(...)\n\n```typescript\nrequestPermissions(options?: { exactAlarm?: boolean | undefined; } | undefined) =\u003e Promise\u003cPermissionResult\u003e\n```\n\nRequest relevant permissions for alarm usage on the platform.\nOn Android, may route to settings for exact alarms.\n\n| Param         | Type                                   |\n| ------------- | -------------------------------------- |\n| **`options`** | \u003ccode\u003e{ exactAlarm?: boolean; }\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#permissionresult\"\u003ePermissionResult\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n### Interfaces\n\n\n#### NativeActionResult\n\n| Prop          | Type                 |\n| ------------- | -------------------- |\n| **`success`** | \u003ccode\u003eboolean\u003c/code\u003e |\n| **`message`** | \u003ccode\u003estring\u003c/code\u003e  |\n\n\n#### NativeAlarmCreateOptions\n\nOptions for creating a native OS alarm via the platform clock app.\n\n| Prop          | Type                 | Description                                  |\n| ------------- | -------------------- | -------------------------------------------- |\n| **`hour`**    | \u003ccode\u003enumber\u003c/code\u003e  | Hour of day in 24h format (0-23)             |\n| **`minute`**  | \u003ccode\u003enumber\u003c/code\u003e  | Minute of hour (0-59)                        |\n| **`label`**   | \u003ccode\u003estring\u003c/code\u003e  | Optional label for the alarm                 |\n| **`skipUi`**  | \u003ccode\u003eboolean\u003c/code\u003e | Android only: attempt to skip UI if possible |\n| **`vibrate`** | \u003ccode\u003eboolean\u003c/code\u003e | Android only: set alarm to vibrate           |\n\n\n#### OSInfo\n\nReturned info about current OS and capabilities.\n\n| Prop                                 | Type                 | Description                                                 |\n| ------------------------------------ | -------------------- | ----------------------------------------------------------- |\n| **`platform`**                       | \u003ccode\u003estring\u003c/code\u003e  | 'ios' \\| 'android' \\| 'web'                                 |\n| **`version`**                        | \u003ccode\u003estring\u003c/code\u003e  | OS version string                                           |\n| **`supportsNativeAlarms`**           | \u003ccode\u003eboolean\u003c/code\u003e | Whether the platform exposes a native alarm app integration |\n| **`supportsScheduledNotifications`** | \u003ccode\u003eboolean\u003c/code\u003e | Whether scheduling local notifications is supported         |\n| **`canScheduleExactAlarms`**         | \u003ccode\u003eboolean\u003c/code\u003e | Android only: whether exact alarms are allowed              |\n\n\n#### PermissionResult\n\nResult of a permissions request.\n\n| Prop          | Type                                                             | Description                        |\n| ------------- | ---------------------------------------------------------------- | ---------------------------------- |\n| **`granted`** | \u003ccode\u003eboolean\u003c/code\u003e                                             | Overall grant for requested scope  |\n| **`details`** | \u003ccode\u003e\u003ca href=\"#record\"\u003eRecord\u003c/a\u003e\u0026lt;string, boolean\u0026gt;\u003c/code\u003e | Optional details by permission key |\n\n\n### Type Aliases\n\n\n#### Record\n\nConstruct a type with a set of properties K of type T\n\n\u003ccode\u003e{\r [P in K]: T;\r }\u003c/code\u003e\n\n\u003c/docgen-api\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcap-go%2Fcapacitor-alarm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcap-go%2Fcapacitor-alarm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcap-go%2Fcapacitor-alarm/lists"}