{"id":16962419,"url":"https://github.com/aeharding/capacitor-biometric-lock","last_synced_at":"2025-10-13T03:44:09.765Z","repository":{"id":206889008,"uuid":"717935333","full_name":"aeharding/capacitor-biometric-lock","owner":"aeharding","description":null,"archived":false,"fork":false,"pushed_at":"2025-01-26T01:46:31.000Z","size":264,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-08-03T15:35:12.815Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/aeharding.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"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}},"created_at":"2023-11-13T02:10:34.000Z","updated_at":"2025-04-16T10:13:28.000Z","dependencies_parsed_at":"2023-12-13T20:03:58.855Z","dependency_job_id":"b2d95ec4-3216-409d-ad07-2fe4be5c3186","html_url":"https://github.com/aeharding/capacitor-biometric-lock","commit_stats":null,"previous_names":["aeharding/capacitor-biometric-lock"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/aeharding/capacitor-biometric-lock","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aeharding%2Fcapacitor-biometric-lock","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aeharding%2Fcapacitor-biometric-lock/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aeharding%2Fcapacitor-biometric-lock/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aeharding%2Fcapacitor-biometric-lock/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aeharding","download_url":"https://codeload.github.com/aeharding/capacitor-biometric-lock/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aeharding%2Fcapacitor-biometric-lock/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273345454,"owners_count":25089199,"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-02T02:00:09.530Z","response_time":77,"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":[],"created_at":"2024-10-13T23:06:34.286Z","updated_at":"2025-10-13T03:44:04.742Z","avatar_url":"https://github.com/aeharding.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# capacitor-biometric-lock\n\nLock and unlock an app with biometrics\n\n## Install\n\n```bash\nnpm install capacitor-biometric-lock\nnpx cap sync\n```\n\n## API\n\n\u003cdocgen-index\u003e\n\n* [`configure(...)`](#configure)\n* [`getConfiguration()`](#getconfiguration)\n* [`getBiometricMethod()`](#getbiometricmethod)\n* [Interfaces](#interfaces)\n* [Enums](#enums)\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### configure(...)\n\n```typescript\nconfigure(options?: BiometricLockConfiguration | undefined) =\u003e Promise\u003cvoid\u003e\n```\n\nSet plugin configuration\n\n| Param         | Type                                                                              |\n| ------------- | --------------------------------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#biometriclockconfiguration\"\u003eBiometricLockConfiguration\u003c/a\u003e\u003c/code\u003e |\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### getConfiguration()\n\n```typescript\ngetConfiguration() =\u003e Promise\u003cBiometricLockConfiguration\u003e\n```\n\nGet plugin configuration\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#biometriclockconfiguration\"\u003eBiometricLockConfiguration\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### getBiometricMethod()\n\n```typescript\ngetBiometricMethod() =\u003e Promise\u003cBiometricMethodResult\u003e\n```\n\nGet primary biometric method\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#biometricmethodresult\"\u003eBiometricMethodResult\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### Interfaces\n\n\n#### BiometricLockConfiguration\n\nPersisted configuration of the plugin\n\n| Prop                   | Type                 | Description                  |\n| ---------------------- | -------------------- | ---------------------------- |\n| **`enabled`**          | \u003ccode\u003eboolean\u003c/code\u003e |                              |\n| **`timeoutInSeconds`** | \u003ccode\u003enumber\u003c/code\u003e  |                              |\n| **`appName`**          | \u003ccode\u003estring\u003c/code\u003e  |                              |\n| **`retryButtonColor`** | \u003ccode\u003estring\u003c/code\u003e  | Hex color code e.g. \"00ffee\" |\n\n\n#### BiometricMethodResult\n\n| Prop                  | Type                                                        |\n| --------------------- | ----------------------------------------------------------- |\n| **`biometricMethod`** | \u003ccode\u003e\u003ca href=\"#biometricmethod\"\u003eBiometricMethod\u003c/a\u003e\u003c/code\u003e |\n\n\n### Enums\n\n\n#### BiometricMethod\n\n| Members                         | Value          | Description                                     |\n| ------------------------------- | -------------- | ----------------------------------------------- |\n| **`none`**                      | \u003ccode\u003e0\u003c/code\u003e | No biometry is available                        |\n| **`touchId`**                   | \u003ccode\u003e1\u003c/code\u003e | iOS Touch ID is available                       |\n| **`faceId`**                    | \u003ccode\u003e2\u003c/code\u003e | iOS Face ID is available                        |\n| **`fingerprintAuthentication`** | \u003ccode\u003e3\u003c/code\u003e | Android fingerprint authentication is available |\n| **`faceAuthentication`**        | \u003ccode\u003e4\u003c/code\u003e | Android face authentication is available        |\n| **`irisAuthentication`**        | \u003ccode\u003e5\u003c/code\u003e | Android iris authentication is available        |\n\n\u003c/docgen-api\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faeharding%2Fcapacitor-biometric-lock","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faeharding%2Fcapacitor-biometric-lock","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faeharding%2Fcapacitor-biometric-lock/lists"}