android.view.View | iOS: The storyboard’s main view controller view
Android: A full screen `FrameLayout` which contains the `iconView`. |\n| iconView | [unused]
View | The splash icon |\n| plugin | CAPPlugin
com.getcapacitor.Plugin | The `SplashScreen` instance which called the event handler |\n| options | [AnyHashable: Any]
com.getcapacitor.JSObject | Options passed to the `animate()` plugin method |\n| callbacks | SplashScreen.AnimationCallbacks
AnimationCallbacks | Contains `done` and `error` functions, one of which you **must** call when the animation is completely finished |","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/aparajita_capacitor-splash-screen.md","loc":{"lines":{"from":392,"to":461}}}}],["40b53f04-9b01-460b-b93c-ef03825121c8",{"pageContent":"As noted above, you **must** call either the `done` or `error` callback when the animation is completely done, otherwise control will not be returned to the JavaScript runtime. In most cases you will do this in the animation completion function.\n\n### Android-only event parameters\n\nThe following parameters are only passed on Android:\n\n| Param | Type | Description |\n| :------- | :---------------- | :------------------------------- |\n| iconView | View | The splash icon |\n| config | Config instance | Use to get values from `options` |\n| activity | AppCompatActivity | The current activity |\n\n### Android-specific animation\n\nWhen a splash screen is shown on Android, the status bar and navigation bar colors are smoothly animated from their current color to the background color of the splash screen, which effectively hides them. When your splash screen animation is fading out, you need to show the status and navigation bars (if they were visible in your app).\n\nThe `callbacks` parameter on Android contains two extra methods:\n\n```java\nvoid showStatusBar(long delay, long duration, TimeInterpolator interpolator);\n\nvoid showNavigationBar(\n long delay,\n long duration,\n TimeInterpolator interpolator\n);\n```\n\nCalling these methods will smoothly transition the relevant background color from the splash screen background color to the bar’s previous color. If `interpolator` is `null`, it defaults to `LinearInterpolator`.\n\nFor an example of how to use these callbacks, see [SplashScreenAnimator.java](https://github.com/aparajita/capacitor-splash-screen-demo/blob/main/android/app/src/main/java/com/aparajita/capacitor/splashscreendemo/SplashScreenAnimator.java) in the [workshop app](https://github.com/aparajita/capacitor-splash-screen-demo).\n\n#### Why no immersive mode?\n\nThere are a few reasons why this plugin does not support immersive mode:\n\n- The new system splash screens in Android 12+ do not use immersive mode, they set the status and navigation bar backgrounds to the splash screen background. This plugin endeavors to be as consistent with the system splash screen as possible.\n- Immersive mode slides the status and navigation bars offscreen, but if the user taps the screen before the splash screen is hidden they will reappear.\n- On some versions of Android, when immersive mode is entered a system dialog appears advising the user to tap the screen to show the status and navigation bars. This is not something you want to happen during your app launch.\n\n### Accessing animation options\n\nThis plugin provides a custom Config class that allows you to use different option values for each platform when passing options to `show`, `hide` and `animate`. For example, you may want a different `animationDuration` on each platform:\n\n```typescript\nSplashScreen.animate({\n ios: {\n animationDuration: 500\n },\n android: {\n animationDuration: 700\n }\n})\n```","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/aparajita_capacitor-splash-screen.md","loc":{"lines":{"from":463,"to":516}}}}],["0b1d4aba-a698-49b0-b051-8d603bfb5614",{"pageContent":"In your custom animation code, if you want to get values from the options passed to `animate`, use the custom config class to retrieve those values, as shown in the event handler examples above. In brief, to retrieve a value of `
NOTE: On Android, the size of the splash screen icon may not exactly match the actual launch screen icon size. I was not able to determine the algorithm used by Android to determine the size of the splash screen icon.\n\n| Param | Type |\n| :------ | :------------------------------------------------------------- |\n| options | SplashScreenShowOptions |\n\n---\n\n### hide(...)\n\n```typescript\nhide(options?: SplashScreenHideOptions) => Promise
NOTE: This cannot be reliably used on Android, as the app may be paused before the listener is called.\n\n| Param | Type |\n| :------ | :------------------------------------------------------------------------- |\n| options | SplashScreenAppStateListeners |\n\n**Returns:** Promise<PluginListenerHandle>\n\n---\n\n### Interfaces\n\n#### SplashScreenShowOptions\n\nShow options may be specified separately for iOS and Android.\n\n| Prop | Type |\n| :------ | :------------------------------------------------------- |\n| ios | SplashScreenShowOpts |\n| android | SplashScreenShowOpts |\n\n#### SplashScreenShowOpts","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/aparajita_capacitor-splash-screen.md","loc":{"lines":{"from":606,"to":631}}}}],["fea23b99-f732-40c2-b531-9839eab3a688",{"pageContent":"#### SplashScreenShowOpts\n\n| Prop | Type | Description |\n| :------------- | :------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| source | string | The source of the splash screen. Does not apply to launch screens. On iOS, it may be a storyboard with the given name. On Android, it may be any vector drawable with the given name. If the name is \"\\*\", on iOS the configured LaunchScreen storyboard in the app's project will be used, on Android the value of the `windowSplashScreenAnimatedIcon` item in the launch theme will be used. |\n| delay | SplashScreenDuration | How long to delay before showing the splash screen. Does not apply to launch screens. |\n| fadeInDuration | SplashScreenDuration | How long to fade in. Does not apply to launch screens. |\n| showDuration | SplashScreenDuration | Launch: The minimum time to show the splash screen. If `animate()` or `hide()` is called before this time elapses, the screen will remain until the duration is finished.
`show()`: How long to show the splash screen after fade in and before fade out. |\n\n#### SplashScreenHideOptions\n\nHide options may be specified separately for iOS and Android.","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/aparajita_capacitor-splash-screen.md","loc":{"lines":{"from":631,"to":642}}}}],["56a61f80-6343-416b-a6ea-eed584c75daa",{"pageContent":"#### SplashScreenHideOptions\n\nHide options may be specified separately for iOS and Android.\n\n| Prop | Type |\n| :------ | :------------------------------------------------------- |\n| ios | SplashScreenHideOpts |\n| android | SplashScreenHideOpts |\n\n#### SplashScreenHideOpts\n\n| Prop | Type | Description |\n| :-------------- | :------------------------------------------------------- | :------------------------------- |\n| delay | SplashScreenDuration | How long to delay before hiding. |\n| fadeOutDuration | SplashScreenDuration | How long to fade out. |\n\n#### SplashScreenAnimateOptions\n\nAnimate options may be specified separately for iOS and Android.\n\n| Prop | Type |\n| :------ | :------------------------------------------------------------- |\n| ios | SplashScreenAnimateOpts |\n| android | SplashScreenAnimateOpts |\n\n#### SplashScreenAnimateOpts\n\n| Prop | Type | Description |\n| :---------------- | :------------------------------------------------------- | :----------------------------------------------------- |\n| delay | SplashScreenDuration | How long to delay before starting the animation. |\n| animationDuration | SplashScreenDuration | How long animation should take when calling `animate`. |\n\n#### PluginListenerHandle\n\n| Method | Signature |\n| :--------- | :--------------------------- |\n| **remove** | () => Promise<void> |\n\n#### SplashScreenAppStateListeners\n\n### Type Aliases\n\n#### SplashScreenDuration\n\nIn options objects, when you specify a duration, it can either be in seconds or milliseconds. Any value >= 10 will be considered milliseconds, any value < 10 will be considered seconds.\n\n
number\n\nBackgroundVolumeButtonListenerOptions |\n\n--------------------\n\n\n### stopListening()\n\n```typescript\nstopListening() => Promisenumber | The number of times the volume should be changed before the event is fired. Defaults to 3 |\n| **`timeout`** | number | The max time in milliseconds before the `triggerCount` resets. Defaults to 1000 |\n| **`listenerName`** | string | Required. The string name of the listener you would like the event to broadcast to i.e. `volumeTriggered` |\n\nSavePictureOptions |\n\n**Returns:** any\n\n--------------------\n\n\n### saveToDownloads(...)\n\n```typescript\nsaveToDownloads(options: SaveToDownloadsOptions) => any\n```\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------------------- |\n| **`options`** | SaveToDownloadsOptions |\n\n**Returns:** any\n\n--------------------\n\n\n### saveVideo(...)\n\n```typescript\nsaveVideo(options: SaveVideoOptions) => any\n```\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------- |\n| **`options`** | SaveVideoOptions |\n\n**Returns:** any\n\n--------------------\n\n\n### Interfaces\n\n\n#### SavePictureOptions\n\n| Prop | Type |\n| -------------- | ------------------- |\n| **`album`** | string |\n| **`filename`** | string |\n| **`path`** | string |\n\n\n#### SavePictureResult\n\n| Prop | Type |\n| --------- | ------------------- |\n| **`uri`** | string |\n\n\n#### SaveToDownloadsOptions\n\n| Prop | Type |\n| -------------- | ------------------- |\n| **`filename`** | string |\n| **`path`** | string |\n\n\n#### SaveToDownloadsResult\n\n| Prop | Type |\n| --------- | ------------------- |\n| **`uri`** | string |\n\n\n#### SaveVideoOptions\n\n| Prop | Type |\n| -------------- | ------------------- |\n| **`album`** | string |\n| **`filename`** | string |\n| **`path`** | string |\n\n\n#### SaveVideoResult\n\n| Prop | Type |\n| --------- | ------------------- |\n| **`uri`** | string |\n\nPromise<TopReturn>\n\n--------------------\n\n\n### Interfaces\n\n\n#### TopReturn\n\n| Prop | Type |\n| ----------- | ------------------- |\n| **`value`** | number |\n\nPromise<PermissionStatus>\n\n--------------------\n\n\n### getContacts()\n\n```typescript\ngetContacts() => Promise<{ contacts: Contact[]; }>\n```\n\n**Returns:** Promise<{ contacts: Contact[]; }>\n\n--------------------\n\n\n### saveContact(...)\n\n```typescript\nsaveContact(contact: NewContact) => PromiseNewContact |\n\n--------------------\n\n\n### Interfaces\n\n\n#### PermissionStatus\n\n| Prop | Type |\n| ------------- | -------------------- |\n| **`granted`** | boolean |\n\n\n#### Contact\n\n| Prop | Type |\n| ---------------------- | --------------------------- |\n| **`contactId`** | string |\n| **`displayName`** | string |\n| **`phoneNumbers`** | PhoneNumber[] |\n| **`emails`** | EmailAddress[] |\n| **`photoThumbnail`** | string |\n| **`organizationName`** | string |\n| **`organizationRole`** | string |\n| **`birthday`** | string |\n\n\n#### PhoneNumber\n\n| Prop | Type |\n| ------------ | ------------------- |\n| **`label`** | string |\n| **`number`** | string |\n\n\n#### EmailAddress\n\n| Prop | Type |\n| ------------- | ------------------- |\n| **`label`** | string |\n| **`address`** | string |\n\n\n#### NewContact\n\nNew contact schema.\n\n| Prop | Type |\n| ------------ | ------------------- |\n| **`name`** | string |\n| **`mobile`** | string |\n\n\n# android\nadd kakao repository (https://devrepo.kakao.com/nexus/content/groups/public/) in root build.gradle \n\n```\nallprojects {\n repositories {\n google()\n jcenter()\n maven { url 'https://devrepo.kakao.com/nexus/content/groups/public/' }\n }\n}\n\n```\n\n\nadd Global Application for initialize kakao sdk\n\n```java\npackage io.ionic.starter;\n\nimport android.app.Application;\n\nimport com.fumi.capacitor3_kakao_login.Capacitor3KakaoLoginPlugin;\n\npublic class GlobalApplication extends Application {\n\n @Override\n public void onCreate() {\n super.onCreate();\n Capacitor3KakaoLoginPlugin.initKakaoSdk(this,getString(R.string.kakao_app_key));\n }\n\n}\n\n```\n\n\nadd kakao app_key and kakao_schema in res/string.xml\n\n```xml\n
\n\n# IOS\nadd KAKAO_APP_KEY in info.plist\n\n```plist\n
{ app_key: string; web_key: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### kakaoLogin()\n\n```typescript\nkakaoLogin() => Promise<{ value: string; }>\n```\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### kakaoLogout()\n\n```typescript\nkakaoLogout() => Promise<{ value: string; }>\n```","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/efluvi_capacitor3-kakao-login.md","loc":{"lines":{"from":214,"to":310}}}}],["a0096e30-0001-48a7-9ede-6a358912a853",{"pageContent":"--------------------\n\n\n### kakaoLogout()\n\n```typescript\nkakaoLogout() => Promise<{ value: string; }>\n```\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### kakaoUnlink()\n\n```typescript\nkakaoUnlink() => Promise<{ value: string; }>\n```\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### sendLinkFeed(...)\n\n```typescript\nsendLinkFeed(options: { title: string; description: string; image_url: string; image_link_url: string; button_title: string; }) => Promise<{ value: string; }>\n```\n\n| Param | Type |\n| ------------- | --------------------------------------------------------------------------------------------------------------------- |\n| **`options`** | { title: string; description: string; image_url: string; image_link_url: string; button_title: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n{ value: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\nOptions |\n\n**Returns:** Promise<{ id?: number; }>\n\n--------------------\n\n\n### Interfaces\n\n\n#### Options\n\n| Prop | Type |\n| -------------- | ------------------- |\n| **`title`** | string |\n| **`url`** | string |\n| **`filename`** | string |\n| **`mimetype`** | string |\n\n
\n[](https://discord.com/invite/VnYRvBfgA6)\n![\"Discord\"](\"https://img.shields.io/discord/912707985829163099?color=%237289DA&label=Discord\")
\n[](https://www.npmjs.com/package/@capgo/capacitor-updater)\n[](https://GitHub.com/Cap-go/capacitor-updater/commit/)\n[](https://good-labs.github.io/greater-good-affirmation)\n[](https://sonarcloud.io/summary/new_code?id=Cap-go_capacitor-updater)\n[](https://sonarcloud.io/summary/new_code?id=Cap-go_capacitor-updater)\n[](https://sonarcloud.io/summary/new_code?id=Cap-go_capacitor-updater)\n[](https://sonarcloud.io/summary/new_code?id=Cap-go_capacitor-updater)\n[](https://sonarcloud.io/summary/new_code?id=Cap-go_capacitor-updater)\n[](https://sonarcloud.io/summary/new_code?id=Cap-go_capacitor-updater)\n[](https://sonarcloud.io/summary/new_code?id=Cap-go_capacitor-updater)\n[](https://console.algora.io/org/Capgo/bounties?status=open)\n[](https://console.algora.io/org/Capgo/bounties?status=completed)\n\nUpdate Ionic Capacitor apps without App/Play Store review (Code-push / hot-code updates).\n\nYou have 3 ways possible :\n- Use [capgo.app](https://capgo.app) a full featured auto update system in 5 min Setup, to manage version, update, revert and see stats.\n- Use your own server update with auto update system\n- Use manual methods to zip, upload, download, from JS to do it when you want.","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/Cap-go_capacitor-updater.md","loc":{"lines":{"from":1,"to":23}}}}],["5fd7042b-0ad0-4f7f-9f9e-24721e0e4d8d",{"pageContent":"## Community\nJoin the [discord](https://discord.gg/VnYRvBfgA6) to get help.\n\n## Documentation\nI maintain a more user friendly and complete [documentation here](https://capgo.app/docs/).\n\n## Installation\n\n```bash\nnpm install @capgo/capacitor-updater\nnpx cap sync\n```\n\n## Auto-update setup\n\nCreate your account in [capgo.app](https://capgo.app) and get your [API key](https://capgo.app/app/apikeys)\n- Login to CLI `npx @capgo/cli@latest init API_KEY`\nAnd follow the steps by step to setup your app.\n\nSee more there in the [Auto update documentation](https://capgo.app/docs/plugin/auto-update).\n\n\n## Manual setup\n\nDownload update distribution zipfiles from a custom url. Manually control the entire update process.\n\n- Edit your `capacitor.config.json` like below, set `autoUpdate` to false.\n```json\n// capacitor.config.json\n{\n\t\"appId\": \"**.***.**\",\n\t\"appName\": \"Name\",\n\t\"plugins\": {\n\t\t\"CapacitorUpdater\": {\n\t\t\t\"autoUpdate\": false,\n\t\t}\n\t}\n}\n```\n- Add to your main code\n```javascript\n import { CapacitorUpdater } from '@capgo/capacitor-updater'\n CapacitorUpdater.notifyAppReady()\n```\nThis informs Capacitor Updator that the current update bundle has loaded succesfully. Failing to call this method will cause your application to be rolled back to the previously successful version (or built-in bundle).\n- Add this to your application.\n```javascript\n const version = await CapacitorUpdater.download({\n url: 'https://github.com/Cap-go/demo-app/releases/download/0.0.4/dist.zip',\n })\n await CapacitorUpdater.set(version); // sets the new version, and reloads the app\n```\n- Failed updates will automatically roll back to the last successful version.\n- Example: Using App-state to control updates, with SplashScreen:\nYou might also consider performing auto-update when application state changes, and using the Splash Screen to improve user experience.\n```javascript\n import { CapacitorUpdater, VersionInfo } from '@capgo/capacitor-updater'\n import { SplashScreen } from '@capacitor/splash-screen'\n import { App } from '@capacitor/app'\n\n let version: VersionInfo;\n App.addListener('appStateChange', async (state) => {\n if (state.isActive) {\n // Ensure download occurs while the app is active, or download may fail\n version = await CapacitorUpdater.download({\n url: 'https://github.com/Cap-go/demo-app/releases/download/0.0.4/dist.zip',\n })\n }\n\n if (!state.isActive && version) {\n // Activate the update when the application is sent to background\n SplashScreen.show()\n try {\n await CapacitorUpdater.set(version);\n // At this point, the new version should be active, and will need to hide the splash screen\n } catch () {\n SplashScreen.hide() // Hide the splash screen again if something went wrong\n }\n }\n })\n\n```\n\nTIP: If you prefer a secure and automated way to update your app, you can use [capgo.app](https://capgo.app) - a full-featured, auto update system.\n\n### Packaging `dist.zip` update bundles","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/Cap-go_capacitor-updater.md","loc":{"lines":{"from":26,"to":111}}}}],["f238be29-759e-4aed-a250-691c3f9a8e12",{"pageContent":"### Packaging `dist.zip` update bundles\n\nCapacitor Updator works by unzipping a compiled app bundle to the native device filesystem. Whatever you choose to name the file you upload/download from your release/update server URL (via either manual or automatic updating), this `.zip` bundle must meet the following requirements:\n\n- The zip file should contain the full contents of your production Capacitor build output folder, usually `{project directory}/dist/` or `{project directory}/www/`. This is where `index.html` will be located, and it should also contain all bundled JavaScript, CSS, and web resources necessary for your app to run.\n- Do not password encrypt the bundle zip file, or it will fail to unpack.\n- Make sure the bundle does not contain any extra hidden files or folders, or it may fail to unpack.\n\n## API\n\nPromise<{ bundle: BundleInfo; }>\n\n--------------------\n\n\n### download(...)\n\n```typescript\ndownload(options: { url: string; version: string; sessionKey?: string; checksum?: string; }) => Promise{ url: string; version: string; sessionKey?: string; checksum?: string; } |\n\n**Returns:** Promise<BundleInfo>\n\n--------------------\n\n\n### next(...)\n\n```typescript\nnext(options: { id: string; }) => Promise{ id: string; } |\n\n**Returns:** Promise<BundleInfo>\n\n--------------------\n\n\n### set(...)\n\n```typescript\nset(options: { id: string; }) => Promise{ id: string; } |\n\n--------------------\n\n\n### delete(...)\n\n```typescript\ndelete(options: { id: string; }) => Promise{ id: string; } |\n\n--------------------\n\n\n### list()\n\n```typescript\nlist() => Promise<{ bundles: BundleInfo[]; }>\n```\n\nGet all locally downloaded bundles in your app\n\n**Returns:** Promise<{ bundles: BundleInfo[]; }>\n\n--------------------\n\n\n### reset(...)\n\n```typescript\nreset(options?: { toLastSuccessful?: boolean | undefined; } | undefined) => Promise{ toLastSuccessful?: boolean; } |\n\n--------------------\n\n\n### current()\n\n```typescript\ncurrent() => Promise<{ bundle: BundleInfo; native: string; }>\n```\n\nGet the current bundle, if none are set it returns `builtin`, currentNative is the original bundle installed on the device\n\n**Returns:** Promise<{ bundle: BundleInfo; native: string; }>\n\n--------------------\n\n\n### reload()\n\n```typescript\nreload() => Promise{ delayConditions: DelayCondition[]; } | are the {@link DelayCondition} list to set |\n\n**Since:** 4.3.0\n\n--------------------\n\n\n### cancelDelay()\n\n```typescript\ncancelDelay() => PromisePromise<latestVersion>\n\n**Since:** 4.0.0\n\n--------------------\n\n\n### setChannel(...)\n\n```typescript\nsetChannel(options: SetChannelOptions) => PromiseSetChannelOptions | is the {@link SetChannelOptions} channel to set |\n\n**Returns:** Promise<channelRes>\n\n**Since:** 4.7.0\n\n--------------------\n\n\n### getChannel()\n\n```typescript\ngetChannel() => PromisePromise<getChannelRes>\n\n**Since:** 4.8.0\n\n--------------------\n\n\n### setCustomId(...)\n\n```typescript\nsetCustomId(options: SetCustomIdOptions) => PromiseSetCustomIdOptions | is the {@link SetCustomIdOptions} customId to set |\n\n**Since:** 4.9.0\n\n--------------------\n\n\n### addListener('download', ...)\n\n```typescript\naddListener(eventName: \"download\", listenerFunc: DownloadChangeListener) => Promise'download' |\n| **`listenerFunc`** | DownloadChangeListener |\n\n**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle\n\n**Since:** 2.0.11\n\n--------------------\n\n\n### addListener('noNeedUpdate', ...)\n\n```typescript\naddListener(eventName: \"noNeedUpdate\", listenerFunc: NoNeedListener) => Promise'noNeedUpdate' |\n| **`listenerFunc`** | NoNeedListener |\n\n**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle\n\n**Since:** 4.0.0\n\n--------------------\n\n\n### addListener('updateAvailable', ...)\n\n```typescript\naddListener(eventName: \"updateAvailable\", listenerFunc: UpdateAvailabledListener) => Promise'updateAvailable' |\n| **`listenerFunc`** | UpdateAvailabledListener |\n\n**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle\n\n**Since:** 4.0.0\n\n--------------------\n\n\n### addListener('downloadComplete', ...)\n\n```typescript\naddListener(eventName: \"downloadComplete\", listenerFunc: DownloadCompleteListener) => Promise'downloadComplete' |\n| **`listenerFunc`** | DownloadCompleteListener |\n\n**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle\n\n**Since:** 4.0.0\n\n--------------------\n\n\n### addListener('majorAvailable', ...)\n\n```typescript\naddListener(eventName: \"majorAvailable\", listenerFunc: MajorAvailableListener) => Promise'majorAvailable' |\n| **`listenerFunc`** | MajorAvailableListener |\n\n**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle\n\n**Since:** 2.3.0\n\n--------------------\n\n\n### addListener('updateFailed', ...)\n\n```typescript\naddListener(eventName: \"updateFailed\", listenerFunc: UpdateFailedListener) => Promise'updateFailed' |\n| **`listenerFunc`** | UpdateFailedListener |\n\n**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle\n\n**Since:** 2.3.0\n\n--------------------\n\n\n### addListener('downloadFailed', ...)\n\n```typescript\naddListener(eventName: \"downloadFailed\", listenerFunc: DownloadFailedListener) => Promise'downloadFailed' |\n| **`listenerFunc`** | DownloadFailedListener |\n\n**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle\n\n**Since:** 4.0.0\n\n--------------------\n\n\n### addListener('appReloaded', ...)\n\n```typescript\naddListener(eventName: \"appReloaded\", listenerFunc: AppReloadedListener) => Promise'appReloaded' |\n| **`listenerFunc`** | AppReloadedListener |\n\n**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle\n\n**Since:** 4.3.0\n\n--------------------\n\n\n### addListener('appReady', ...)\n\n```typescript\naddListener(eventName: \"appReady\", listenerFunc: AppReadyListener) => Promise'appReady' |\n| **`listenerFunc`** | AppReadyListener |\n\n**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle\n\n**Since:** 5.1.0\n\n--------------------\n\n\n### getBuiltinVersion()\n\n```typescript\ngetBuiltinVersion() => Promise<{ version: string; }>\n```\n\nGet the native app version or the builtin version if set in config\n\n**Returns:** Promise<{ version: string; }>\n\n**Since:** 5.2.0\n\n--------------------\n\n\n### getDeviceId()\n\n```typescript\ngetDeviceId() => Promise<{ deviceId: string; }>\n```\n\nGet unique ID used to identify device (sent to auto update server)\n\n**Returns:** Promise<{ deviceId: string; }>\n\n--------------------\n\n\n### getPluginVersion()\n\n```typescript\ngetPluginVersion() => Promise<{ version: string; }>\n```\n\nGet the native Capacitor Updater plugin version (sent to auto update server)\n\n**Returns:** Promise<{ version: string; }>\n\n--------------------","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/Cap-go_capacitor-updater.md","loc":{"lines":{"from":513,"to":605}}}}],["19ab3822-8c64-4550-a21a-1d2ea2cd90a0",{"pageContent":"**Returns:** Promise<{ version: string; }>\n\n--------------------\n\n\n### isAutoUpdateEnabled()\n\n```typescript\nisAutoUpdateEnabled() => Promise<{ enabled: boolean; }>\n```\n\nGet the state of auto update config. This will return `false` in manual mode.\n\n**Returns:** Promise<{ enabled: boolean; }>\n\n--------------------\n\n\n### removeAllListeners()\n\n```typescript\nremoveAllListeners() => Promisestring |\n| **`version`** | string |\n| **`downloaded`** | string |\n| **`checksum`** | string |\n| **`status`** | BundleStatus |\n\n\n#### DelayCondition\n\n| Prop | Type | Description |\n| ----------- | --------------------------------------------------------- | ---------------------------------------- |\n| **`kind`** | DelayUntilNext | Set up delay conditions in setMultiDelay |\n| **`value`** | string | |\n\n\n#### latestVersion\n\n| Prop | Type | Description | Since |\n| ---------------- | -------------------- | ----------------------- | ----- |\n| **`version`** | string | Res of getLatest method | 4.0.0 |\n| **`major`** | boolean | | |\n| **`message`** | string | | |\n| **`sessionKey`** | string | | |\n| **`error`** | string | | |\n| **`old`** | string | | |\n| **`url`** | string | | |\n\n\n#### channelRes\n\n| Prop | Type | Description | Since |\n| ------------- | ------------------- | ----------------------------- | ----- |\n| **`status`** | string | Current status of set channel | 4.7.0 |\n| **`error`** | any | | |\n| **`message`** | any | | |\n\n\n#### SetChannelOptions\n\n| Prop | Type |\n| ----------------------- | -------------------- |\n| **`channel`** | string |\n| **`triggerAutoUpdate`** | boolean |\n\n\n#### getChannelRes","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/Cap-go_capacitor-updater.md","loc":{"lines":{"from":605,"to":688}}}}],["2e67d3dc-5703-48ff-877e-b9d57cecb4aa",{"pageContent":"#### getChannelRes\n\n| Prop | Type | Description | Since |\n| -------------- | -------------------- | ----------------------------- | ----- |\n| **`channel`** | string | Current status of get channel | 4.8.0 |\n| **`error`** | any | | |\n| **`message`** | any | | |\n| **`status`** | string | | |\n| **`allowSet`** | boolean | | |\n\n\n#### SetCustomIdOptions\n\n| Prop | Type |\n| -------------- | ------------------- |\n| **`customId`** | string |\n\n\n#### PluginListenerHandle\n\n| Prop | Type |\n| ------------ | ----------------------------------------- |\n| **`remove`** | () => Promise<void> |\n\n\n#### DownloadEvent\n\n| Prop | Type | Description | Since |\n| ------------- | ------------------------------------------------- | ---------------------------------------------- | ----- |\n| **`percent`** | number | Current status of download, between 0 and 100. | 4.0.0 |\n| **`bundle`** | BundleInfo | | |\n\n\n#### noNeedEvent\n\n| Prop | Type | Description | Since |\n| ------------ | ------------------------------------------------- | ---------------------------------------------- | ----- |\n| **`bundle`** | BundleInfo | Current status of download, between 0 and 100. | 4.0.0 |\n\n\n#### updateAvailableEvent\n\n| Prop | Type | Description | Since |\n| ------------ | ------------------------------------------------- | ---------------------------------------------- | ----- |\n| **`bundle`** | BundleInfo | Current status of download, between 0 and 100. | 4.0.0 |\n\n\n#### DownloadCompleteEvent\n\n| Prop | Type | Description | Since |\n| ------------ | ------------------------------------------------- | ------------------------------------ | ----- |\n| **`bundle`** | BundleInfo | Emit when a new update is available. | 4.0.0 |\n\n\n#### MajorAvailableEvent\n\n| Prop | Type | Description | Since |\n| ------------- | ------------------- | ------------------------------------------ | ----- |\n| **`version`** | string | Emit when a new major bundle is available. | 4.0.0 |\n\n\n#### UpdateFailedEvent","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/Cap-go_capacitor-updater.md","loc":{"lines":{"from":688,"to":749}}}}],["ca3ee329-d2d4-46b0-b86e-d2226ff8e69a",{"pageContent":"#### UpdateFailedEvent\n\n| Prop | Type | Description | Since |\n| ------------ | ------------------------------------------------- | ------------------------------------- | ----- |\n| **`bundle`** | BundleInfo | Emit when a update failed to install. | 4.0.0 |\n\n\n#### DownloadFailedEvent\n\n| Prop | Type | Description | Since |\n| ------------- | ------------------- | -------------------------- | ----- |\n| **`version`** | string | Emit when a download fail. | 4.0.0 |\n\n\n#### AppReadyEvent\n\n| Prop | Type | Description | Since |\n| ------------ | ------------------------------------------------- | -------------------------------- | ----- |\n| **`bundle`** | BundleInfo | Emit when a app is ready to use. | 5.2.0 |\n| **`status`** | string | | |\n\n\n### Type Aliases\n\n\n#### BundleStatus\n\n\"success\" | \"error\" | \"pending\" | \"downloading\"\n\n\n#### DelayUntilNext\n\n\"background\" | \"kill\" | \"nativeVersion\" | \"date\"\n\n\n#### DownloadChangeListener\n\n(state: DownloadEvent): void\n\n\n#### NoNeedListener\n\n(state: noNeedEvent): void\n\n\n#### UpdateAvailabledListener\n\n(state: updateAvailableEvent): void\n\n\n#### DownloadCompleteListener\n\n(state: DownloadCompleteEvent): void\n\n\n#### MajorAvailableListener\n\n(state: MajorAvailableEvent): void\n\n\n#### UpdateFailedListener\n\n(state: UpdateFailedEvent): void\n\n\n#### DownloadFailedListener\n\n(state: DownloadFailedEvent): void\n\n\n#### AppReloadedListener\n\n(state: void): void\n\n\n#### AppReadyListener\n\n(state: AppReadyEvent): void\n\n{ value: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### minimize()\n\n```typescript\nminimize() => PromisePromise<any>\n\n--------------------\n\nany\n\n--------------------\n\n\n### unregisterSmsReceiver()\n\n```typescript\nunregisterSmsReceiver() => any\n```\n\n**Returns:** any\n\n--------------------\n\n\n### startSmsUserConsent()\n\n```typescript\nstartSmsUserConsent() => Promise<{ otp: string; }>\n```\n\n**Returns:** Promise<{ otp: string; }>\n\n--------------------\n\n{ id: string; path: string; } |\n\n**Returns:** any\n\n--------------------\n\n\n### play(...)\n\n```typescript\nplay(options: { id: string; }) => any\n```\n\n| Param | Type |\n| ------------- | ---------------------------- |\n| **`options`** | { id: string; } |\n\n**Returns:** any\n\n--------------------\n\n{ value: string; } | echo params |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### loadDatabase(...)\n\n```typescript\nloadDatabase(options: { dbPath?: string; dbName: string; }) => Promise<{ data: string | boolean; }>\n```\n\n加载数据库\n\n| Param | Type | Description |\n| ------------- | ------------------------------------------------- | ----------------------------- |\n| **`options`** | { dbPath?: string; dbName: string; } | dbPath: 数据库文件位置 dbName: 数据文件名 |\n\n**Returns:** Promise<{ data: string | boolean; }>\n\n--------------------\n\n\n### queryForObject(...)\n\n```typescript\nqueryForObject(options: SQLiteQueryOptions) => Promise<{ data: any; }>\n```\n\n查询单个对象\n\n| Param | Type | Description |\n| ------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |\n| **`options`** | SQLiteQueryOptions | 查询参数 {@link SQLiteQueryOptions} |\n\n**Returns:** Promise<{ data: any; }>\n\n--------------------\n\n\n### queryForList(...)\n\n```typescript\nqueryForList(options: SQLiteQueryOptions) => Promise<{ data: any[]; }>\n```\n\n查询列表\n\n| Param | Type | Description |\n| ------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |\n| **`options`** | SQLiteQueryOptions | 查询参数 {@link SQLiteQueryOptions} |\n\n**Returns:** Promise<{ data: any[]; }>\n\n--------------------\n\n\n### insertEntity(...)\n\n```typescript\ninsertEntity(options: SQLiteEnitytOptions) => Promise<{ data: string | boolean; }>\n```\n\n保存实体","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/parselife_capacitor-sqlite.md","loc":{"lines":{"from":1,"to":104}}}}],["e94b6a9e-83fd-4722-8a8c-bca3236fddaf",{"pageContent":"```typescript\ninsertEntity(options: SQLiteEnitytOptions) => Promise<{ data: string | boolean; }>\n```\n\n保存实体\n\n| Param | Type | Description |\n| ------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |\n| **`options`** | SQLiteEnitytOptions | 实体参数 {@link SQLiteEnitytOptions} |\n\n**Returns:** Promise<{ data: string | boolean; }>\n\n--------------------\n\n\n### updateEntity(...)\n\n```typescript\nupdateEntity(options: SQLiteEntityUpdateOptions) => Promise<{ data: string | boolean; }>\n```\n\n更新实体\n\n| Param | Type | Description |\n| ------------- | ------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |\n| **`options`** | SQLiteEntityUpdateOptions | 更新实体参数 {@link SQLiteEntityUpdateOptions} |\n\n**Returns:** Promise<{ data: string | boolean; }>\n\n--------------------\n\n\n### delEntity(...)\n\n```typescript\ndelEntity(options: SQLiteEntityUpdateOptions) => Promise<{ data: string | boolean; }>\n```\n\n删除实体\n\n| Param | Type | Description |\n| ------------- | ------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |\n| **`options`** | SQLiteEntityUpdateOptions | 更新实体参数 {@link SQLiteEntityUpdateOptions} |\n\n**Returns:** Promise<{ data: string | boolean; }>\n\n--------------------\n\n\n### Interfaces\n\n\n#### SQLiteQueryOptions\n\n数据库查询对象","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/parselife_capacitor-sqlite.md","loc":{"lines":{"from":104,"to":158}}}}],["b16e8ccb-d18b-4920-b30f-15408dc20df9",{"pageContent":"--------------------\n\n\n### Interfaces\n\n\n#### SQLiteQueryOptions\n\n数据库查询对象\n\n| Prop | Type | Description |\n| ------------------- | --------------------- | ------------------------------- |\n| **`tblName`** | string | 操作表名 |\n| **`selection`** | string | 查询条件 eg: a=? and b like '%?' |\n| **`selectionArgs`** | string[] | 查询的参数 替换 selection 中的 ? |\n| **`returnColumns`** | string[] | 返回的列名 为空则返回所有 |\n| **`groupBy`** | string | groupby 语句 eg: name |\n| **`having`** | string | having 语句 eg: sum(area) > 20 |\n| **`orderBy`** | string | order by 语句 eg: time desc |\n| **`limit`** | number | limit 数量 eg: 10 |\n\n\n#### SQLiteEnitytOptions\n\n数据库实体保存对象\n\n| Prop | Type | Description |\n| ------------- | --------------------------------- | ------------------------------------------------------------------- |\n| **`tblName`** | string | 操作的表名 |\n| **`columns`** | SQLiteEntityColumn[] | 保存的数据列 {@link SQLiteEntityColumn} |\n\n\n#### SQLiteEntityColumn\n\n数据库实体数据列\n\n| Prop | Type | Description |\n| -------------- | ---------------------------------------- | ------------------ |\n| **`name`** | string | 字段名称 |\n| **`value`** | string \\| number \\| boolean | 字段值 |\n| **`nullable`** | boolean | 是否允许为null 默认 false |\n\n\n#### SQLiteEntityUpdateOptions\n\n实体更新对象\n\n| Prop | Type | Description |\n| --------------------- | --------------------------------- | ------------------------------------------------------------------- |\n| **`tblName`** | string | 操作的表名 |\n| **`columns`** | SQLiteEntityColumn[] | 保存的数据列 {@link SQLiteEntityColumn} |\n| **`whereClause`** | string | where 条件 eg: id=? |\n| **`whereClauseArgs`** | string[] | where 条件参数 ? 的值 |\n\n\n \n\n\nIn-app Purchases Made Easy\n\n## Install\n\n```bash\nnpm install native-purchases\nnpx cap sync\n```\n\n## Android\n\nAdd this to manifest\n\n```xml\nany\n\n--------------------\n\n\n### purchaseProduct(...)\n\n```typescript\npurchaseProduct(options: { productIdentifier: string; planIdentifier?: string; productType?: PURCHASE_TYPE; quantity?: number; }) => any\n```\n\nStarted purchase process for the given product.\n\n| Param | Type | Description |\n| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- |\n| **`options`** | { productIdentifier: string; planIdentifier?: string; productType?: PURCHASE_TYPE; quantity?: number; } | - The product to purchase |\n\n**Returns:** any\n\n--------------------\n\n\n### getProducts(...)\n\n```typescript\ngetProducts(options: { productIdentifiers: string[]; planIdentifier?: string; productType?: PURCHASE_TYPE; }) => any\n```\n\nGets the product info associated with a list of product identifiers.\n\n| Param | Type | Description |\n| ------------- | --------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |\n| **`options`** | { productIdentifiers: {}; planIdentifier?: string; productType?: PURCHASE_TYPE; } | - The product identifiers you wish to retrieve information for |\n\n**Returns:** any\n\n--------------------\n\n\n### isBillingSupported()\n\n```typescript\nisBillingSupported() => any\n```\n\nCheck if billing is supported for the current device.\n\n**Returns:** any\n\n--------------------","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/Cap-go_native-purchases.md","loc":{"lines":{"from":1,"to":99}}}}],["8a716b59-59ba-41d1-a110-47b67753b3d9",{"pageContent":"Check if billing is supported for the current device.\n\n**Returns:** any\n\n--------------------\n\n\n### getPluginVersion()\n\n```typescript\ngetPluginVersion() => any\n```\n\nGet the native Capacitor plugin version\n\n**Returns:** any\n\n--------------------\n\n\n### Interfaces\n\n\n#### CustomerInfo","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/Cap-go_native-purchases.md","loc":{"lines":{"from":99,"to":122}}}}],["44815bca-d05d-4bb1-87f4-05e2f096189f",{"pageContent":"| Prop | Type | Description |\n| ------------------------------------ | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| **`activeSubscriptions`** | [string] | Set of active subscription skus |\n| **`allPurchasedProductIdentifiers`** | [string] | Set of purchased skus, active and inactive |\n| **`nonSubscriptionTransactions`** | {} | Returns all the non-subscription a user has made. The are ordered by purchase date in ascending order. |\n| **`latestExpirationDate`** | string \\| null | The latest expiration date of all purchased skus |\n| **`firstSeen`** | string | The date this user was first seen in RevenueCat. |","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/Cap-go_native-purchases.md","loc":{"lines":{"from":124,"to":130}}}}],["4ee382c0-f9a3-406c-a02f-a3b792e3e1b4",{"pageContent":"| **`originalAppUserId`** | string | The original App User Id recorded for this user. |\n| **`requestDate`** | string | Date when this info was requested |\n| **`originalApplicationVersion`** | string \\| null | Returns the version number for the version of the application when the user bought the app. Use this for grandfathering users when migrating to subscriptions. This corresponds to the value of CFBundleVersion (in iOS) in the Info.plist file when the purchase was originally made. This is always null in Android |\n| **`originalPurchaseDate`** | string \\| null | Returns the purchase date for the version of the application when the user bought the app. Use this for grandfathering users when migrating to subscriptions. |\n| **`managementURL`** | string \\| null | URL to manage the active subscription of the user. If this user has an active iOS subscription, this will point to the App Store, if the user has an active Play Store subscription it will point there. If there are no active subscriptions it will be null. If there are multiple for different platforms, it will point to the device store. |","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/Cap-go_native-purchases.md","loc":{"lines":{"from":131,"to":135}}}}],["4b44faa2-f556-4db4-a2c9-9456a6662bb6",{"pageContent":"#### Transaction\n\n| Prop | Type | Description |\n| ------------------- | ------------------- | -------------------------------------------- |\n| **`transactionId`** | string | RevenueCat Id associated to the transaction. |\n\n\n#### Product\n\n| Prop | Type | Description |\n| --------------------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------ |\n| **`identifier`** | string | Product Id. |\n| **`description`** | string | Description of the product. |\n| **`title`** | string | Title of the product. |\n| **`price`** | number | Price of the product in the local currency. |\n| **`priceString`** | string | Formatted price of the item, including its currency sign, such as €3.99. |\n| **`currencyCode`** | string | Currency code for price and original price. |\n| **`currencySymbol`** | string | Currency symbol for price and original price. |\n| **`isFamilyShareable`** | boolean | Boolean indicating if the product is sharable with family |\n| **`subscriptionGroupIdentifier`** | string | Group identifier for the product. |\n| **`subscriptionPeriod`** | SubscriptionPeriod | The Product subcription group identifier. |\n| **`introductoryPrice`** | SKProductDiscount \\| null | The Product introductory Price. |\n| **`discounts`** | {} | The Product discounts list. |\n\n\n#### SubscriptionPeriod","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/Cap-go_native-purchases.md","loc":{"lines":{"from":138,"to":163}}}}],["393fa8b3-f9c5-4686-8a08-8eeb8e5af959",{"pageContent":"#### SubscriptionPeriod\n\n| Prop | Type | Description |\n| ------------------- | ------------------- | --------------------------------------- |\n| **`numberOfUnits`** | number | The Subscription Period number of unit. |\n| **`unit`** | number | The Subscription Period unit. |\n\n\n#### SKProductDiscount\n\n| Prop | Type | Description |\n| ------------------------ | ----------------------------------------------------------------- | ------------------------------------------------------------------------ |\n| **`identifier`** | string | The Product discount identifier. |\n| **`type`** | number | The Product discount type. |\n| **`price`** | number | The Product discount price. |\n| **`priceString`** | string | Formatted price of the item, including its currency sign, such as €3.99. |\n| **`currencySymbol`** | string | The Product discount currency symbol. |\n| **`currencyCode`** | string | The Product discount currency code. |\n| **`paymentMode`** | number | The Product discount paymentMode. |\n| **`numberOfPeriods`** | number | The Product discount number Of Periods. |\n| **`subscriptionPeriod`** | SubscriptionPeriod | The Product discount subscription period. |\n\n\n### Enums\n\n\n#### PURCHASE_TYPE\n\n| Members | Value | Description |\n| ----------- | -------------------- | ---------------------------------- |\n| **`INAPP`** | \"inapp\" | A type of SKU for in-app products. |\n| **`SUBS`** | \"subs\" | A type of SKU for subscriptions. |\n\n![](\"https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png\")
Capacitor FCM
\n@capacitor-community/fcm
\n Capacitor community plugin for enabling FCM capabilities\n
\n\n\n ![](\"https://img.shields.io/maintenance/yes/2022?style=flat-square\")
![](\"https://img.shields.io/npm/l/@capacitor-community/fcm?style=flat-square\")
\n ![](\"https://img.shields.io/npm/dw/@capacitor-community/fcm?style=flat-square\")
![](\"https://img.shields.io/npm/v/@capacitor-community/fcm?style=flat-square\")
![](\"https://img.shields.io/badge/all%20contributors-23-orange?style=flat-square\"){kind=icon}
\n \n ![](\"https://static.intenseloop.com/assets/logo-512x512.png\"){kind=logo} \n \n | \n \n \n Intenseloop\n \n | \n
![\"Stew\"/](\"https://avatars1.githubusercontent.com/u/719763?v=4?s=75\") Stew 💻 📖 | \n ![\"Daniel](\"https://avatars2.githubusercontent.com/u/20153661?v=4?s=75\") Daniel Pereira 💻 📖 | \n ![\"Priyank](\"https://avatars3.githubusercontent.com/u/5585797?v=4?s=75\") Priyank Patel 💻 | \n ![\"Nikolas\"/](\"https://avatars1.githubusercontent.com/u/1230033?v=4?s=75\") Nikolas 🚧 | \n ![\"Ben](\"https://avatars3.githubusercontent.com/u/3756309?v=4?s=75\") Ben Schattinger 💻 | \n
![\"James](\"https://avatars2.githubusercontent.com/u/175909?v=4?s=75\") James Manners 💻 | \n ![\"Borja](\"https://avatars3.githubusercontent.com/u/2467193?v=4?s=75\") Borja Rodríguez 🚧 | \n ![\"Karrlllis\"/](\"https://avatars1.githubusercontent.com/u/37330643?v=4?s=75\") Karrlllis 📖 | ","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/capacitor-community_fcm.md","loc":{"lines":{"from":217,"to":232}}}}],["d54b50a4-6b31-48c5-ae89-8fe0f47f570a",{"pageContent":"![\"jamesmah\"/](\"https://avatars0.githubusercontent.com/u/21981049?v=4?s=75\") jamesmah 💻 | \n ![\"Josh](\"https://avatars3.githubusercontent.com/u/39473?v=4?s=75\") Josh Sharpe 🚧 | \n
![\"Mantas](\"https://avatars.githubusercontent.com/u/9675250?v=4?s=75\") Mantas Šimkūnas 💻 📖 | \n ![\"Olivier](\"https://avatars.githubusercontent.com/u/12254953?v=4?s=75\") Olivier Overstraete 🚧 | \n ![\"Hemang](\"https://avatars.githubusercontent.com/u/13018570?v=4?s=75\") Hemang Kumar 💻 🚧 | \n ![\"Luca](\"https://avatars.githubusercontent.com/u/3253920?v=4?s=75\") Luca Ban 📖 | \n ![\"Alex](\"https://avatars.githubusercontent.com/u/5904472?v=4?s=75\") Alex Griffith 💻 🚧 | \n
![\"bdirito\"/](\"https://avatars.githubusercontent.com/u/8117238?v=4?s=75\") bdirito 🚧 | ","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/capacitor-community_fcm.md","loc":{"lines":{"from":233,"to":244}}}}],["ed4a922a-0031-4b1f-ba9c-7248c51a9282",{"pageContent":"![\"Ryan\"/](\"https://avatars.githubusercontent.com/u/17585549?v=4?s=75\") Ryan 🚧 | \n ![\"Josué](\"https://avatars.githubusercontent.com/u/12968781?v=4?s=75\") Josué Moreno 💻 | \n ![\"Marc\"/](\"https://avatars.githubusercontent.com/u/8985933?v=4?s=75\") Marc 🚧 | \n ![\"Florian](\"https://avatars.githubusercontent.com/u/1215256?v=4?s=75\") Florian Gyger 💻 | \n
![\"jcesarmobile\"/](\"https://avatars.githubusercontent.com/u/1637892?v=4?s=75\") jcesarmobile 💬 📖 🚧 | \n ![\"Rami](\"https://avatars.githubusercontent.com/u/38646828?v=4?s=75\") Rami Khafagi 💻 | \n ![\"Bittor](\"https://avatars.githubusercontent.com/u/26112509?v=4?s=75\") Bittor Poza 💻 | \n
HTTP
\n@capacitor-community/http
\n Capacitor community plugin for native HTTP requests, file download/uploads, and cookie management.\n
\n\n\n ![](\"https://img.shields.io/github/workflow/status/capacitor-community/http/Test%20and%20Build%20Plugin?style=flat-square\")
![](\"https://img.shields.io/npm/l/@capacitor-community/http?style=flat-square\")
\n ![](\"https://img.shields.io/npm/dw/@capacitor-community/http?style=flat-square\")
![](\"https://img.shields.io/npm/v/@capacitor-community/http?style=flat-square\")
![\"\"/](\"https://avatars2.githubusercontent.com/u/15234844?v=4?s=100\") Daniel Sogl 📖 | \n ![\"\"/](\"https://avatars3.githubusercontent.com/u/5585797?v=4?s=100\") Priyank Patel 💻 | \n ![\"\"/](\"https://avatars3.githubusercontent.com/u/11214?v=4?s=100\") Max Lynch 💻 | \n ![\"\"/](\"https://avatars3.githubusercontent.com/u/12937991?v=4?s=100\") Falk Schieber 👀 | \n ![\"\"/](\"https://avatars0.githubusercontent.com/u/42151009?v=4?s=100\") Andy Sousa 💻 | \n ![\"\"/](\"https://avatars.githubusercontent.com/u/8182078?v=4?s=100\") Thomas Vidas 💻 🚧 | \n ![\"\"/](\"https://avatars.githubusercontent.com/u/20479454?v=4?s=100\") Emily Curry 💻 | \n
![\"\"/](\"https://avatars.githubusercontent.com/u/88032701?v=4?s=100\") graefenhain 💻 | \n ![\"\"/](\"https://avatars.githubusercontent.com/u/68302?v=4?s=100\") Lee Houghton 🐛 | ","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/capacitor-community_http.md","loc":{"lines":{"from":169,"to":184}}}}],["5222986e-04aa-4e00-bd6f-c7c8fc551f59",{"pageContent":"![\"\"/](\"https://avatars.githubusercontent.com/u/23665008?v=4?s=100\") Felix Schwarzmeier 💻 | \n ![\"\"/](\"https://avatars.githubusercontent.com/u/13223538?v=4?s=100\") Kamil Jakubus 💻 | \n ![\"\"/](\"https://avatars.githubusercontent.com/u/643331?v=4?s=100\") Joe Flateau 🐛 | \n ![\"\"/](\"https://avatars.githubusercontent.com/u/56638143?v=4?s=100\") Frank608 🐛 | \n ![\"\"/](\"https://avatars.githubusercontent.com/u/6298693?v=4?s=100\") Joel Nieto 🐛 | \n
![\"\"/](\"https://avatars.githubusercontent.com/u/580758?v=4?s=100\") ultimate-tester 💻 | \n ![\"\"/](\"https://avatars.githubusercontent.com/u/12704905?v=4?s=100\") Adrian Sanchez 🐛 | \n ![\"\"/](\"https://avatars.githubusercontent.com/u/8333458?v=4?s=100\") milanc 💻 | \n ![\"\"/](\"https://avatars.githubusercontent.com/u/57253976?v=4?s=100\") herecoulbeyourname 💻 | ","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/capacitor-community_http.md","loc":{"lines":{"from":185,"to":195}}}}],["6dfbcca8-7dae-4a58-9899-bec4acfb579a",{"pageContent":"![\"\"/](\"https://avatars.githubusercontent.com/u/10559398?v=4?s=100\") Landschaft 💻 | \n ![\"\"/](\"https://avatars.githubusercontent.com/u/2945329?v=4?s=100\") stonewoodman 🐛 | \n ![\"\"/](\"https://avatars.githubusercontent.com/u/17180632?v=4?s=100\") Héctor Cruz 🐛 | \n
![\"\"/](\"https://avatars.githubusercontent.com/u/15617021?v=4?s=100\") Patrick Bußmann 💻 | \n ![\"\"/](\"https://avatars.githubusercontent.com/u/5323483?v=4?s=100\") Jesper Bjerke 🐛 | \n
Promise<PermissionStatus>\n\n--------------------\n\n\n### requestPermissions()\n\n```typescript\nrequestPermissions() => PromisePromise<PermissionStatus>\n\n--------------------\n\n\n### startListening()\n\n```typescript\nstartListening() => PromisePromise<boolean>\n\n--------------------\n\n\n### stopListening()\n\n```typescript\nstopListening() => PromisePromise<boolean>\n\n--------------------\n\n\n### write(...)\n\n```typescript\nwrite(data: { message: string; }) => Promise{ message: string; } |\n\n**Returns:** Promise<boolean>\n\n--------------------\n\n\n### addListener('deviceConnectionStatusChanged', ...)\n\n```typescript\naddListener(eventName: 'deviceConnectionStatusChanged', listenerFunc: ({ data }: { data: IDeviceStatus; }) => void) => Promise'deviceConnectionStatusChanged' |\n| **`listenerFunc`** | ({ data }: { data: IDeviceStatus; }) => void |\n\n**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle\n\n--------------------\n\n\n### addListener('deviceDataReceived', ...)\n\n```typescript\naddListener(eventName: 'deviceDataReceived', listenerFunc: ({ data }: { data: IDataReceived; }) => void) => Promise'deviceDataReceived' |\n| **`listenerFunc`** | ({ data }: { data: IDataReceived; }) => void |\n\n**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle\n\n--------------------\n\n\n### addListener('deviceDiscovered', ...)\n\n```typescript\naddListener(eventName: 'deviceDiscovered', listenerFunc: ({ device }: { device: IDevice; }) => void) => Promise'deviceDiscovered' |\n| **`listenerFunc`** | ({ device }: { device: IDevice; }) => void |\n\n**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle\n\n--------------------\n\n\n### getPairedDevices()\n\n```typescript\ngetPairedDevices() => Promise<{ devices: any[]; }>\n```\n\n**Returns:** Promise<{ devices: any[]; }>\n\n--------------------\n\n\n### connect(...)\n\n```typescript\nconnect(data: { deviceId: string; appUUID: string; }) => Promise{ deviceId: string; appUUID: string; } |\n\n**Returns:** Promise<boolean>\n\n--------------------\n\n\n### disconnect()\n\n```typescript\ndisconnect() => PromisePromise<boolean>\n\n--------------------\n\n\n### Interfaces\n\n\n#### PermissionStatus","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/matfire_ionic_bluetooth_classic.md","loc":{"lines":{"from":119,"to":201}}}}],["0879e776-f1c9-498c-9a6c-9797c5ef52ea",{"pageContent":"**Returns:** Promise<boolean>\n\n--------------------\n\n\n### Interfaces\n\n\n#### PermissionStatus\n\n| Prop | Type |\n| --------------- | ----------------------------------------------------------- |\n| **`bluetooth`** | PermissionState |\n| **`location`** | PermissionState |\n\n\n#### PluginListenerHandle\n\n| Prop | Type |\n| ------------ | ----------------------------------------- |\n| **`remove`** | () => Promise<void> |\n\n\n#### IDeviceStatus\n\n| Prop | Type |\n| -------------- | ----------------------------------------------------- |\n| **`deviceId`** | string |\n| **`status`** | DeviceStatus |\n\n\n#### IDataReceived\n\n| Prop | Type |\n| ----------- | ------------------------------------------------- |\n| **`bytes`** | Uint8Array |\n| **`size`** | number |\n\n\n#### Uint8Array\n\nA typed array of 8-bit unsigned integer values. The contents are initialized to 0. If the\nrequested number of bytes could not be allocated an exception is raised.\n\n| Prop | Type | Description |\n| ----------------------- | ----------------------------------------------------------- | ---------------------------------------------------------------------------- |\n| **`BYTES_PER_ELEMENT`** | number | The size in bytes of each element in the array. |\n| **`buffer`** | ArrayBufferLike | The ArrayBuffer instance referenced by the array. |\n| **`byteLength`** | number | The length in bytes of the array. |\n| **`byteOffset`** | number | The offset in bytes of the array. |\n| **`length`** | number | The length of the array. |","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/matfire_ionic_bluetooth_classic.md","loc":{"lines":{"from":201,"to":251}}}}],["b2fd88e4-29bb-4fd2-867b-f1628dbda57f",{"pageContent":"| Method | Signature | Description |\n| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **copyWithin** | (target: number, start: number, end?: number \\| undefined) => this | Returns the this object after copying a section of the array identified by start and end to the same array starting at position target |\n| **every** | (predicate: (value: number, index: number, array: Uint8Array) => unknown, thisArg?: any) => boolean | Determines whether all the members of an array satisfy the specified test. |\n| **fill** | (value: number, start?: number \\| undefined, end?: number \\| undefined) => this | Returns the this object after filling the section identified by start and end with value |\n| **filter** | (predicate: (value: number, index: number, array: Uint8Array) => any, thisArg?: any) => Uint8Array | Returns the elements of an array that meet the condition specified in a callback function. |\n| **find** | (predicate: (value: number, index: number, obj: Uint8Array) => boolean, thisArg?: any) => number \\| undefined | Returns the value of the first element in the array where predicate is true, and undefined otherwise. |","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/matfire_ionic_bluetooth_classic.md","loc":{"lines":{"from":253,"to":259}}}}],["2581ec5b-188f-4c10-a3ba-c517b5a25767",{"pageContent":"| **findIndex** | (predicate: (value: number, index: number, obj: Uint8Array) => boolean, thisArg?: any) => number | Returns the index of the first element in the array where predicate is true, and -1 otherwise. |\n| **forEach** | (callbackfn: (value: number, index: number, array: Uint8Array) => void, thisArg?: any) => void | Performs the specified action for each element in an array. |\n| **indexOf** | (searchElement: number, fromIndex?: number \\| undefined) => number | Returns the index of the first occurrence of a value in an array. |\n| **join** | (separator?: string \\| undefined) => string | Adds all the elements of an array separated by the specified separator string. |\n| **lastIndexOf** | (searchElement: number, fromIndex?: number \\| undefined) => number | Returns the index of the last occurrence of a value in an array. |\n| **map** | (callbackfn: (value: number, index: number, array: Uint8Array) => number, thisArg?: any) => Uint8Array | Calls a defined callback function on each element of an array, and returns an array that contains the results. |\n| **reduce** | (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number) => number | Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. |","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/matfire_ionic_bluetooth_classic.md","loc":{"lines":{"from":260,"to":266}}}}],["ceec0583-491c-44a5-8a56-0df86bade262",{"pageContent":"| **reduce** | (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number, initialValue: number) => number | |\n| **reduce** | <U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: Uint8Array) => U, initialValue: U) => U | Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. |\n| **reduceRight** | (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number) => number | Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. |\n| **reduceRight** | (callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number, initialValue: number) => number | |\n| **reduceRight** | <U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: Uint8Array) => U, initialValue: U) => U | Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. |\n| **reverse** | () => Uint8Array | Reverses the elements in an Array. |\n| **set** | (array: ArrayLike<number>, offset?: number \\| undefined) => void | Sets a value or an array of values. |","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/matfire_ionic_bluetooth_classic.md","loc":{"lines":{"from":267,"to":273}}}}],["c6292543-ed6c-44ba-bfa3-0f8ce8839ab1",{"pageContent":"| **slice** | (start?: number \\| undefined, end?: number \\| undefined) => Uint8Array | Returns a section of an array. |\n| **some** | (predicate: (value: number, index: number, array: Uint8Array) => unknown, thisArg?: any) => boolean | Determines whether the specified callback function returns true for any element of an array. |\n| **sort** | (compareFn?: ((a: number, b: number) => number) \\| undefined) => this | Sorts an array. |\n| **subarray** | (begin?: number \\| undefined, end?: number \\| undefined) => Uint8Array | Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive. |\n| **toLocaleString** | () => string | Converts a number to a string by using the current locale. |\n| **toString** | () => string | Returns a string representation of an array. |\n| **valueOf** | () => Uint8Array | Returns the primitive value of the specified object. |","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/matfire_ionic_bluetooth_classic.md","loc":{"lines":{"from":274,"to":280}}}}],["780210fc-ef38-42e5-ba12-d77fc776456e",{"pageContent":"#### ArrayLike\n\n| Prop | Type |\n| ------------ | ------------------- |\n| **`length`** | number |\n\n\n#### ArrayBufferTypes\n\nAllowed ArrayBuffer types for the buffer of an ArrayBufferView and related Typed Arrays.\n\n| Prop | Type |\n| ----------------- | --------------------------------------------------- |\n| **`ArrayBuffer`** | ArrayBuffer |\n\n\n#### ArrayBuffer\n\nRepresents a raw buffer of binary data, which is used to store data for the\ndifferent typed arrays. ArrayBuffers cannot be read from or written to directly,\nbut can be passed to a typed array or DataView Object to interpret the raw\nbuffer as needed.\n\n| Prop | Type | Description |\n| ---------------- | ------------------- | ------------------------------------------------------------------------------- |\n| **`byteLength`** | number | Read-only. The length of the ArrayBuffer (in bytes). |\n\n| Method | Signature | Description |\n| --------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------- |\n| **slice** | (begin: number, end?: number \\| undefined) => ArrayBuffer | Returns a section of an ArrayBuffer. |\n\n\n#### IDevice\n\n| Prop | Type |\n| ------------- | ------------------- |\n| **`address`** | string |\n| **`name`** | string |\n\n\n### Type Aliases\n\n\n#### PermissionState\n\n'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'\n\n\n#### ArrayBufferLike\n\nArrayBufferTypes[keyof ArrayBufferTypes]\n\n\n### Enums\n\n\n#### DeviceStatus\n\n| Members | Value |\n| ------------------ | -------------- |\n| **`DISCONNECTED`** | 0 |\n| **`CONNECTED`** | 1 |\n| **`CONNECTING`** | 2 |\n\nDropTableOptions | Nombre de la tabla a eliminar |\n\n**Returns:** Promise<DropTableResult>\n\n--------------------\n\n\n### createTable(...)","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/Jbranadev_capacitor-jbrandev-jbsqlutils.md","loc":{"lines":{"from":1,"to":82}}}}],["be215883-c0dd-470c-8bfd-91d4fe9d62d5",{"pageContent":"--------------------\n\n\n### createTable(...)\n\n```typescript\ncreateTable(createtableOptions: CreateTableOptions) => PromiseCreateTableOptions | Definicion de la tabla a crear |\n\n**Returns:** Promise<CreateTableResult>\n\n--------------------\n\n\n### insertInto(...)\n\n```typescript\ninsertInto(insertOptions: InsertOptions) => PromiseInsertOptions | Tabla sobre la cual se realizara el Insert y los Valores a insertar |\n\n**Returns:** Promise<InsertResult>\n\n--------------------\n\n\n### update(...)\n\n```typescript\nupdate(updateOptions: UpdateOptions) => PromiseUpdateOptions | Definición de la tabla a actualizar |\n\n**Returns:** Promise<UpdateResult>\n\n--------------------\n\n\n### delete(...)\n\n```typescript\ndelete(deleteOptions: DeleteOptions) => PromiseDeleteOptions | Definición de la logica a aplicar para eliminar los registros de la tabla proporcionada |\n\n**Returns:** Promise<DeleteResult>\n\n--------------------\n\n\n### select(...)\n\n```typescript\nselectSelectOptions | Define la logica de la sentencia Select a ejecutar |\n\n**Returns:** Promise<{ rows: T[]; }>\n\n--------------------\n\n\n### Interfaces\n\n\n#### DropTableResult\n\nResultado del metodo DropTableIfExist\n\n| Prop | Type | Description |\n| ------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |\n| **`execute`** | boolean | True si la tabla fue eliminada en BD's, False si la tabla no existe en BD's o si sucede algun problema al ejecutar la sentencia SQL. |\n\n\n#### DropTableOptions\n\nOpciones disponibles a envíar en el metodo DropTableIfExist\n\n| Prop | Type | Description |\n| ------------------------ | ------------------------------------------------------------- | -------------------------------------------------------------------------- |\n| **`tableName`** | string | Nombre de la tabla a eliminar |\n| **`propertysConection`** | ConectionOptions | Define las propiedades de conexión a la BD's a la que se pegara JBSqlUtils |\n\n\n#### ConectionOptions\n\nDefine las propiedades de conexión a la BD's a la que se pegara JBSqlUtils","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/Jbranadev_capacitor-jbrandev-jbsqlutils.md","loc":{"lines":{"from":157,"to":201}}}}],["92cf8c2b-13e9-4cc3-b886-5f69ca51a075",{"pageContent":"#### ConectionOptions\n\nDefine las propiedades de conexión a la BD's a la que se pegara JBSqlUtils\n\n| Prop | Type | Description |\n| ------------------ | --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`dataBaseType`** | DataBase | Tipo de BD's a la cual se estara conectando el Modelo, los tipos disponibles son MySQL, SQLServer, PostgreSQL, SQLite. |\n| **`dataBase`** | string | Nombre de la Base de Datos a la que se conectara el modelo. |\n| **`port`** | string | Puerto en el cual se encuentra escuchando la BD's a la cual se pegara JBSqlUtils este campo es obligatorio para conectarse a MySQL, SQLServer o PostgreSQL |\n| **`host`** | string | Host en el cual se encuentra la BD's a la que nos queremos conectar. este campo es obligatorio para conectarse a MySQL, SQLServer o PostgreSQL |\n| **`user`** | string | Usuario con el cual el JBSqlUtils se conectara a la BD's. este campo es obligatorio para conectarse a MySQL, SQLServer o PostgreSQL |\n| **`password`** | string | Contraseña del usuario con el cual JBSqlUtils se conectara a la BD's. este campo es obligatorio para conectarse a MySQL, SQLServer o PostgreSQL |\n\n\n#### CreateTableResult\n\nResultado del metodo createTable\n\n| Prop | Type | Description |\n| ------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------- |\n| **`execute`** | boolean | True si la tabla a sido creada, false si la tabla ya existe en BD's o si sucede un error al momento de ejecutar la sentencia SQL |\n\n\n#### CreateTableOptions\n\nRepresentación de la tabla a crear en BD's a traves del metodo createTable","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/Jbranadev_capacitor-jbrandev-jbsqlutils.md","loc":{"lines":{"from":201,"to":226}}}}],["f34db30b-b45a-4e46-bb85-4ecef102e326",{"pageContent":"#### CreateTableOptions\n\nRepresentación de la tabla a crear en BD's a traves del metodo createTable\n\n| Prop | Type | Description |\n| ------------------------ | ------------------------------------------------------------- | -------------------------------------------------------------------------- |\n| **`tableName`** | string | Nombre de la tabla a crear |\n| **`columnas`** | Column[] | Array de Columnas que tendra la tabla al momento de ser creada en BD's |\n| **`propertysConection`** | ConectionOptions | Define las propiedades de conexión a la BD's a la que se pegara JBSqlUtils |\n\n\n#### Column\n\nRepresentación de una columna a crear en BD's\n\n| Prop | Type | Description |\n| ------------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`name`** | string | Nombre de la columna |\n| **`default_value`** | string | Indica el valor por default que tendra la columna en BD's Es importante que para que este sea efectivo, agregar en las restriccions, la Constraint.DEFAULT. |\n| **`dataTypeSQL`** | DataType | DataType que indica el tipo de dato SQL que almacenara la columna. |\n| **`restriccions`** | Constraint[] | Array que Indica las restricciones SQL que tendra este campo. |\n\n\n#### InsertResult\n\nDefine el resultado de insertar un registro en BD's\n\n| Prop | Type | Description |\n| ----------------- | ------------------- | -------------------------------------------------------------------------- |\n| **`rows_insert`** | number | Cantidad de filas que se han visto afectadas al ejecutar la sentencia SQL. |\n\n\n#### InsertOptions\n\nDefine la tabla sobre la cual se realizara el Insert y los valores a insertar","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/Jbranadev_capacitor-jbrandev-jbsqlutils.md","loc":{"lines":{"from":226,"to":260}}}}],["e955f89f-0a2b-4f88-9f9c-84c6658718e6",{"pageContent":"#### InsertOptions\n\nDefine la tabla sobre la cual se realizara el Insert y los valores a insertar\n\n| Prop | Type | Description |\n| ------------------------ | ------------------------------------------------------------- | -------------------------------------------------------------------------- |\n| **`tableName`** | string | Nombre de la tabla sobre la que se efectuara el Insert |\n| **`values`** | ValuesInsert[] | Array de valores a insertar en la tabla. |\n| **`propertysConection`** | ConectionOptions | Define las propiedades de conexión a la BD's a la que se pegara JBSqlUtils |\n\n\n#### ValuesInsert\n\nDefine el valor a insertar y en que columna\n\n| Prop | Type | Description |\n| --------------- | ------------------- | ------------------------------------------------------------------ |\n| **`columName`** | string | Nombre de la columna en la que se insertara el valor proporcionado |\n| **`value`** | any | Valor a insertar |\n\n\n#### UpdateResult\n\nDefine el resultado de actualizar registros en BD's\n\n| Prop | Type | Description |\n| ----------------- | ------------------- | -------------------------------------------------------------------------- |\n| **`rows_update`** | number | Cantidad de filas que se han visto afectadas al ejecutar la sentencia SQL. |\n\n\n#### UpdateOptions\n\nDefine las columnas que seran actualizadas en la tabla especificada.\n\n| Prop | Type | Description |\n| ------------------------ | ------------------------------------------------------------- | -------------------------------------------------------------------------- |\n| **`tableName`** | string | Nombre de la tabla a actualizar |\n| **`valueUpdate`** | ValueUpdate | Columnas a actualizar |\n| **`propertysConection`** | ConectionOptions | Define las propiedades de conexión a la BD's a la que se pegara JBSqlUtils |\n\n\n#### ValueUpdate\n\nDefine la columna a actualizar con el valor proporcionado en la tabla especificada","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/Jbranadev_capacitor-jbrandev-jbsqlutils.md","loc":{"lines":{"from":260,"to":303}}}}],["0e5d1504-7d2d-4c33-bc54-05f64157c4d0",{"pageContent":"#### ValueUpdate\n\nDefine la columna a actualizar con el valor proporcionado en la tabla especificada\n\n| Prop | Type | Description |\n| -------------------- | --------------------------------------------------- | --------------------------------------------------------------------------------------------- |\n| **`columName`** | string | Nombre de la columna a actualizar |\n| **`value`** | any | Valor a setear en la columna |\n| **`andValueUpdate`** | ValueUpdate | Agrega la capacidad de poder actualizar el valor de otra columna en la misma sentencia Update |\n| **`where`** | Where | Agrega la logica de un filtro where a la actualización de registros en BD's |\n\n\n#### Where\n\nProporciona la logica de una sentencia Where sobre la información que contiene esta interface, añadiendo la capacidad\nde poder filtrar por medio de las sentencias AND, OR, TAKE Y ORDER BY","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/Jbranadev_capacitor-jbrandev-jbsqlutils.md","loc":{"lines":{"from":303,"to":318}}}}],["dd8384e2-68f2-4984-ac61-1ff18c778273",{"pageContent":"| Prop | Type | Description |\n| --------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------- |\n| **`columName`** | string | Nombre de la columna sobre la cual se evaluara la sentencia WHERE |\n| **`operator`** | Operator | Operador sobre el cual se evalura la columna respecto al valor proporcionado |\n| **`value`** | any | Valor contra el que se evaluara la columna |\n| **`and`** | And | Agrega la logica de una sentencia And sobre la información proporcionada. |\n| **`or`** | Or | Agrega la logica de una sentencia Or sobre la información proporcionada. |\n| **`orderBy`** | OrderBy | Tipo de ordenamiento que deseamos se aplique al realizar una sentencia con filtro where |\n| **`take`** | Take | Cantidad maxima de registros a tomar dentro de una sentencia con filtro where |\n| **`openParentecis`** | OpenParentesis | Puede aperturar un parentecis para filtrar de una mejor manera los registros |\n| **`closeParentecis`** | CloseParentesis | Puede cerrar un parentecis para filtrar de una mejor manera los registros |\n\n\n#### And\n\nProporciona la logica de una sentencia And sobre la información que contiene esta interface, añadiendo la capacidad\nde poder filtrar por medio de las sentencias AND, OR, TAKE Y ORDER BY","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/Jbranadev_capacitor-jbrandev-jbsqlutils.md","loc":{"lines":{"from":320,"to":336}}}}],["f5fe51ef-218b-4337-89d3-93fdb1a57257",{"pageContent":"| Prop | Type | Description |\n| --------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------- |\n| **`columName`** | string | Nombre de la columna sobre la cual se evaluara la sentencia AND |\n| **`operator`** | Operator | Operador sobre el cual se evalura la columna respecto al valor proporcionado |\n| **`value`** | any | Valor contra el que se evaluara la columna |\n| **`and`** | And | Agrega la logica de una sentencia And sobre la información proporcionada. |\n| **`or`** | Or | Agrega la logica de una sentencia Or sobre la información proporcionada. |\n| **`orderBy`** | OrderBy | Tipo de ordenamiento que deseamos se aplique al realizar una sentencia con filtro where |\n| **`take`** | Take | Cantidad maxima de registros a tomar dentro de una sentencia con filtro where |\n| **`openParentecis`** | OpenParentesis | Puede aperturar un parentecis para filtrar de una mejor manera los registros |\n| **`closeParentecis`** | CloseParentesis | Puede cerrar un parentecis para filtrar de una mejor manera los registros |\n\n\n#### Or\n\nProporciona la logica de una sentencia Or sobre la información que contiene esta interface, añadiendo la capacidad\nde poder filtrar por medio de las sentencias AND, OR, TAKE Y ORDER BY","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/Jbranadev_capacitor-jbrandev-jbsqlutils.md","loc":{"lines":{"from":338,"to":354}}}}],["905fed3e-aee0-4ab6-bf4b-a2552fd40fa1",{"pageContent":"| Prop | Type | Description |\n| --------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------- |\n| **`columName`** | string | Nombre de la columna sobre la cual se evaluara la sentencia OR |\n| **`operator`** | Operator | Operador sobre el cual se evalura la columna respecto al valor proporcionado |\n| **`value`** | any | Valor contra el que se evaluara la columna |\n| **`and`** | And | Agrega la logica de una sentencia And sobre la información proporcionada. |\n| **`or`** | Or | Agrega la logica de una sentencia Or sobre la información proporcionada. |\n| **`orderBy`** | OrderBy | Tipo de ordenamiento que deseamos se aplique al realizar una sentencia con filtro where |\n| **`take`** | Take | Cantidad maxima de registros a tomar dentro de una sentencia con filtro where |\n| **`openParentecis`** | OpenParentesis | Puede aperturar un parentecis para filtrar de una mejor manera los registros |\n| **`closeParentecis`** | CloseParentesis | Puede cerrar un parentecis para filtrar de una mejor manera los registros |\n\n\n#### OrderBy\n\nDefine el tipo de ordenamiento que deseamos se ejecute al realizar una consulta, añadiendo la capacidad de poder\nlimitar la cantidad de resultados a travez de la sentencia TAKE\n\n| Prop | Type | Description |\n| --------------- | ----------------------------------------------- | ----------------------------------------------------------------------------- |\n| **`columName`** | string | Nombre de la columna por medio de la cual queremos ordenar |\n| **`orderType`** | OrderType | Tipo de ordenamiento que queremos realizar |\n| **`take`** | Take | Cantidad maxima de registros a tomar dentro de una sentencia con filtro where |\n\n\n#### Take\n\nDefine un limite de registros a tomar dentro de una sentencia con filtro Where","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/Jbranadev_capacitor-jbrandev-jbsqlutils.md","loc":{"lines":{"from":356,"to":383}}}}],["526b6c58-74b6-4298-9b46-cec847f09b28",{"pageContent":"#### Take\n\nDefine un limite de registros a tomar dentro de una sentencia con filtro Where\n\n| Prop | Type | Description |\n| ------------ | ------------------- | ------------------------------------------------------------------------------------------------------- |\n| **`limite`** | number | Cantidad Maxima de Registros que se desea tomar al filtrar con una sentencia Where |\n\n\n#### OpenParentesis\n\nAgrega la logica de agregar un operador previo y parentecis para filtrar de una mejor manera las consultas\n\n| Prop | Type | Description |\n| --------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------- |\n| **`operatorPrev`** | Operator | Operador previo a colocar antes de aperturar el parentecis |\n| **`columName`** | string | Nombre de la columna sobre la cual se evaluara la sentencia AND |\n| **`operator`** | Operator | Operador sobre el cual se evalura la columna respecto al valor proporcionado |\n| **`value`** | any | Valor contra el que se evaluara la columna |\n| **`and`** | And | Agrega la logica de una sentencia And sobre la información proporcionada. |\n| **`or`** | Or | Agrega la logica de una sentencia Or sobre la información proporcionada. |\n| **`orderBy`** | OrderBy | Tipo de ordenamiento que deseamos se aplique al realizar una sentencia con filtro where |\n| **`take`** | Take | Cantidad maxima de registros a tomar dentro de una sentencia con filtro where |\n| **`openParentecis`** | OpenParentesis | Puede aperturar un parentecis para filtrar de una mejor manera los registros |\n| **`closeParentecis`** | CloseParentesis | Puede cerrar un parentecis para filtrar de una mejor manera los registros |\n\n\n#### CloseParentesis\n\nProporciona la logica de un cierre de parentesis","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/Jbranadev_capacitor-jbrandev-jbsqlutils.md","loc":{"lines":{"from":383,"to":412}}}}],["ee1eda3a-66ab-4fbb-a076-914a029d82a1",{"pageContent":"#### CloseParentesis\n\nProporciona la logica de un cierre de parentesis\n\n| Prop | Type | Description |\n| --------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------- |\n| **`operatorPost`** | Operator | Operador posterior a colocar antes de aperturar el parentecis |\n| **`and`** | And | Agrega la logica de una sentencia And sobre la información proporcionada. |\n| **`or`** | Or | Agrega la logica de una sentencia Or sobre la información proporcionada. |\n| **`orderBy`** | OrderBy | Tipo de ordenamiento que deseamos se aplique al realizar una sentencia con filtro where |\n| **`take`** | Take | Cantidad maxima de registros a tomar dentro de una sentencia con filtro where |\n| **`openParentecis`** | OpenParentesis | Puede aperturar un parentecis para filtrar de una mejor manera los registros |\n| **`closeParentecis`** | CloseParentesis | Puede cerrar un parentecis para filtrar de una mejor manera los registros |\n\n\n#### DeleteResult\n\nDefine el resultado de eliminar registros en BD's\n\n| Prop | Type | Description |\n| ----------------- | ------------------- | -------------------------------------------------------------------------- |\n| **`rows_delete`** | number | Cantidad de filas que se han sido eliminadas al ejecutar la sentencia SQL. |\n\n\n#### DeleteOptions\n\nDefine la tabla y la logica a aplicar al momento de eliminar los registros de BD's","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/Jbranadev_capacitor-jbrandev-jbsqlutils.md","loc":{"lines":{"from":412,"to":438}}}}],["b03bd389-8d1f-49bc-a87d-f705baf77ddd",{"pageContent":"#### DeleteOptions\n\nDefine la tabla y la logica a aplicar al momento de eliminar los registros de BD's\n\n| Prop | Type | Description |\n| ------------------------ | ------------------------------------------------------------- | ---------------------------------------------------------------------------- |\n| **`tableName`** | string | Nombre de la tabla en la que se desea eliminar registros |\n| **`where`** | Where | Agrega la logica de un filtro where al momento de eliminar registros en BD's |\n| **`propertysConection`** | ConectionOptions | Define las propiedades de conexión a la BD's a la que se pegara JBSqlUtils |\n\n\n#### SelectOptions\n\nDefine las columnas a obtener en cada registro de la tabla especificada de acuerdo a la \nlogica proporcionada.\n\n| Prop | Type | Description |\n| ------------------------ | ------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |\n| **`tableName`** | string | Nombre de la tabla de la que se desean obtener los registros |\n| **`where`** | Where | Agrega la logica de un filtro where al momento de obtener registros de BD's |\n| **`columns`** | string[] | Define las columnas a obtener de la tabla, de desear obtener todas las columnas, no especificar esta propiedad |\n| **`propertysConection`** | ConectionOptions | Define las propiedades de conexión a la BD's a la que se pegara JBSqlUtils |\n\n\n### Enums\n\n\n#### DataBase\n\n| Members | Value | Description |\n| ---------------- | ------------------------- | ----------- |\n| **`SQLite`** | \"SQLite\" | SQLite |\n| **`MySQL`** | \"MySQL\" | MySQL |\n| **`SQLServer`** | \"SQLServer\" | SQL Server |\n| **`PostgreSQL`** | \"PostgreSQL\" | PostgreSQL |\n\n\n#### DataType","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/Jbranadev_capacitor-jbrandev-jbsqlutils.md","loc":{"lines":{"from":438,"to":475}}}}],["3ee4d821-c361-4a6e-b408-90fe6e2a4318",{"pageContent":"| Members | Value | Description |\n| ------------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`INTEGER`** | \"INTEGER\" | Entero de 32 bits con signo |\n| **`INT`** | \"INT\" | Entero de 32 bits con signo |\n| **`IDENTITY`** | \"IDENTITY\" | Tipo de dato auto incrementable en SQL Server |\n| **`SERIAL`** | \"SERIAL\" | Tipo de dato auto incrementable en PostgreSQL |\n| **`CHAR`** | \"CHAR\" | Cadena de caracteres de longitud fija |\n| **`VARCHAR`** | \"VARCHAR\" | Cadena de caracteres de longitud variable |\n| **`LONGVARCHAR`** | \"LONGVARCHAR\" | Cadenas de cualquier longitud (varios megabytes), debe definir el tamaño que desea tenga la columna por medio del metodo setSize, para esta numeración en especifico. |\n| **`ENUM`** | \"ENUM\" | Enum se tienen que definir las opciones disponibles a través del metodo setSize, envíando como parametro para esta numeración, las opciones que deseamos tenga disponible |\n| **`SMALLINT`** | \"SMALLINT\" | entero de 16 bits |\n| **`TINYINT`** | \"TINYINT\" | entero de 16 bits |\n| **`REAL`** | \"REAL\" | Valor de coma flotante |","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/Jbranadev_capacitor-jbrandev-jbsqlutils.md","loc":{"lines":{"from":477,"to":489}}}}],["1c075f00-5a9d-4d9d-89f2-be70508642ac",{"pageContent":"| **`FLOAT`** | \"FLOAT\" | Valor de coma flotante |\n| **`DOUBLE`** | \"DOUBLE\" | Gran valor de punto flotante |\n| **`NUMERIC`** | \"NUMERIC\" | Valores decimales de precisión absoluta |\n| **`DECIMAL`** | \"DECIMAL\" | Valor decimal de precisión absoluta |\n| **`MONEY`** | \"MONEY\" | Valor decimal de precisión absoluta |\n| **`SMALLMONEY`** | \"SMALLMONEY\" | Valor decimal de precisión absoluta |\n| **`BIT`** | \"BIT\" | Bit único/valor binario (activado o desactivado) |\n| **`BOOLEAN`** | \"BOOLEAN\" | Valor Booleano |\n| **`BOOL`** | \"BOOL\" | Valor Booleano |\n| **`BINARY`** | \"BINARY\" | Matriz de valores binarios |\n| **`VARBINARY`** | \"VARBINARY\" | Matriz de longitud variable de valores binarios, en mysql el valor maximo es de 21844 pero en sql server es de 8000 |\n| **`LONGVARBINARY`** | \"LONGVARBINARY\" | Matriz de valores binarios de cualquier longitud (varios megabytes) SQL Server |\n| **`IMAGE`** | \"IMAGE\" | Cadena binaria de ancho variable |","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/Jbranadev_capacitor-jbrandev-jbsqlutils.md","loc":{"lines":{"from":490,"to":502}}}}],["102d8c0b-842d-45d3-b8ce-57509e82f021",{"pageContent":"| **`OBJECT`** | \"OBJECT\" | Setea que el tipo de dato será un Object |\n| **`JSON`** | \"JSON\" | Setea que el tipo de dato será un JSON |\n| **`DATE`** | \"DATE\" | Valor de fecha |\n| **`TIME`** | \"TIME\" | Valor del tiempo |\n| **`TIMESTAMP`** | \"TIMESTAMP\" | Valor de tiempo con campo adicional de nanosegundos |\n| **`SMALLDATETIME`** | \"SMALLDATETIME\" | Valor de tiempo con campo adicional de nanosegundos |\n| **`DATETIME`** | \"DATETIME\" | Valor de tiempo con campo adicional de nanosegundos |\n| **`DATETIME2`** | \"DATETIME2\" | Valor de tiempo con campo adicional de nanosegundos |","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/Jbranadev_capacitor-jbrandev-jbsqlutils.md","loc":{"lines":{"from":503,"to":510}}}}],["afe3b581-b4cd-4834-a688-8c60cee4ea13",{"pageContent":"#### Constraint","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/Jbranadev_capacitor-jbrandev-jbsqlutils.md","loc":{"lines":{"from":513,"to":513}}}}],["078cc52d-788c-4626-a0b2-842260df92b5",{"pageContent":"| Members | Value | Description |\n| ----------------------- | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`NOT_NULL`** | \"NOT_NULL\" | Indica que la columna no acepta valores Nullos. |\n| **`UNIQUE`** | \"UNIQUE\" | El valor de esta columna tiene que ser unico |\n| **`CHECK`** | \"CHECK\" | Restriccion que permite indicarle que tipo de valores si serán aceptados por la columna Lo puede realizar a travez del metodo setRestriccion=String restriccion; de esta numeración. considerar que la misma restricción se aplicara para el resto de columnas que tengan un valor Check. |\n| **`PRIMARY_KEY`** | \"PRIMARY_KEY\" | Indica que la columna funciona como clave primaria del modelo. |\n| **`FOREIGN_KEY`** | \"FOREIGN_KEY\" | Indica que la columna funciona como clave foranea del modelo. |\n| **`CURRENT_TIMESTAMP`** | \"CURRENT_TIMESTAMP\" | Indica que el campo tendra como valor por default el TimeStamp del momento en que se almacene el modelo. |","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/Jbranadev_capacitor-jbrandev-jbsqlutils.md","loc":{"lines":{"from":515,"to":522}}}}],["748946a4-e32a-4fa0-8a0e-60ca751f1dfa",{"pageContent":"| **`DEFAULT`** | \"DEFAULT\" | Indica que la columna tendra un valor por default |\n| **`AUTO_INCREMENT`** | \"AUTO_INCREMENT\" | Indica que la columna autoincrementara su valor cada vez que se almacene un registro en la tabla correspondiente al modelo. |","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/Jbranadev_capacitor-jbrandev-jbsqlutils.md","loc":{"lines":{"from":523,"to":524}}}}],["21db5a4c-c70d-4f19-aa65-2c2e0b629269",{"pageContent":"#### Operator\n\n| Members | Value | Description |\n| ---------------------- | ------------------------------- | ----------------- |\n| **`MAYOR_IGUAL_QUE`** | \"MAYOR_IGUAL_QUE\" | Operador >= |\n| **`MAYOR_QUE`** | \"MAYOR_QUE\" | Operador > |\n| **`IGUAL_QUE`** | \"IGUAL_QUE\" | Operador = |\n| **`DISTINTO`** | \"DISTINTO\" | Operador <> |\n| **`MENOR_QUE`** | \"MENOR_QUE\" | Operador < |\n| **`MENOR_IGUAL_QUE`** | \"MENOR_IGUAL_QUE\" | Operador <= |\n| **`LIKE`** | \"LIKE\" | Operador LIKE |\n| **`OPEN_PARENTESIS`** | \"OPEN_PARENTESIS\" | Operador ( |\n| **`CLOSE_PARENTESIS`** | \"CLOSE_PARENTESIS\" | Operador ) |\n| **`ORDERBY`** | \"ORDERBY\" | Operador ORDER BY |\n| **`AND`** | \"AND\" | Operador AND |\n| **`OR`** | \"OR\" | Operador OR |\n| **`NOT`** | \"NOT\" | Operador NOT |\n\n\n#### OrderType\n\n| Members | Value | Description |\n| ---------- | ------------------- | ----------------------------------------------------------------- |\n| **`ASC`** | \"ASC\" | Indica que deseamos se ordene de manera Ascendente los registros |\n| **`DESC`** | \"DESC\" | Indica que deseamos se ordene de manera Descendente los registros |\n\n{ fileURL: string; deviceIdentifier: string; } |\n| **`callback`** | firmwareUpdateCallback |\n\n**Returns:** Promise<string>\n\n--------------------\n\n\n### getVersion(...)\n\n```typescript\ngetVersion(options: { deviceIdentifier: string; }) => Promise{ deviceIdentifier: string; } |\n\n**Returns:** Promise<string>\n\n--------------------\n\n\n### Interfaces\n\n\n#### String\n\nAllows manipulation and formatting of text strings and determination and location of substrings within strings.\n\n| Prop | Type | Description |\n| ------------ | ------------------- | ------------------------------------------------------------ |\n| **`length`** | number | Returns the length of a String object. |","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/RickGroenewegen_zephyr-dfu.md","loc":{"lines":{"from":1,"to":74}}}}],["f69a76d4-2739-42e5-8875-7a129523fb34",{"pageContent":"| Method | Signature | Description |\n| --------------------- | ------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| **toString** | () => string | Returns a string representation of a string. |\n| **charAt** | (pos: number) => string | Returns the character at the specified index. |\n| **charCodeAt** | (index: number) => number | Returns the Unicode value of the character at the specified location. |\n| **concat** | (...strings: string[]) => string | Returns a string that contains the concatenation of two or more strings. |\n| **indexOf** | (searchString: string, position?: number \\| undefined) => number | Returns the position of the first occurrence of a substring. |\n| **lastIndexOf** | (searchString: string, position?: number \\| undefined) => number | Returns the last occurrence of a substring in the string. |\n| **localeCompare** | (that: string) => number | Determines whether two strings are equivalent in the current locale. |\n| **match** | (regexp: string \\| RegExp) => RegExpMatchArray \\| null | Matches a string with a regular expression, and returns an array containing the results of that search. |","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/RickGroenewegen_zephyr-dfu.md","loc":{"lines":{"from":76,"to":85}}}}],["93c54805-d210-4a9b-a201-6760678e0093",{"pageContent":"| **replace** | (searchValue: string \\| RegExp, replaceValue: string) => string | Replaces text in a string, using a regular expression or search string. |\n| **replace** | (searchValue: string \\| RegExp, replacer: (substring: string, ...args: any[]) => string) => string | Replaces text in a string, using a regular expression or search string. |\n| **search** | (regexp: string \\| RegExp) => number | Finds the first substring match in a regular expression search. |\n| **slice** | (start?: number \\| undefined, end?: number \\| undefined) => string | Returns a section of a string. |\n| **split** | (separator: string \\| RegExp, limit?: number \\| undefined) => string[] | Split a string into substrings using the specified separator and return them as an array. |\n| **substring** | (start: number, end?: number \\| undefined) => string | Returns the substring at the specified location within a String object. |\n| **toLowerCase** | () => string | Converts all the alphabetic characters in a string to lowercase. |\n| **toLocaleLowerCase** | (locales?: string \\| string[] \\| undefined) => string | Converts all alphabetic characters to lowercase, taking into account the host environment's current locale. |\n| **toUpperCase** | () => string | Converts all the alphabetic characters in a string to uppercase. |\n| **toLocaleUpperCase** | (locales?: string \\| string[] \\| undefined) => string | Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale. |","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/RickGroenewegen_zephyr-dfu.md","loc":{"lines":{"from":86,"to":95}}}}],["3c34f92c-2834-4cd8-ac19-b38c5b8e3167",{"pageContent":"| **trim** | () => string | Removes the leading and trailing white space and line terminator characters from a string. |\n| **substr** | (from: number, length?: number \\| undefined) => string | Gets a substring beginning at the specified location and having the specified length. |\n| **valueOf** | () => string | Returns the primitive value of the specified object. |","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/RickGroenewegen_zephyr-dfu.md","loc":{"lines":{"from":96,"to":98}}}}],["5b51d471-1fab-45b7-8e20-c5d55c2b916c",{"pageContent":"#### RegExpMatchArray\n\n| Prop | Type |\n| ----------- | ------------------- |\n| **`index`** | number |\n| **`input`** | string |\n\n\n#### RegExp\n\n| Prop | Type | Description |\n| ---------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`source`** | string | Returns a copy of the text of the regular expression pattern. Read-only. The regExp argument is a Regular expression object. It can be a variable name or a literal. |\n| **`global`** | boolean | Returns a Boolean value indicating the state of the global flag (g) used with a regular expression. Default is false. Read-only. |\n| **`ignoreCase`** | boolean | Returns a Boolean value indicating the state of the ignoreCase flag (i) used with a regular expression. Default is false. Read-only. |\n| **`multiline`** | boolean | Returns a Boolean value indicating the state of the multiline flag (m) used with a regular expression. Default is false. Read-only. |\n| **`lastIndex`** | number | |\n\n| Method | Signature | Description |\n| ----------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| **exec** | (string: string) => RegExpExecArray \\| null | Executes a search on a string using a regular expression pattern, and returns an array containing the results of that search. |\n| **test** | (string: string) => boolean | Returns a Boolean value that indicates whether or not a pattern exists in a searched string. |\n| **compile** | () => this | |\n\n\n#### RegExpExecArray\n\n| Prop | Type |\n| ----------- | ------------------- |\n| **`index`** | number |\n| **`input`** | string |\n\n\n### Type Aliases\n\n\n#### firmwareUpdateCallback\n\n(msg: String | null, err?: any): void","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/RickGroenewegen_zephyr-dfu.md","loc":{"lines":{"from":101,"to":139}}}}],["02b4ea5a-f159-4af7-800a-4d9fb4354e4f",{"pageContent":"### Type Aliases\n\n\n#### firmwareUpdateCallback\n\n(msg: String | null, err?: any): void\n\n\n#### CallbackID\n\nstring\n\n{ imageBase64: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### detectData(...)\n\n```typescript\ndetectData(options: { imageBase64: string; }) => Promise<{ value: string; }>\n```\n\n| Param | Type |\n| ------------- | ------------------------------------- |\n| **`options`** | { imageBase64: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n![](\"https://user-images.githubusercontent.com/11452353/123266356-9ae1b200-d504-11eb-9148-38e7e761435f.png\")
\n
\n![](\".github/img/working-settings.jpg\")
\n
\n![](\".github/img/android-vkid.jpg\")
\n
\n![](\".github/img/ios-vkid.jpg\")
\n
string,\n appName: string,\n webDir: 'www',\n bundledWebRuntime: false,\n plugins:{\n Plumb5:{\n PLUMB5_ACCOUNT_ID:number ,\n PLUMB5_BASE_URL:string ,\n PLUMB5_API_KEY: string \n }\n\n }\n\n};\n\nexport default config;\n```\n## Initialize Plumb5 SDK\n\n```typescript\n/* eslint-disable @typescript-eslint/naming-convention */\nimport { Component } from '@angular/core';\n\nimport { Plumb5 } from 'plumb5-sdk';\n\nimport { Platform } from '@ionic/angular';\n\nimport { Router, NavigationStart, ActivatedRoute, Navigation } from '@angular/router';\n\n\n@Component({\n selector: 'app-root',\n templateUrl: 'app.component.html',\n styleUrls: ['app.component.scss'],\n})\n\n\nexport class AppComponent {\n constructor(\n private platform: Platform,\n private router: Router,\n private pageParameter: ActivatedRoute\n ) {\n\n this.platform.ready().then(() => {\n\n this.Plumb5();\n\n });\n\n\n }\n\n\n\n Plumb5() {\n\n\n //initialize the sdk\n Plumb5.initializePlumb5();\n\n //initialize the sdk page tracking and in-app notfication\n this.router.events\n .subscribe(\n (event) => {\n if(event instanceof NavigationStart) {\n console.log(event);\n\n Plumb5.tracking({\n ScreenName: event.url,\n PageParameter: ''\n });\n\n Plumb5.pushResponse({\n ScreenName: event.url,\n PageParameter: ''\n });\n }\n });\n\n //user details\n Plumb5.setUserDetails({\n Name: 'demo',\n EmailId: 'guru@demo.com',\n PhoneNumber: '987654321',\n LeadType: 1,\n Gender: 'Male',\n Age: '2020-01-27T06:12:01.051Z',\n AgeRange: '10-89',\n MaritalStatus: 'Married',\n Education: 'MCA',\n Occupation: 'SE',\n Interests: 'Eating',\n Location: 'Bangalore'\n });\n\n //Capture PushNotification Data and route navigation from notfication\n window.addEventListener('onPushNotification', (e: any) => {\n console.log('onPushNotification');\n console.log(JSON.stringify(e));\n const routeUrl = e.routeUrl;\n console.log('routeUrl', routeUrl); // similar parameter in case of route or button click\n this.router.navigate([routeUrl]);\n });\n\n //Event post of any kond of component\n Plumb5.eventPost({\n Type: 'Button',\n Name: 'demo@demo.com',\n PhoneNumber: '987654321',\n Value: 1\n });\n\n\n }\n\n}\n\n```\n\n## Add Android platform\n\n```bash\nionic cap add android\n\n```\n\n## Integrating Firebase googleService JSON","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/plumb5_IONIC-CAPACITOR-SDK.md","loc":{"lines":{"from":1,"to":149}}}}],["ab0180b8-846b-403a-afe1-88f2c05c49a4",{"pageContent":"}\n\n}\n\n```\n\n## Add Android platform\n\n```bash\nionic cap add android\n\n```\n\n## Integrating Firebase googleService JSON \n\nYour Android package name should match the appId from your capacitor.capacitor.config file\nWe used com.mydomain.myappname for this Capacitor app ID, so that is what we'll use for this entry.\n\nDownload the google-services.json file to your local machine. Then move the file into your Capacitor Android project directory, specifically under android/app/.\n\n\n\n## Update the credtional\n\nAdd the details in AndroidManifest.xml file\n\nAdd the details under 'onPushNotification' |\n| **`listenerFunc`** | (data: { routeUrl: string; }) => void |\n\n**Returns:** PluginListenerHandle\n\n--------------------\n\n\n### initializePlumb5()\n\n```typescript\ninitializePlumb5() => PromiseUserOptions |\n\n--------------------\n\n\n### notificationSubscribe()","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/plumb5_IONIC-CAPACITOR-SDK.md","loc":{"lines":{"from":575,"to":674}}}}],["ec224681-df74-4126-bbe1-5006d82af3b8",{"pageContent":"--------------------\n\n\n### notificationSubscribe()\n\n```typescript\nnotificationSubscribe() => Promise{ ScreenName: string; PageParameter: any; } |\n\n--------------------\n\n\n### pushResponse(...)\n\n```typescript\npushResponse(options: { ScreenName: string; PageParameter: any; }) => Promise{ ScreenName: string; PageParameter: any; } |\n\n--------------------\n\n\n### eventPost(...)\n\n```typescript\neventPost(options: EventDetails) => PromiseEventDetails |\n\n--------------------\n\n\n### register()\n\n```typescript\nregister() => PromisePromise<DeliveredNotifications>\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### removeDeliveredNotifications(...)\n\n```typescript\nremoveDeliveredNotifications(delivered: DeliveredNotifications) => PromiseDeliveredNotifications |\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### removeAllDeliveredNotifications()\n\n```typescript\nremoveAllDeliveredNotifications() => PromiseChannel |\n\n**Since:** 1.0.0\n\n--------------------","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/plumb5_IONIC-CAPACITOR-SDK.md","loc":{"lines":{"from":674,"to":803}}}}],["af22e05c-7d3e-499f-8b3f-667a6028887a",{"pageContent":"**Since:** 1.0.0\n\n--------------------\n\n\n### deleteChannel(...)\n\n```typescript\ndeleteChannel(args: { id: string; }) => Promise{ id: string; } |\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### listChannels()\n\n```typescript\nlistChannels() => PromisePromise<ListChannelsResult>\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### checkPermissions()\n\n```typescript\ncheckPermissions() => PromisePromise<PermissionStatus>\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### requestPermissions()\n\n```typescript\nrequestPermissions() => PromisePromise<PermissionStatus>\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### addListener('registration', ...)\n\n```typescript\naddListener(eventName: 'registration', listenerFunc: (token: Token) => void) => Promise'registration' |\n| **`listenerFunc`** | (token: Token) => void |\n\n**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### addListener('registrationError', ...)\n\n```typescript\naddListener(eventName: 'registrationError', listenerFunc: (error: RegistrationError) => void) => Promise'registrationError' |\n| **`listenerFunc`** | (error: RegistrationError) => void |\n\n**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### addListener('pushNotificationReceived', ...)\n\n```typescript\naddListener(eventName: 'pushNotificationReceived', listenerFunc: (notification: PushNotificationSchema) => void) => Promise'pushNotificationReceived' |\n| **`listenerFunc`** | (notification: PushNotificationSchema) => void |\n\n**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### addListener('pushNotificationActionPerformed', ...)\n\n```typescript\naddListener(eventName: 'pushNotificationActionPerformed', listenerFunc: (notification: ActionPerformed) => void) => Promise'pushNotificationActionPerformed' |\n| **`listenerFunc`** | (notification: ActionPerformed) => void |\n\n**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### removeAllListeners()\n\n```typescript\nremoveAllListeners() => Promise() => Promise<void> |\n\n\n#### UserOptions\n\n| Prop | Type |\n| ------------------- | ------------------- |\n| **`Name`** | string |\n| **`EmailId`** | string |\n| **`PhoneNumber`** | string |\n| **`LeadType`** | number |\n| **`Gender`** | string |\n| **`Age`** | string |\n| **`AgeRange`** | string |\n| **`MaritalStatus`** | string |\n| **`Education`** | string |\n| **`Occupation`** | string |\n| **`Interests`** | string |\n| **`Location`** | string |\n\n\n#### EventDetails\n\n| Prop | Type |\n| ----------------- | ------------------- |\n| **`Type`** | string |\n| **`Name`** | string |\n| **`PhoneNumber`** | string |\n| **`Value`** | number |\n\n\n#### DeliveredNotifications\n\n| Prop | Type | Description | Since |\n| ------------------- | ------------------------------------- | ------------------------------------------------------------------- | ----- |\n| **`notifications`** | PushNotificationSchema[] | List of notifications that are visible on the notifications screen. | 1.0.0 |\n\n\n#### PushNotificationSchema","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/plumb5_IONIC-CAPACITOR-SDK.md","loc":{"lines":{"from":988,"to":1038}}}}],["de74fc0f-7126-4d8a-8b3a-d16ccad89d0c",{"pageContent":"#### PushNotificationSchema\n\n| Prop | Type | Description | Since |\n| ------------------ | -------------------- | -------------------------------------------------------------------------------------------------------------------- | ----- |\n| **`title`** | string | The notification title. | 1.0.0 |\n| **`subtitle`** | string | The notification subtitle. | 1.0.0 |\n| **`body`** | string | The main text payload for the notification. | 1.0.0 |\n| **`id`** | string | The notification identifier. | 1.0.0 |\n| **`tag`** | string | The notification tag. Only available on Android (from push notifications). | 4.0.0 |\n| **`badge`** | number | The number to display for the app icon badge. | 1.0.0 |\n| **`notification`** | any | It's not being returned. | 1.0.0 |\n| **`data`** | any | Any additional data that was included in the push notification payload. | 1.0.0 |\n| **`click_action`** | string | The action to be performed on the user opening the notification. Only available on Android. | 1.0.0 |\n| **`link`** | string | Deep link from the notification. Only available on Android. | 1.0.0 |\n| **`group`** | string | Set the group identifier for notification grouping. Only available on Android. Works like `threadIdentifier` on iOS. | 1.0.0 |\n| **`groupSummary`** | boolean | Designate this notification as the summary for an associated `group`. Only available on Android. | 1.0.0 |\n\n\n#### Channel","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/plumb5_IONIC-CAPACITOR-SDK.md","loc":{"lines":{"from":1038,"to":1056}}}}],["f16118d5-3414-4847-a327-2f2f98fb77a0",{"pageContent":"| Prop | Type | Description | Default | Since |\n| ----------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | ----- |\n| **`id`** | string | The channel identifier. | | 1.0.0 |\n| **`name`** | string | The human-friendly name of this channel (presented to the user). | | 1.0.0 |\n| **`description`** | string | The description of this channel (presented to the user). | | 1.0.0 |\n| **`sound`** | string | The sound that should be played for notifications posted to this channel. Notification channels with an importance of at least `3` should have a sound. The file name of a sound file should be specified relative to the android app `res/raw` directory. | | 1.0.0 |\n| **`importance`** | Importance | The level of interruption for notifications posted to this channel. | `3` | 1.0.0 |\n| **`visibility`** | Visibility | The visibility of notifications posted to this channel. This setting is for whether notifications posted to this channel appear on the lockscreen or not, and if so, whether they appear in a redacted form. | | 1.0.0 |","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/plumb5_IONIC-CAPACITOR-SDK.md","loc":{"lines":{"from":1058,"to":1065}}}}],["ed2be022-e173-491e-b1ca-a16c6f2cf642",{"pageContent":"| **`lights`** | boolean | Whether notifications posted to this channel should display notification lights, on devices that support it. | | 1.0.0 |\n| **`lightColor`** | string | The light color for notifications posted to this channel. Only supported if lights are enabled on this channel and the device supports it. Supported color formats are `#RRGGBB` and `#RRGGBBAA`. | | 1.0.0 |\n| **`vibration`** | boolean | Whether notifications posted to this channel should vibrate. | | 1.0.0 |","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/plumb5_IONIC-CAPACITOR-SDK.md","loc":{"lines":{"from":1066,"to":1068}}}}],["48e66513-111c-491b-9c95-b16529a5447c",{"pageContent":"#### ListChannelsResult\n\n| Prop | Type | Description | Since |\n| -------------- | ---------------------- | --------------------------------------------- | ----- |\n| **`channels`** | Channel[] | List of all the Channels created by your app. | 1.0.0 |\n\n\n#### PermissionStatus\n\n| Prop | Type | Description | Since |\n| ------------- | ----------------------------------------------------------- | -------------------------------------------- | ----- |\n| **`receive`** | PermissionState | Permission state of receiving notifications. | 1.0.0 |\n\n\n#### Token\n\n| Prop | Type | Description | Since |\n| ----------- | ------------------- | ------------------------------------------------------------------------ | ----- |\n| **`value`** | string | On iOS it contains the APNS token. On Android it contains the FCM token. | 1.0.0 |\n\n\n#### RegistrationError\n\n| Prop | Type | Description | Since |\n| ----------- | ------------------- | -------------------------------------------------- | ----- |\n| **`error`** | string | Error message describing the registration failure. | 4.0.0 |\n\n\n#### ActionPerformed\n\n| Prop | Type | Description | Since |\n| ------------------ | ------------------------------------------------------------------------- | --------------------------------------------------------------- | ----- |\n| **`actionId`** | string | The action performed on the notification. | 1.0.0 |\n| **`inputValue`** | string | Text entered on the notification action. Only available on iOS. | 1.0.0 |\n| **`notification`** | PushNotificationSchema | The notification in which the action was performed. | 1.0.0 |\n\n\n### Type Aliases\n\n\n#### Importance\n\nThe importance level. For more details, see the [Android Developer Docs](https://developer.android.com/reference/android/app/NotificationManager#IMPORTANCE_DEFAULT)\n\n1 | 2 | 3 | 4 | 5\n\n\n#### Visibility\n\nThe notification visibility. For more details, see the [Android Developer Docs](https://developer.android.com/reference/androidx/core/app/NotificationCompat#VISIBILITY_PRIVATE)\n\n-1 | 0 | 1\n\n\n#### PermissionState\n\n'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'\n\n
HTTP
\n@capacitor-community/http
\n Capacitor community plugin for native HTTP requests, file download/uploads, and cookie management.\n
\n\n\n
\n
Daniel Sogl 📖 | \n Priyank Patel 💻 | \n Max Lynch 💻 | \n Falk Schieber 👀 | \n Andy Sousa 💻 | \n Thomas Vidas 💻 🚧 | \n Emily Curry 💻 | \n
graefenhain 💻 | \n Lee Houghton 🐛 | ","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/capacitor-community_http.md","loc":{"lines":{"from":169,"to":184}}}}],["7b0700f7-71e2-49c8-82c5-70d33e54a1c5",{"pageContent":"Felix Schwarzmeier 💻 | \n Kamil Jakubus 💻 | \n Joe Flateau 🐛 | \n Frank608 🐛 | \n Joel Nieto 🐛 | \n
ultimate-tester 💻 | \n Adrian Sanchez 🐛 | \n milanc 💻 | \n herecoulbeyourname 💻 | ","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/capacitor-community_http.md","loc":{"lines":{"from":185,"to":195}}}}],["79dd730e-0896-4635-be7c-f6ac63dbc6ff",{"pageContent":"Landschaft 💻 | \n stonewoodman 🐛 | \n Héctor Cruz 🐛 | \n
Patrick Bußmann 💻 | \n Jesper Bjerke 🐛 | \n
Promise<any>\n\n--------------------\n\nSipLoginOptions |\n\n--------------------\n\n\n### logout()\n\n```typescript\nlogout() => PromiseSipOutgoingCallOptions |\n\n--------------------\n\n\n### acceptCall()\n\n```typescript\nacceptCall() => Promise'TLS' \\| 'TCP' \\| 'UDP' | By default \"UDP\" |\n| **`domain`** | string | SIP domain address |\n| **`username`** | string | User login for authentication |\n| **`password`** | string | User password for authentication |\n\n\n#### SipOutgoingCallOptions\n\n| Prop | Type |\n| ------------- | ------------------- |\n| **`address`** | string |\n\n(data: UsbSerialResponse) => void |\n\n**Returns:** any\n\n--------------------\n\n\n### connectedDevices()\n\n```typescript\nconnectedDevices() => any\n```\n\n**Returns:** any\n\n--------------------\n\n\n### openSerial(...)\n\n```typescript\nopenSerial(options: UsbSerialOptions) => any\n```\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------- |\n| **`options`** | UsbSerialOptions |\n\n**Returns:** any\n\n--------------------\n\n\n### closeSerial()\n\n```typescript\ncloseSerial() => any\n```\n\n**Returns:** any\n\n--------------------\n\n\n### readSerial()\n\n```typescript\nreadSerial() => any\n```\n\n**Returns:** any\n\n--------------------\n\n\n### writeSerial(...)\n\n```typescript\nwriteSerial(data: UsbSerialWriteOptions) => any\n```\n\n| Param | Type |\n| ---------- | ----------------------------------------------------------------------- |\n| **`data`** | UsbSerialWriteOptions |\n\n**Returns:** any\n\n--------------------\n\n\n### registerReadCall(...)\n\n```typescript\nregisterReadCall(callback: MyPluginCallback) => any\n```\n\n| Param | Type |\n| -------------- | ---------------------------------------------------------------------------------- |\n| **`callback`** | (data: UsbSerialResponse) => void |\n\n**Returns:** any\n\n--------------------\n\n\n### Interfaces\n\n\n#### UsbSerialResponse","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/asad-96_capacitor-plugin-usb-serial.md","loc":{"lines":{"from":1,"to":126}}}}],["8b6f9e3d-58ec-47d1-b7d0-2e207d1330c7",{"pageContent":"**Returns:** any\n\n--------------------\n\n\n### Interfaces\n\n\n#### UsbSerialResponse\n\n| Prop | Type |\n| ------------- | --------------------------------------------------------- |\n| **`success`** | boolean |\n| **`error`** | UsbSerialError |\n| **`data`** | any |\n\n\n#### UsbSerialError\n\n| Prop | Type |\n| ------------- | ------------------- |\n| **`message`** | string |\n| **`cause`** | string |\n\n\n#### UsbSerialOptions\n\n| Prop | Type |\n| ------------------ | -------------------- |\n| **`deviceId`** | number |\n| **`portNum`** | number |\n| **`baudRate`** | number |\n| **`dataBits`** | number |\n| **`stopBits`** | number |\n| **`parity`** | number |\n| **`dtr`** | boolean |\n| **`rts`** | boolean |\n| **`sleepOnPause`** | boolean |\n\n\n#### UsbSerialWriteOptions\n\n| Prop | Type |\n| ---------- | ------------------- |\n| **`data`** | string |\n\n{ value: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### print(...)\n\n```typescript\nprint(options: { ip: string; port: number; zpl: string; }) => Promise<{ value: string; }>\n```\n\n| Param | Type |\n| ------------- | ------------------------------------------------------- |\n| **`options`** | { ip: string; port: number; zpl: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\nUnzipOptions | options for unzip |\n\n**Returns:** Promise<{ result: boolean; }>\n\n--------------------\n\n\n### Interfaces\n\n\n#### UnzipOptions\n\n| Prop | Type | Description |\n| ---------------- | ------------------- | ------------------------- |\n| **`zipPath`** | string | Zip file's path |\n| **`destFolder`** | string | Destination folder's path |\n\n
Bluetooth Low Energy
\n@capacitor-community/bluetooth-le
\n Capacitor plugin for Bluetooth Low Energy \n
\n\n\n ![](\"https://img.shields.io/maintenance/yes/2023?style=flat-square\")
![](\"https://img.shields.io/github/actions/workflow/status/capacitor-community/bluetooth-le/main.yml?branch=main&style=flat-square\")
![](\"https://img.shields.io/npm/l/@capacitor-community/bluetooth-le?style=flat-square\")
\n ![](\"https://img.shields.io/npm/dw/@capacitor-community/bluetooth-le?style=flat-square\")
![](\"https://img.shields.io/npm/v/@capacitor-community/bluetooth-le?style=flat-square\")
![](\"https://img.shields.io/badge/all%20contributors-11-orange?style=flat-square\"){kind=icon}
InitializeOptions |\n\n---\n\n### isEnabled()\n\n```typescript\nisEnabled() => PromisePromise<boolean>\n\n---\n\n### enable()\n\n```typescript\nenable() => Promise(value: boolean) => void | Callback function to use when the Bluetooth state changes. |\n\n---\n\n### stopEnabledNotifications()\n\n```typescript\nstopEnabledNotifications() => PromisePromise<boolean>\n\n---\n\n### openLocationSettings()\n\n```typescript\nopenLocationSettings() => PromiseDisplayStrings |\n\n---\n\n### requestDevice(...)\n\n```typescript\nrequestDevice(options?: RequestBleDeviceOptions | undefined) => PromiseRequestBleDeviceOptions | Device filters, see [RequestBleDeviceOptions](#RequestBleDeviceOptions) |\n\n**Returns:** Promise<BleDevice>\n\n---\n\n### requestLEScan(...)\n\n```typescript\nrequestLEScan(options: RequestBleDeviceOptions, callback: (result: ScanResult) => void) => PromiseRequestBleDeviceOptions |\n| **`callback`** | (result: ScanResult) => void |\n\n---\n\n### stopLEScan()\n\n```typescript\nstopLEScan() => Promisestring[] | List of device IDs, e.g. saved from a previous app run. |\n\n**Returns:** Promise<BleDevice[]>\n\n---\n\n### getConnectedDevices(...)\n\n```typescript\ngetConnectedDevices(services: string[]) => Promisestring[] | List of services to filter the devices by. If no service is specified, no devices will be returned. Only applies to iOS. |\n\n**Returns:** Promise<BleDevice[]>\n\n---\n\n### connect(...)\n\n```typescript\nconnect(deviceId: string, onDisconnect?: ((deviceId: string) => void) | undefined, options?: TimeoutOptions | undefined) => Promisestring | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) |\n| **`onDisconnect`** | ((deviceId: string) => void) | Optional disconnect callback function that will be used when the device disconnects |\n| **`options`** | TimeoutOptions | Options for plugin call |\n\n---\n\n### createBond(...)\n\n```typescript\ncreateBond(deviceId: string) => Promisestring | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) |\n\n---\n\n### isBonded(...)\n\n```typescript\nisBonded(deviceId: string) => Promisestring | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) |\n\n**Returns:** Promise<boolean>\n\n---\n\n### disconnect(...)\n\n```typescript\ndisconnect(deviceId: string) => Promisestring | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) |\n\n---","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/capacitor-community_bluetooth-le.md","loc":{"lines":{"from":613,"to":667}}}}],["802712c8-0991-4110-9048-1217d85ae29e",{"pageContent":"---\n\n### getServices(...)\n\n```typescript\ngetServices(deviceId: string) => Promisestring | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) |\n\n**Returns:** Promise<BleService[]>\n\n---\n\n### discoverServices(...)\n\n```typescript\ndiscoverServices(deviceId: string) => Promisestring | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) |\n\n---\n\n### getMtu(...)\n\n```typescript\ngetMtu(deviceId: string) => Promisestring | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) |\n\n**Returns:** Promise<number>\n\n---\n\n### requestConnectionPriority(...)\n\n```typescript\nrequestConnectionPriority(deviceId: string, connectionPriority: ConnectionPriority) => Promisestring | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) |\n| **`connectionPriority`** | ConnectionPriority | Request a specific connection priority. See [ConnectionPriority](#connectionpriority) |\n\n---\n\n### readRssi(...)\n\n```typescript\nreadRssi(deviceId: string) => Promisestring | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) |\n\n**Returns:** Promise<number>\n\n---\n\n### read(...)\n\n```typescript\nread(deviceId: string, service: string, characteristic: string, options?: TimeoutOptions | undefined) => Promisestring | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) |\n| **`service`** | string | UUID of the service (see [UUID format](#uuid-format)) |\n| **`characteristic`** | string | UUID of the characteristic (see [UUID format](#uuid-format)) |\n| **`options`** | TimeoutOptions | Options for plugin call |\n\n**Returns:** Promise<DataView>\n\n---\n\n### write(...)","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/capacitor-community_bluetooth-le.md","loc":{"lines":{"from":728,"to":771}}}}],["9ae620f1-ab6a-40d0-aaff-ca6b41e7509c",{"pageContent":"**Returns:** Promise<DataView>\n\n---\n\n### write(...)\n\n```typescript\nwrite(deviceId: string, service: string, characteristic: string, value: DataView, options?: TimeoutOptions | undefined) => Promisestring | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) |\n| **`service`** | string | UUID of the service (see [UUID format](#uuid-format)) |\n| **`characteristic`** | string | UUID of the characteristic (see [UUID format](#uuid-format)) |\n| **`value`** | DataView | The value to write as a DataView. To create a DataView from an array of numbers, there is a helper function, e.g. numbersToDataView([1, 0]) |\n| **`options`** | TimeoutOptions | Options for plugin call |\n\n---\n\n### writeWithoutResponse(...)\n\n```typescript\nwriteWithoutResponse(deviceId: string, service: string, characteristic: string, value: DataView, options?: TimeoutOptions | undefined) => Promisestring | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) |\n| **`service`** | string | UUID of the service (see [UUID format](#uuid-format)) |\n| **`characteristic`** | string | UUID of the characteristic (see [UUID format](#uuid-format)) |\n| **`value`** | DataView | The value to write as a DataView. To create a DataView from an array of numbers, there is a helper function, e.g. numbersToDataView([1, 0]) |\n| **`options`** | TimeoutOptions | Options for plugin call |\n\n---\n\n### readDescriptor(...)\n\n```typescript\nreadDescriptor(deviceId: string, service: string, characteristic: string, descriptor: string, options?: TimeoutOptions | undefined) => Promisestring | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) |\n| **`service`** | string | UUID of the service (see [UUID format](#uuid-format)) |\n| **`characteristic`** | string | UUID of the characteristic (see [UUID format](#uuid-format)) |\n| **`descriptor`** | string | UUID of the descriptor (see [UUID format](#uuid-format)) |\n| **`options`** | TimeoutOptions | Options for plugin call |\n\n**Returns:** Promise<DataView>\n\n---\n\n### writeDescriptor(...)\n\n```typescript\nwriteDescriptor(deviceId: string, service: string, characteristic: string, descriptor: string, value: DataView, options?: TimeoutOptions | undefined) => Promisestring | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) |\n| **`service`** | string | UUID of the service (see [UUID format](#uuid-format)) |\n| **`characteristic`** | string | UUID of the characteristic (see [UUID format](#uuid-format)) |\n| **`descriptor`** | string | UUID of the descriptor (see [UUID format](#uuid-format)) |\n| **`value`** | DataView | The value to write as a DataView. To create a DataView from an array of numbers, there is a helper function, e.g. numbersToDataView([1, 0]) |\n| **`options`** | TimeoutOptions | Options for plugin call |\n\n---\n\n### startNotifications(...)\n\n```typescript\nstartNotifications(deviceId: string, service: string, characteristic: string, callback: (value: DataView) => void) => Promisestring | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) |\n| **`service`** | string | UUID of the service (see [UUID format](#uuid-format)) |\n| **`characteristic`** | string | UUID of the characteristic (see [UUID format](#uuid-format)) |\n| **`callback`** | (value: DataView) => void | Callback function to use when the value of the characteristic changes |\n\n---\n\n### stopNotifications(...)\n\n```typescript\nstopNotifications(deviceId: string, service: string, characteristic: string) => Promisestring | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) |\n| **`service`** | string | UUID of the service (see [UUID format](#uuid-format)) |\n| **`characteristic`** | string | UUID of the characteristic (see [UUID format](#uuid-format)) |\n\n---\n\n### Interfaces\n\n#### InitializeOptions","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/capacitor-community_bluetooth-le.md","loc":{"lines":{"from":861,"to":888}}}}],["3cb56375-0e08-49d3-bb51-98b92dc9746c",{"pageContent":"---\n\n### Interfaces\n\n#### InitializeOptions\n\n| Prop | Type | Description | Default |\n| ----------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------ |\n| **`androidNeverForLocation`** | boolean | If your app doesn't use Bluetooth scan results to derive physical location information, you can strongly assert that your app doesn't derive physical location. (Android only) Requires adding 'neverForLocation' to AndroidManifest.xml https://developer.android.com/guide/topics/connectivity/bluetooth/permissions#assert-never-for-location | false |\n\n#### DisplayStrings\n\n| Prop | Type | Default | Since |\n| ---------------------- | ------------------- | -------------------------------- | ----- |\n| **`scanning`** | string | \"Scanning...\" | 0.0.1 |\n| **`cancel`** | string | \"Cancel\" | 0.0.1 |\n| **`availableDevices`** | string | \"Available devices\" | 0.0.1 |\n| **`noDeviceFound`** | string | \"No device found\" | 0.0.1 |\n\n#### BleDevice\n\n| Prop | Type | Description |\n| -------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`deviceId`** | string | ID of the device, which will be needed for further calls. On **Android** this is the BLE MAC address. On **iOS** and **web** it is an identifier. |\n| **`name`** | string | Name of the peripheral device. |\n| **`uuids`** | string[] | |\n\n#### RequestBleDeviceOptions","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/capacitor-community_bluetooth-le.md","loc":{"lines":{"from":888,"to":915}}}}],["9173ded0-4a49-45b9-ae7f-10ebb6b0317b",{"pageContent":"#### RequestBleDeviceOptions\n\n| Prop | Type | Description |\n| ---------------------- | --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`services`** | string[] | Filter devices by service UUIDs. UUIDs have to be specified as 128 bit UUID strings, e.g. ['0000180d-0000-1000-8000-00805f9b34fb'] There is a helper function to convert numbers to UUIDs. e.g. [numberToUUID(0x180f)]. (see [UUID format](#uuid-format)) |\n| **`name`** | string | Filter devices by name |\n| **`namePrefix`** | string | Filter devices by name prefix |\n| **`optionalServices`** | string[] | For **web**, all services that will be used have to be listed under services or optionalServices, e.g. [numberToUUID(0x180f)] (see [UUID format](#uuid-format)) |\n| **`allowDuplicates`** | boolean | Normally scans will discard the second and subsequent advertisements from a single device. If you need to receive them, set allowDuplicates to true (only applicable in `requestLEScan`). (default: false) |\n| **`scanMode`** | ScanMode | Android scan mode (default: ScanMode.SCAN_MODE_BALANCED) |\n\n#### ScanResult","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/capacitor-community_bluetooth-le.md","loc":{"lines":{"from":915,"to":926}}}}],["8bc43cd0-abb9-4d90-a3ca-77f601c81da0",{"pageContent":"| Prop | Type | Description |\n| ---------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`device`** | BleDevice | The peripheral device that was found in the scan. **Android** and **web**: `device.name` is always identical to `localName`. **iOS**: `device.name` is identical to `localName` the first time a device is discovered, but after connecting `device.name` is the cached GAP name in subsequent scans. |\n| **`localName`** | string | The name of the peripheral device from the advertisement data. |\n| **`rssi`** | number | Received Signal Strength Indication. |\n| **`txPower`** | number | Transmit power in dBm. A value of 127 indicates that it is not available. |\n| **`manufacturerData`** | { [key: string]: DataView; } | Manufacturer data, key is a company identifier and value is the data. |","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/capacitor-community_bluetooth-le.md","loc":{"lines":{"from":928,"to":934}}}}],["17198f74-4987-4c1f-a74a-48dc917efc70",{"pageContent":"| **`serviceData`** | { [key: string]: DataView; } | Service data, key is a service UUID and value is the data. |\n| **`uuids`** | string[] | Advertised services. |\n| **`rawAdvertisement`** | DataView | Raw advertisement data (**Android** only). |","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/capacitor-community_bluetooth-le.md","loc":{"lines":{"from":935,"to":937}}}}],["cc6c7b20-a5ae-4afd-bce2-7f9b01517165",{"pageContent":"#### DataView\n\n| Prop | Type |\n| ---------------- | --------------------------------------------------- |\n| **`buffer`** | ArrayBuffer |\n| **`byteLength`** | number |\n| **`byteOffset`** | number |","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/capacitor-community_bluetooth-le.md","loc":{"lines":{"from":939,"to":945}}}}],["6e07f489-2697-4d2d-a38d-dfc4736ed259",{"pageContent":"| Method | Signature | Description |\n| -------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **getFloat32** | (byteOffset: number, littleEndian?: boolean \\| undefined) => number | Gets the Float32 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset. |\n| **getFloat64** | (byteOffset: number, littleEndian?: boolean \\| undefined) => number | Gets the Float64 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset. |\n| **getInt8** | (byteOffset: number) => number | Gets the Int8 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset. |\n| **getInt16** | (byteOffset: number, littleEndian?: boolean \\| undefined) => number | Gets the Int16 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset. |\n| **getInt32** | (byteOffset: number, littleEndian?: boolean \\| undefined) => number | Gets the Int32 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset. |\n| **getUint8** | (byteOffset: number) => number | Gets the Uint8 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset. |\n| **getUint16** | (byteOffset: number, littleEndian?: boolean \\| undefined) => number | Gets the Uint16 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset. |\n| **getUint32** | (byteOffset: number, littleEndian?: boolean \\| undefined) => number | Gets the Uint32 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset. |\n| **setFloat32** | (byteOffset: number, value: number, littleEndian?: boolean \\| undefined) => void | Stores an Float32 value at the specified byte offset from the start of the view. |","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/capacitor-community_bluetooth-le.md","loc":{"lines":{"from":947,"to":957}}}}],["0c4c8fbd-c6eb-4d77-be55-69a4944b248b",{"pageContent":"| **setFloat64** | (byteOffset: number, value: number, littleEndian?: boolean \\| undefined) => void | Stores an Float64 value at the specified byte offset from the start of the view. |\n| **setInt8** | (byteOffset: number, value: number) => void | Stores an Int8 value at the specified byte offset from the start of the view. |\n| **setInt16** | (byteOffset: number, value: number, littleEndian?: boolean \\| undefined) => void | Stores an Int16 value at the specified byte offset from the start of the view. |\n| **setInt32** | (byteOffset: number, value: number, littleEndian?: boolean \\| undefined) => void | Stores an Int32 value at the specified byte offset from the start of the view. |\n| **setUint8** | (byteOffset: number, value: number) => void | Stores an Uint8 value at the specified byte offset from the start of the view. |\n| **setUint16** | (byteOffset: number, value: number, littleEndian?: boolean \\| undefined) => void | Stores an Uint16 value at the specified byte offset from the start of the view. |\n| **setUint32** | (byteOffset: number, value: number, littleEndian?: boolean \\| undefined) => void | Stores an Uint32 value at the specified byte offset from the start of the view. |","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/capacitor-community_bluetooth-le.md","loc":{"lines":{"from":958,"to":964}}}}],["4213dd52-2780-4740-bf01-196a219664b2",{"pageContent":"#### ArrayBuffer\n\nRepresents a raw buffer of binary data, which is used to store data for the\ndifferent typed arrays. ArrayBuffers cannot be read from or written to directly,\nbut can be passed to a typed array or DataView Object to interpret the raw\nbuffer as needed.\n\n| Prop | Type | Description |\n| ---------------- | ------------------- | ------------------------------------------------------------------------------- |\n| **`byteLength`** | number | Read-only. The length of the ArrayBuffer (in bytes). |\n\n| Method | Signature | Description |\n| --------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------- |\n| **slice** | (begin: number, end?: number \\| undefined) => ArrayBuffer | Returns a section of an ArrayBuffer. |\n\n#### TimeoutOptions\n\n| Prop | Type | Description |\n| ------------- | ------------------- | ---------------------------------------------------------------------------------------------------------- |\n| **`timeout`** | number | Timeout in milliseconds for plugin call. Default is 10000 for `connect` and 5000 for other plugin methods. |\n\n#### BleService\n\n| Prop | Type |\n| --------------------- | -------------------------------- |\n| **`uuid`** | string |\n| **`characteristics`** | BleCharacteristic[] |\n\n#### BleCharacteristic\n\n| Prop | Type |\n| ----------------- | ----------------------------------------------------------------------------------- |\n| **`uuid`** | string |\n| **`properties`** | BleCharacteristicProperties |\n| **`descriptors`** | BleDescriptor[] |\n\n#### BleCharacteristicProperties","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/capacitor-community_bluetooth-le.md","loc":{"lines":{"from":966,"to":1002}}}}],["a21f08cb-676f-4c3b-aa49-ab0943b7b6f1",{"pageContent":"#### BleCharacteristicProperties\n\n| Prop | Type |\n| -------------------------------- | -------------------- |\n| **`broadcast`** | boolean |\n| **`read`** | boolean |\n| **`writeWithoutResponse`** | boolean |\n| **`write`** | boolean |\n| **`notify`** | boolean |\n| **`indicate`** | boolean |\n| **`authenticatedSignedWrites`** | boolean |\n| **`reliableWrite`** | boolean |\n| **`writableAuxiliaries`** | boolean |\n| **`extendedProperties`** | boolean |\n| **`notifyEncryptionRequired`** | boolean |\n| **`indicateEncryptionRequired`** | boolean |\n\n#### BleDescriptor\n\n| Prop | Type |\n| ---------- | ------------------- |\n| **`uuid`** | string |\n\n### Enums\n\n#### ScanMode\n\n| Members | Value | Description |\n| --------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`SCAN_MODE_LOW_POWER`** | 0 | Perform Bluetooth LE scan in low power mode. This mode is enforced if the scanning application is not in foreground. https://developer.android.com/reference/android/bluetooth/le/ScanSettings#SCAN_MODE_LOW_POWER |\n| **`SCAN_MODE_BALANCED`** | 1 | Perform Bluetooth LE scan in balanced power mode. (default) Scan results are returned at a rate that provides a good trade-off between scan frequency and power consumption. https://developer.android.com/reference/android/bluetooth/le/ScanSettings#SCAN_MODE_BALANCED |\n| **`SCAN_MODE_LOW_LATENCY`** | 2 | Scan using highest duty cycle. It's recommended to only use this mode when the application is running in the foreground. https://developer.android.com/reference/android/bluetooth/le/ScanSettings#SCAN_MODE_LOW_LATENCY |\n\n#### ConnectionPriority","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/capacitor-community_bluetooth-le.md","loc":{"lines":{"from":1002,"to":1035}}}}],["c60f1ba1-359f-461c-909a-70770bada8dd",{"pageContent":"#### ConnectionPriority\n\n| Members | Value | Description |\n| ----------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| **`CONNECTION_PRIORITY_BALANCED`** | 0 | Use the connection parameters recommended by the Bluetooth SIG. This is the default value if no connection parameter update is requested. https://developer.android.com/reference/android/bluetooth/BluetoothGatt#CONNECTION_PRIORITY_BALANCED |\n| **`CONNECTION_PRIORITY_HIGH`** | 1 | Request a high priority, low latency connection. An application should only request high priority connection parameters to transfer large amounts of data over LE quickly. Once the transfer is complete, the application should request CONNECTION_PRIORITY_BALANCED connection parameters to reduce energy use. https://developer.android.com/reference/android/bluetooth/BluetoothGatt#CONNECTION_PRIORITY_HIGH |\n| **`CONNECTION_PRIORITY_LOW_POWER`** | 2 | Request low power, reduced data rate connection parameters. https://developer.android.com/reference/android/bluetooth/BluetoothGatt#CONNECTION_PRIORITY_LOW_POWER |\n\n![\"pwespi\"/](\"https://avatars2.githubusercontent.com/u/24232962?v=4?s=100\") pwespi 💻 📖 | \n ![\"Dennis](\"https://avatars.githubusercontent.com/u/17739158?v=4?s=100\") Dennis Ameling 💻 | \n ![\"Johannes](\"https://avatars.githubusercontent.com/u/169410?v=4?s=100\") Johannes la Poutre 📖 💻 | \n ![\"Kasymbekov](\"https://avatars.githubusercontent.com/u/12681781?v=4?s=100\") Kasymbekov Sultanmyrza 💻 | \n ![\"Mutasim](\"https://avatars.githubusercontent.com/u/9040320?v=4?s=100\") Mutasim Issa 📖 | \n ![\"Marco](\"https://avatars.githubusercontent.com/u/1615301?v=4?s=100\") Marco Marche 💻 | \n ![\"Johannes](\"https://avatars.githubusercontent.com/u/13108477?v=4?s=100\") Johannes Koch 💻 | \n
![\"Johnny](\"https://avatars.githubusercontent.com/u/56908?v=4?s=100\") Johnny Robeson 💻 | \n ![\"Aadit](\"https://avatars.githubusercontent.com/u/63646058?v=4?s=100\") Aadit Olkar 💻 | \n ![\"Yoann](\"https://avatars.githubusercontent.com/u/18102153?v=4?s=100\") Yoann N. 💻 | \n ![\"Andy3189\"/](\"https://avatars.githubusercontent.com/u/2084016?v=4?s=100\") Andy3189 💻 | \n
Promise<PermissionStatus>\n\n--------------------\n\n\n### requestPermissions()\n\n```typescript\nrequestPermissions() => PromisePromise<PermissionStatus>\n\n--------------------\n\n\n### startVPN(...)\n\n```typescript\nstartVPN(options: { serverIP: string; serverPort: number; disallowedApp: string; excludeIP: string; }) => Promise{ serverIP: string; serverPort: number; disallowedApp: string; excludeIP: string; } |\n\n--------------------\n\n\n### stopVPN()\n\n```typescript\nstopVPN() => PromisePermissionState |\n\n\n### Type Aliases\n\n\n#### PermissionState\n\n'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'\n\n{ apiKey: string; logLevel?: 'error' \\| 'warn' \\| 'info' \\| 'verbose' \\| 'debug'; crashReportingEnabled?: boolean; appVersion?: string; iapReportingEnabled?: boolean; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logContentRated(...)\n\n```typescript\nlogContentRated(options: { contentId: string; contentRating: string; contentName?: string; contentType?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when a user rates a content in the App\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------------------------------------------------ |\n| **`options`** | { contentId: string; contentRating: string; contentName?: string; contentType?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logContentViewed(...)\n\n```typescript\nlogContentViewed(options: { contentId: string; contentName?: string; contentType?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when a specific content is viewed by a user\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------------------------- |\n| **`options`** | { contentId: string; contentName?: string; contentType?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logContentSaved(...)\n\n```typescript\nlogContentSaved(options: { contentId: string; contentName?: string; contentType?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when a user saves the content in the App\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------------------------- |\n| **`options`** | { contentId: string; contentName?: string; contentType?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logProductCustomized()","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/ajisakson_crowdhub-plugin-flurryanalytics.md","loc":{"lines":{"from":131,"to":204}}}}],["4b2de9b0-ce6d-42fa-a94a-0e90baf65aa5",{"pageContent":"**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logProductCustomized()\n\n```typescript\nlogProductCustomized() => Promise<{ value: string; }>\n```\n\nLog this event when a user customizes the App/product\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logSubscriptionStarted(...)\n\n```typescript\nlogSubscriptionStarted(options: { price: number; isAnnualSubscription: boolean; trialDays?: number; predictedLTV?: string; currencyType?: string; subscriptionCountry?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event at the start of a paid subscription for a service or product\n\n| Param | Type |\n| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`options`** | { price: number; isAnnualSubscription: boolean; trialDays?: number; predictedLTV?: string; currencyType?: string; subscriptionCountry?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logSubscriptionEnded(...)\n\n```typescript\nlogSubscriptionEnded(options: { isAnnualSubscription: boolean; currencyType?: string; subscriptionCountry?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when a user unsubscribes from a paid subscription for a service or product\n\n| Param | Type |\n| ------------- | ---------------------------------------------------------------------------------------------------- |\n| **`options`** | { isAnnualSubscription: boolean; currencyType?: string; subscriptionCountry?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logGroupJoined(...)\n\n```typescript\nlogGroupJoined(options: { groupName?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when user joins a group.\n\n| Param | Type |\n| ------------- | ------------------------------------ |\n| **`options`** | { groupName?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logGroupLeft(...)\n\n```typescript\nlogGroupLeft(options: { groupName?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when user leaves a group\n\n| Param | Type |\n| ------------- | ------------------------------------ |\n| **`options`** | { groupName?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logLogin(...)\n\n```typescript\nlogLogin(options: { userId?: string; method?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when a user login on the App","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/ajisakson_crowdhub-plugin-flurryanalytics.md","loc":{"lines":{"from":204,"to":296}}}}],["18438020-a0ed-4972-82f7-e6032f5cf06f",{"pageContent":"Log this event when a user login on the App\n\n| Param | Type |\n| ------------- | -------------------------------------------------- |\n| **`options`** | { userId?: string; method?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logLogout(...)\n\n```typescript\nlogLogout(options: { userId?: string; method?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when a user logout of the App\n\n| Param | Type |\n| ------------- | -------------------------------------------------- |\n| **`options`** | { userId?: string; method?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logUserRegistered(...)\n\n```typescript\nlogUserRegistered(options: { userId?: string; method?: string; }) => Promise<{ value: string; }>\n```\n\nLog the event when a user registers (signup). Helps capture the method used to sign-up (signup with google/apple or email address)\n\n| Param | Type |\n| ------------- | -------------------------------------------------- |\n| **`options`** | { userId?: string; method?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logSearchResultViewed(...)\n\n```typescript\nlogSearchResultViewed(options: { query?: string; searchType?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when user views search results\n\n| Param | Type |\n| ------------- | ----------------------------------------------------- |\n| **`options`** | { query?: string; searchType?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logKeywordSearched(...)\n\n```typescript\nlogKeywordSearched(options: { query?: string; searchType?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when a user searches for a keyword using Search\n\n| Param | Type |\n| ------------- | ----------------------------------------------------- |\n| **`options`** | { query?: string; searchType?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logLocationSearched(...)\n\n```typescript\nlogLocationSearched(options: { query?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when a user searches for a location using Search\n\n| Param | Type |\n| ------------- | -------------------------------- |\n| **`options`** | { query?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logInvite(...)\n\n```typescript\nlogInvite(options: { userId?: string; method?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when a user invites another user","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/ajisakson_crowdhub-plugin-flurryanalytics.md","loc":{"lines":{"from":296,"to":398}}}}],["34680f80-679c-4f19-ac92-cbff94266d2f",{"pageContent":"Log this event when a user invites another user\n\n| Param | Type |\n| ------------- | -------------------------------------------------- |\n| **`options`** | { userId?: string; method?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logShare(...)\n\n```typescript\nlogShare(options: { socialContentId: string; socialContentName?: string; method?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when a user shares content with another user in the App\n\n| Param | Type |\n| ------------- | -------------------------------------------------------------------------------------- |\n| **`options`** | { socialContentId: string; socialContentName?: string; method?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logLike(...)\n\n```typescript\nlogLike(options: { socialContentId: string; socialContentName?: string; likeType?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when a user likes a social content. e.g. likeType captures what kind of like is logged (“celebrate”, “insightful”, etc)\n\n| Param | Type |\n| ------------- | ---------------------------------------------------------------------------------------- |\n| **`options`** | { socialContentId: string; socialContentName?: string; likeType?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logComment(...)\n\n```typescript\nlogComment(options: { socialContentId: string; socialContentName?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when a user comments or replies on a social post\n\n| Param | Type |\n| ------------- | --------------------------------------------------------------------- |\n| **`options`** | { socialContentId: string; socialContentName?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logMediaCaptured(...)\n\n```typescript\nlogMediaCaptured(options: { mediaId?: string; mediaName?: string; mediaType?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when an image, audio or a video is captured\n\n| Param | Type |\n| ------------- | -------------------------------------------------------------------------- |\n| **`options`** | { mediaId?: string; mediaName?: string; mediaType?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logMediaStarted(...)\n\n```typescript\nlogMediaStarted(options: { mediaId?: string; mediaName?: string; mediaType?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when an audio or video starts","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/ajisakson_crowdhub-plugin-flurryanalytics.md","loc":{"lines":{"from":398,"to":483}}}}],["5316587f-5a33-4d95-beef-e7876b28b052",{"pageContent":"Log this event when an audio or video starts\n\n| Param | Type |\n| ------------- | -------------------------------------------------------------------------- |\n| **`options`** | { mediaId?: string; mediaName?: string; mediaType?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logMediaStopped(...)\n\n```typescript\nlogMediaStopped(options: { duration: number; mediaId?: string; mediaName?: string; mediaType?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when an audio or video is stopped\n\n| Param | Type |\n| ------------- | -------------------------------------------------------------------------------------------- |\n| **`options`** | { duration: number; mediaId?: string; mediaName?: string; mediaType?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logMediaPaused(...)\n\n```typescript\nlogMediaPaused(options: { duration: number; mediaId?: string; mediaName?: string; mediaType?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when an audio or video is paused\n\n| Param | Type |\n| ------------- | -------------------------------------------------------------------------------------------- |\n| **`options`** | { duration: number; mediaId?: string; mediaName?: string; mediaType?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logCustomEvent(...)\n\n```typescript\nlogCustomEvent(options: { eventName: string; eventParams?: { [key: string]: string; } | undefined; eventTimed?: boolean | undefined; }) => Promise<{ value: string; }>\n```\n\nLog a custom event in the app.\nYou may provide up to ten additional parameters as key/value pairs, both of which must be strings\nYou may also enable this event to be timed, calling endTimedEvent to terminate its logging\n\n| Param | Type |\n| ------------- | --------------------------------------------------------------------------------------------------- |\n| **`options`** | { eventName: string; eventParams?: { [key: string]: string; }; eventTimed?: boolean; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### endTimedEvent(...)\n\n```typescript\nendTimedEvent(options: { eventName: string; }) => Promise<{ value: string; }>\n```\n\n| Param | Type |\n| ------------- | ----------------------------------- |\n| **`options`** | { eventName: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### setUserId(...)\n\n```typescript\nsetUserId(options: { userId: string; }) => Promise<{ value: string; }>\n```","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/ajisakson_crowdhub-plugin-flurryanalytics.md","loc":{"lines":{"from":483,"to":566}}}}],["b0159a32-3527-4fd2-97d4-cd1d45ae1ced",{"pageContent":"### setUserId(...)\n\n```typescript\nsetUserId(options: { userId: string; }) => Promise<{ value: string; }>\n```\n\nAfter identifying the user, use this to log the user’s assigned ID or username in your system.\nYou must call this function prior to starting the Flurry session\n\n| Param | Type |\n| ------------- | -------------------------------- |\n| **`options`** | { userId: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### setAge(...)\n\n```typescript\nsetAge(options: { userAge: number; }) => Promise<{ value: string; }>\n```\n\nAfter identifying the user, use this to log the user’s age. Valid inputs are between 1 and 109.\nYou must call this function prior to starting the Flurry session\n\n| Param | Type |\n| ------------- | --------------------------------- |\n| **`options`** | { userAge: number; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### setGender(...)\n\n```typescript\nsetGender(options: { userGender: \"m\" | \"f\"; }) => Promise<{ value: string; }>\n```\n\nAfter identifying the user, use this to log the user’s gender. Valid inputs are m (male) or f (female).\nYou must call this function prior to starting the Flurry session\n\n| Param | Type |\n| ------------- | ---------------------------------------- |\n| **`options`** | { userGender: 'm' \\| 'f'; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logError(...)\n\n```typescript\nlogError(options: { errorId?: string; errorMessage?: string; error?: string; }) => Promise<{ value: string; }>\n```\n\nUse this to log exceptions and/or errors that occur in your app. Flurry will report the first 10 errors that occur in each session.\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------------------- |\n| **`options`** | { errorId?: string; errorMessage?: string; error?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logAdClick(...)\n\n```typescript\nlogAdClick(options: { adType?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when a user clicks on an Ad\n\n| Param | Type |\n| ------------- | --------------------------------- |\n| **`options`** | { adType?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logAdImpression(...)\n\n```typescript\nlogAdImpression(options: { adType?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when a user views an Ad impression\n\n| Param | Type |\n| ------------- | --------------------------------- |\n| **`options`** | { adType?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logAdRewarded(...)","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/ajisakson_crowdhub-plugin-flurryanalytics.md","loc":{"lines":{"from":566,"to":671}}}}],["94fce2b9-001a-4162-b136-4c0429573af7",{"pageContent":"**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logAdRewarded(...)\n\n```typescript\nlogAdRewarded(options: { adType?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when a user is granted a reward for viewing a rewarded Ad\n\n| Param | Type |\n| ------------- | --------------------------------- |\n| **`options`** | { adType?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logAdSkipped(...)\n\n```typescript\nlogAdSkipped(options: { adType?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when a user skips an Ad\n\n| Param | Type |\n| ------------- | --------------------------------- |\n| **`options`** | { adType?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logCreditsSpent(...)\n\n```typescript\nlogCreditsSpent(options: { levelNumber?: number; totalAmount: number; isCurrencySoft?: boolean; creditType?: string; creditId?: string; creditName?: string; currencyType?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when a user spends credit in the app\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`options`** | { levelNumber?: number; totalAmount: number; isCurrencySoft?: boolean; creditType?: string; creditId?: string; creditName?: string; currencyType?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logCreditsPurchased(...)\n\n```typescript\nlogCreditsPurchased(options: { levelNumber?: number; totalAmount: number; isCurrencySoft?: boolean; creditType?: string; creditId?: string; creditName?: string; currencyType?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when a user purchases credit in the app\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`options`** | { levelNumber?: number; totalAmount: number; isCurrencySoft?: boolean; creditType?: string; creditId?: string; creditName?: string; currencyType?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logCreditsEarned(...)","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/ajisakson_crowdhub-plugin-flurryanalytics.md","loc":{"lines":{"from":671,"to":744}}}}],["7f54d075-bd13-420c-9ce8-661ec1a1a582",{"pageContent":"**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logCreditsEarned(...)\n\n```typescript\nlogCreditsEarned(options: { levelNumber?: number; totalAmount: number; isCurrencySoft?: boolean; creditType?: string; creditId?: string; creditName?: string; currencyType?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when a user earns credit in the app\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`options`** | { levelNumber?: number; totalAmount: number; isCurrencySoft?: boolean; creditType?: string; creditId?: string; creditName?: string; currencyType?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logAchievementUnlocked(...)\n\n```typescript\nlogAchievementUnlocked(options: { achievementId?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when a user unlocks an achievement in the app\n\n| Param | Type |\n| ------------- | ---------------------------------------- |\n| **`options`** | { achievementId?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logLevelCompleted(...)\n\n```typescript\nlogLevelCompleted(options: { levelNumber: number; levelName?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when an App user completes a level\n\n| Param | Type |\n| ------------- | --------------------------------------------------------- |\n| **`options`** | { levelNumber: number; levelName?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logLevelFailed(...)\n\n```typescript\nlogLevelFailed(options: { levelNumber: number; levelName?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when an App user fails a level\n\n| Param | Type |\n| ------------- | --------------------------------------------------------- |\n| **`options`** | { levelNumber: number; levelName?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logLevelUp(...)\n\n```typescript\nlogLevelUp(options: { levelNumber: number; levelName?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when an App user levels up\n\n| Param | Type |\n| ------------- | --------------------------------------------------------- |\n| **`options`** | { levelNumber: number; levelName?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logLevelStarted(...)","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/ajisakson_crowdhub-plugin-flurryanalytics.md","loc":{"lines":{"from":744,"to":834}}}}],["d4d991e7-615d-49b7-be79-33f35cea1f85",{"pageContent":"**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logLevelStarted(...)\n\n```typescript\nlogLevelStarted(options: { levelNumber: number; levelName?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when an App user starts a level\n\n| Param | Type |\n| ------------- | --------------------------------------------------------- |\n| **`options`** | { levelNumber: number; levelName?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logLevelSkip(...)\n\n```typescript\nlogLevelSkip(options: { levelNumber: number; levelName?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when an App user skips a level\n\n| Param | Type |\n| ------------- | --------------------------------------------------------- |\n| **`options`** | { levelNumber: number; levelName?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logScorePosted(...)\n\n```typescript\nlogScorePosted(options: { levelNumber?: number; score: number; }) => Promise<{ value: string; }>\n```\n\nLog this event when an App user posts his score\n\n| Param | Type |\n| ------------- | ----------------------------------------------------- |\n| **`options`** | { levelNumber?: number; score: number; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logAppActivated()\n\n```typescript\nlogAppActivated() => Promise<{ value: string; }>\n```\n\nLog this event when the App is activated\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logApplicationSubmitted()\n\n```typescript\nlogApplicationSubmitted() => Promise<{ value: string; }>\n```\n\nLog this event when a user submits an application through the App\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logAddItemToCart(...)\n\n```typescript\nlogAddItemToCart(options: { itemCount: number; price: number; itemId?: string; itemName?: string; itemType?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when an item is added to the cart\n\n| Param | Type |\n| ------------- | --------------------------------------------------------------------------------------------------------- |\n| **`options`** | { itemCount: number; price: number; itemId?: string; itemName?: string; itemType?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logAddItemToWishList(...)\n\n```typescript\nlogAddItemToWishList(options: { itemCount: number; price: number; itemId?: string; itemName?: string; itemType?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when an item is added to the wish list","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/ajisakson_crowdhub-plugin-flurryanalytics.md","loc":{"lines":{"from":834,"to":939}}}}],["3c832bf0-038d-428b-9401-07ac3a05fd00",{"pageContent":"Log this event when an item is added to the wish list\n\n| Param | Type |\n| ------------- | --------------------------------------------------------------------------------------------------------- |\n| **`options`** | { itemCount: number; price: number; itemId?: string; itemName?: string; itemType?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logCompletedCheckout(...)\n\n```typescript\nlogCompletedCheckout(options: { itemCount: number; totalAmount: number; currencyType?: string; transactionId?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when checkout is completed or transaction is successfully completed\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------------------------------------------------- |\n| **`options`** | { itemCount: number; totalAmount: number; currencyType?: string; transactionId?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logPaymentInfoAdded(...)\n\n```typescript\nlogPaymentInfoAdded(options: { success: boolean; paymentType: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when payment information is added during a checkout process\n\n| Param | Type |\n| ------------- | ------------------------------------------------------- |\n| **`options`** | { success: boolean; paymentType: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logItemViewed(...)\n\n```typescript\nlogItemViewed(options: { price?: number; itemId: string; itemName?: string; itemType?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when an item is viewed\n\n| Param | Type |\n| ------------- | -------------------------------------------------------------------------------------- |\n| **`options`** | { price?: number; itemId: string; itemName?: string; itemType?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logItemListViewed(...)\n\n```typescript\nlogItemListViewed(options: { itemListType: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when a list of items is viewed\n\n| Param | Type |\n| ------------- | -------------------------------------- |\n| **`options`** | { itemListType: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logPurchased(...)","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/ajisakson_crowdhub-plugin-flurryanalytics.md","loc":{"lines":{"from":939,"to":1018}}}}],["5372a024-3a2f-4498-8232-bace9c6e7b7f",{"pageContent":"**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logPurchased(...)\n\n```typescript\nlogPurchased(options: { totalAmount: number; success: boolean; itemCount?: number; itemId?: string; itemName?: string; itemType?: string; currencyType?: string; transactionId?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when a user does a purchase in the App\n\n| Param | Type |\n| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`options`** | { totalAmount: number; success: boolean; itemCount?: number; itemId?: string; itemName?: string; itemType?: string; currencyType?: string; transactionId?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logPurchaseRefunded(...)\n\n```typescript\nlogPurchaseRefunded(options: { price: number; currencyType?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when a purchase is refunded\n\n| Param | Type |\n| ------------- | ------------------------------------------------------ |\n| **`options`** | { price: number; currencyType?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logRemoveItemFromCart(...)\n\n```typescript\nlogRemoveItemFromCart(options: { price?: number; itemId: string; itemName?: string; itemType?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when a user removes an item from the cart\n\n| Param | Type |\n| ------------- | -------------------------------------------------------------------------------------- |\n| **`options`** | { price?: number; itemId: string; itemName?: string; itemType?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logCheckoutInitiated(...)\n\n```typescript\nlogCheckoutInitiated(options: { itemCount: number; totalAmount: number; }) => Promise<{ value: string; }>\n```\n\nLog this event when a user starts checkout\n\n| Param | Type |\n| ------------- | -------------------------------------------------------- |\n| **`options`** | { itemCount: number; totalAmount: number; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logFundsDonated(...)\n\n```typescript\nlogFundsDonated(options: { price: number; currencyType?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when a user donates fund to your App or through the App","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/ajisakson_crowdhub-plugin-flurryanalytics.md","loc":{"lines":{"from":1018,"to":1097}}}}],["c8a8435b-cbed-4eae-b3e2-1807abcb27f6",{"pageContent":"Log this event when a user donates fund to your App or through the App\n\n| Param | Type |\n| ------------- | ------------------------------------------------------ |\n| **`options`** | { price: number; currencyType?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logUserScheduled()\n\n```typescript\nlogUserScheduled() => Promise<{ value: string; }>\n```\n\nLog this event when user schedules an appointment using the App\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logOfferPresented(...)\n\n```typescript\nlogOfferPresented(options: { price: number; itemId: string; itemName?: string; itemCategory?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when an offer is presented to the user\n\n| Param | Type |\n| ------------- | ----------------------------------------------------------------------------------------- |\n| **`options`** | { price: number; itemId: string; itemName?: string; itemCategory?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logTutorialStarted(...)\n\n```typescript\nlogTutorialStarted(options: { tutorialName?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when a user starts a tutorial\n\n| Param | Type |\n| ------------- | --------------------------------------- |\n| **`options`** | { tutorialName?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logTutorialCompleted(...)\n\n```typescript\nlogTutorialCompleted(options: { tutorialName?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when a user completes a tutorial\n\n| Param | Type |\n| ------------- | --------------------------------------- |\n| **`options`** | { tutorialName?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logTutorialStepCompleted(...)\n\n```typescript\nlogTutorialStepCompleted(options: { stepNumber: number; tutorialName?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when a specific tutorial step is completed\n\n| Param | Type |\n| ------------- | ----------------------------------------------------------- |\n| **`options`** | { stepNumber: number; tutorialName?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logTutorialSkipped(...)\n\n```typescript\nlogTutorialSkipped(options: { stepNumber: number; tutorialName?: string; }) => Promise<{ value: string; }>\n```\n\nLog this event when user skips the tutorial","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/ajisakson_crowdhub-plugin-flurryanalytics.md","loc":{"lines":{"from":1097,"to":1195}}}}],["22d4deaa-a954-47db-9b75-9aac0c7e6ad5",{"pageContent":"Log this event when user skips the tutorial\n\n| Param | Type |\n| ------------- | ----------------------------------------------------------- |\n| **`options`** | { stepNumber: number; tutorialName?: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logPrivacyPromptDisplayed()\n\n```typescript\nlogPrivacyPromptDisplayed() => Promise<{ value: string; }>\n```\n\nLog this event when a privacy prompt is displayed\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logPrivacyOptIn()\n\n```typescript\nlogPrivacyOptIn() => Promise<{ value: string; }>\n```\n\nLog this event when a user opts in (on the privacy prompt)\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### logPrivacyOptOut()\n\n```typescript\nlogPrivacyOptOut() => Promise<{ value: string; }>\n```\n\nLog this event when a user opts out (on the privacy prompt)\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\nCreateMapArgs |\n\n--------------------\n\n\n### addCircle(...)\n\n```typescript\naddCircle(args: CircleOptions) => PromiseCircleOptions |\n\n--------------------\n\n\n### addMarker(...)\n\n```typescript\naddMarker(args: AddMarkerArgs) => Promise<{ id: string; }>\n```\n\n| Param | Type |\n| ---------- | ------------------------------------------------------- |\n| **`args`** | AddMarkerArgs |\n\n**Returns:** Promise<{ id: string; }>\n\n--------------------\n\n\n### addMarkers(...)\n\n```typescript\naddMarkers(args: AddMarkersArgs) => Promise<{ ids: string[]; }>\n```\n\n| Param | Type |\n| ---------- | --------------------------------------------------------- |\n| **`args`** | AddMarkersArgs |\n\n**Returns:** Promise<{ ids: string[]; }>\n\n--------------------\n\n\n### removeMarker(...)\n\n```typescript\nremoveMarker(args: RemoveMarkerArgs) => PromiseRemoveMarkerArgs |\n\n--------------------\n\n\n### removeMarkers(...)\n\n```typescript\nremoveMarkers(args: RemoveMarkersArgs) => PromiseRemoveMarkersArgs |\n\n--------------------\n\n\n### enableClustering(...)\n\n```typescript\nenableClustering(args: { id: string; }) => Promise{ id: string; } |\n\n--------------------\n\n\n### disableClustering(...)\n\n```typescript\ndisableClustering(args: { id: string; }) => Promise{ id: string; } |\n\n--------------------\n\n\n### destroy(...)\n\n```typescript\ndestroy(args: DestroyMapArgs) => PromiseDestroyMapArgs |\n\n--------------------\n\n\n### setCamera(...)\n\n```typescript\nsetCamera(args: CameraArgs) => PromiseCameraArgs |\n\n--------------------\n\n\n### setMapType(...)\n\n```typescript\nsetMapType(args: MapTypeArgs) => PromiseMapTypeArgs |\n\n--------------------\n\n\n### enableIndoorMaps(...)\n\n```typescript\nenableIndoorMaps(args: IndoorMapArgs) => PromiseIndoorMapArgs |\n\n--------------------\n\n\n### enableTrafficLayer(...)\n\n```typescript\nenableTrafficLayer(args: TrafficLayerArgs) => PromiseTrafficLayerArgs |\n\n--------------------\n\n\n### enableAccessibilityElements(...)\n\n```typescript\nenableAccessibilityElements(args: AccElementsArgs) => PromiseAccElementsArgs |\n\n--------------------\n\n\n### enableCurrentLocation(...)\n\n```typescript\nenableCurrentLocation(args: CurrentLocArgs) => PromiseCurrentLocArgs |\n\n--------------------\n\n\n### setMyLocationButtonEnabled(...)\n\n```typescript\nsetMyLocationButtonEnabled(args: CurrentLocArgs) => PromiseCurrentLocArgs |\n\n--------------------\n\n\n### setPadding(...)\n\n```typescript\nsetPadding(args: PaddingArgs) => PromisePaddingArgs |\n\n--------------------\n\n\n### onScroll(...)\n\n```typescript\nonScroll(args: OnScrollArgs) => PromiseOnScrollArgs |\n\n--------------------\n\n\n### dispatchMapEvent(...)\n\n```typescript\ndispatchMapEvent(args: { id: string; focus: boolean; }) => Promise{ id: string; focus: boolean; } |\n\n--------------------\n\n\n### getMapBounds(...)\n\n```typescript\ngetMapBounds(args: { id: string; }) => Promise{ id: string; } |\n\n**Returns:** Promise<LatLngBounds>\n\n--------------------\n\n\n### checkMockLocation(...)\n\n```typescript\ncheckMockLocation(args: { id: string; }) => Promise<{ isMockLocation: boolean; }>\n```\n\n| Param | Type |\n| ---------- | ---------------------------- |\n| **`args`** | { id: string; } |\n\n**Returns:** Promise<{ isMockLocation: boolean; }>\n\n--------------------\n\n\n### Interfaces\n\n\n#### CreateMapArgs\n\nAn interface containing the options used when creating a map.","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/nasasutisna_capacitor-custom-google-maps.md","loc":{"lines":{"from":231,"to":344}}}}],["0babbb8e-a087-4e0c-8d18-c6ee855abd4f",{"pageContent":"--------------------\n\n\n### Interfaces\n\n\n#### CreateMapArgs\n\nAn interface containing the options used when creating a map.\n\n| Prop | Type | Description | Default |\n| ----------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ------------------ |\n| **`id`** | string | A unique identifier for the map instance. | |\n| **`apiKey`** | string | The Google Maps SDK API Key. | |\n| **`config`** | GoogleMapConfig | The initial configuration settings for the map. | |\n| **`element`** | HTMLElement | The DOM element that the Google Map View will be mounted on which determines size and positioning. | |\n| **`forceCreate`** | boolean | Destroy and re-create the map instance if a map with the supplied id already exists | false |\n\n\n#### GoogleMapConfig\n\nFor web, all the javascript Google Maps options are available as\nGoogleMapConfig extends google.maps.MapOptions.\nFor iOS and Android only the config options declared on GoogleMapConfig are available.","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/nasasutisna_capacitor-custom-google-maps.md","loc":{"lines":{"from":344,"to":367}}}}],["480d307f-2fec-491d-9f7f-0738ed849204",{"pageContent":"| Prop | Type | Description | Default | Since |\n| ---------------------- | ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |\n| **`width`** | number | Override width for native map. | | |\n| **`height`** | number | Override height for native map. | | |\n| **`x`** | number | Override absolute x coordinate position for native map. | | |\n| **`y`** | number | Override absolute y coordinate position for native map. | | |\n| **`center`** | LatLng | Default location on the Earth towards which the camera points. | | |\n| **`zoom`** | number | Sets the zoom of the map. | | |\n| **`androidLiteMode`** | boolean | Enables image-based lite mode on Android. | false | |\n| **`devicePixelRatio`** | number | Override pixel ratio for native map. | | |\n| **`styles`** | MapTypeStyle[] \\| null | Styles to apply to each of the default map types. Note that for satellite, hybrid and terrain modes, these styles will only apply to labels and geometry. | | 4.3.0 |\n\n\n#### LatLng\n\nAn interface representing a pair of latitude and longitude coordinates.","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/nasasutisna_capacitor-custom-google-maps.md","loc":{"lines":{"from":369,"to":384}}}}],["a714a1dd-ced1-48df-b58e-ee84db7bc686",{"pageContent":"#### LatLng\n\nAn interface representing a pair of latitude and longitude coordinates.\n\n| Prop | Type | Description |\n| --------- | ------------------- | ------------------------------------------------------------------------- |\n| **`lat`** | number | Coordinate latitude, in degrees. This value is in the range [-90, 90]. |\n| **`lng`** | number | Coordinate longitude, in degrees. This value is in the range [-180, 180]. |\n\n\n#### CircleOptions\n\nAn interface representing the viewports latitude and longitude bounds.\n\n| Prop | Type |\n| ----------------- | ----------------------------------------- |\n| **`radius`** | number |\n| **`mapId`** | string |\n| **`center`** | LatLng |\n| **`fillColor`** | string |\n| **`strokeColor`** | string |\n| **`strokeWidth`** | number |\n\n\n#### AddMarkerArgs\n\n| Prop | Type |\n| ------------ | ----------------------------------------- |\n| **`id`** | string |\n| **`marker`** | Marker |\n\n\n#### Marker\n\nA marker is an icon placed at a particular point on the map's surface.","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/nasasutisna_capacitor-custom-google-maps.md","loc":{"lines":{"from":384,"to":418}}}}],["f28de01c-711b-4f52-b201-18bd2f195916",{"pageContent":"| Prop | Type | Description | Default | Since |\n| ---------------- | ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |\n| **`coordinate`** | LatLng | Marker position | | |\n| **`opacity`** | number | Sets the opacity of the marker, between 0 (completely transparent) and 1 inclusive. | 1 | |\n| **`title`** | string | Title, a short description of the overlay. | | |\n| **`snippet`** | string | Snippet text, shown beneath the title in the info window when selected. | | |\n| **`isFlat`** | boolean | Controls whether this marker should be flat against the Earth's surface or a billboard facing the camera. | false | |\n| **`iconUrl`** | string | Path to a marker icon to render. It can be relative to the web app public directory, or a https url of a remote marker icon. **SVGs are not supported on native platforms.** | | 4.2.0 |\n| **`iconSize`** | Size | Controls the scaled size of the marker image set in `iconUrl`. | | 4.2.0 |\n| **`iconOrigin`** | Point | The position of the image within a sprite, if any. By default, the origin is located at the top left corner of the image . | | 4.2.0 |","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/nasasutisna_capacitor-custom-google-maps.md","loc":{"lines":{"from":420,"to":429}}}}],["af6dab5f-6535-49dc-b4dd-dacd43156bc2",{"pageContent":"| **`iconAnchor`** | Point | The position at which to anchor an image in correspondence to the location of the marker on the map. By default, the anchor is located along the center point of the bottom of the image. | | 4.2.0 |\n| **`tintColor`** | { r: number; g: number; b: number; a: number; } | Customizes the color of the default marker image. Each value must be between 0 and 255. Only for iOS and Android. | | 4.2.0 |\n| **`draggable`** | boolean | Controls whether this marker can be dragged interactively | false | |","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/nasasutisna_capacitor-custom-google-maps.md","loc":{"lines":{"from":430,"to":432}}}}],["0465e95a-d186-4a31-b38a-2d179a063ece",{"pageContent":"#### Size\n\n| Prop | Type |\n| ------------ | ------------------- |\n| **`width`** | number |\n| **`height`** | number |\n\n\n#### Point\n\n| Prop | Type |\n| ------- | ------------------- |\n| **`x`** | number |\n| **`y`** | number |\n\n\n#### AddMarkersArgs\n\n| Prop | Type |\n| ------------- | --------------------- |\n| **`id`** | string |\n| **`markers`** | Marker[] |\n\n\n#### RemoveMarkerArgs\n\n| Prop | Type |\n| -------------- | ------------------- |\n| **`id`** | string |\n| **`markerId`** | string |\n\n\n#### RemoveMarkersArgs\n\n| Prop | Type |\n| --------------- | --------------------- |\n| **`id`** | string |\n| **`markerIds`** | string[] |\n\n\n#### DestroyMapArgs\n\n| Prop | Type |\n| -------- | ------------------- |\n| **`id`** | string |\n\n\n#### CameraArgs\n\n| Prop | Type |\n| ------------ | ----------------------------------------------------- |\n| **`id`** | string |\n| **`config`** | CameraConfig |\n\n\n#### CameraConfig\n\nConfiguration properties for a Google Map Camera","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/nasasutisna_capacitor-custom-google-maps.md","loc":{"lines":{"from":435,"to":492}}}}],["c4f01399-924c-4de3-aab8-0012ce9e52c2",{"pageContent":"#### CameraConfig\n\nConfiguration properties for a Google Map Camera\n\n| Prop | Type | Description | Default |\n| ----------------------- | ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------ |\n| **`coordinate`** | LatLng | Location on the Earth towards which the camera points. | |\n| **`zoom`** | number | Sets the zoom of the map. | |\n| **`bearing`** | number | Bearing of the camera, in degrees clockwise from true north. | 0 |\n| **`angle`** | number | The angle, in degrees, of the camera from the nadir (directly facing the Earth). The only allowed values are 0 and 45. | 0 |\n| **`animate`** | boolean | Animate the transition to the new Camera properties. | false |\n| **`animationDuration`** | number | This configuration option is not being used. | |\n\n\n#### MapTypeArgs\n\n| Prop | Type |\n| ------------- | ------------------------------------------- |\n| **`id`** | string |\n| **`mapType`** | MapType |\n\n\n#### IndoorMapArgs\n\n| Prop | Type |\n| ------------- | -------------------- |\n| **`id`** | string |\n| **`enabled`** | boolean |\n\n\n#### TrafficLayerArgs\n\n| Prop | Type |\n| ------------- | -------------------- |\n| **`id`** | string |\n| **`enabled`** | boolean |\n\n\n#### AccElementsArgs\n\n| Prop | Type |\n| ------------- | -------------------- |\n| **`id`** | string |\n| **`enabled`** | boolean |\n\n\n#### CurrentLocArgs\n\n| Prop | Type |\n| ------------- | -------------------- |\n| **`id`** | string |\n| **`enabled`** | boolean |\n\n\n#### PaddingArgs","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/nasasutisna_capacitor-custom-google-maps.md","loc":{"lines":{"from":492,"to":546}}}}],["58ff6b1d-f8d5-4178-9cd8-706ec9e5940d",{"pageContent":"#### PaddingArgs\n\n| Prop | Type |\n| ------------- | ------------------------------------------------- |\n| **`id`** | string |\n| **`padding`** | MapPadding |\n\n\n#### MapPadding\n\nControls for setting padding on the 'visible' region of the view.\n\n| Prop | Type |\n| ------------ | ------------------- |\n| **`top`** | number |\n| **`left`** | number |\n| **`right`** | number |\n| **`bottom`** | number |\n\n\n#### OnScrollArgs\n\n| Prop | Type |\n| --------------- | --------------------------------------------------------------------- |\n| **`id`** | string |\n| **`mapBounds`** | { x: number; y: number; width: number; height: number; } |\n\n\n#### LatLngBounds\n\nAn interface representing the viewports latitude and longitude bounds.\n\n| Prop | Type |\n| --------------- | ----------------------------------------- |\n| **`southwest`** | LatLng |\n| **`center`** | LatLng |\n| **`northeast`** | LatLng |\n\n\n### Enums\n\n\n#### MapType\n\n| Members | Value | Description |\n| --------------- | ------------------------ | ---------------------------------------- |\n| **`Normal`** | 'Normal' | Basic map. |\n| **`Hybrid`** | 'Hybrid' | Satellite imagery with roads and labels. |\n| **`Satellite`** | 'Satellite' | Satellite imagery with no labels. |\n| **`Terrain`** | 'Terrain' | Topographic data. |\n| **`None`** | 'None' | No base map tiles. |\n\n\n\n# capacitor-native-decorator [](https://badge.fury.io/js/@aparajita%2Fcapacitor-native-decorator)\n\n### ❗️This package is now deprecated. Please read below if you are using Capacitor 4.\n\nAfter spending many hours tracing through and reading through the Capacitor 4 source code and doing some experimentation with different coding conventions, I have come to the conclusion that this package is no longer needed.\n\n### Issues this package was originally designed to solve\n\nThis package was originally created to solve several issues:\n\n1. The need to manually maintain the `Plugin.m` file for iOS.\n2. The inability to use non-native methods in a class on native platforms.\n3. The necessity to unwrap single return values from an object.\n\n#1 was a convenient side-effect of solving #2 and #3. In reality, it isn’t that important, as the API for a plugin doesn’t change that much.\n\n#2 is no longer a problem with Capacitor 4. You can call any method on a plugin object, even if it’s not native.\n\n#3 is easily solved by using object deconstruction.\n\n### Issues created by this package\n\nThere are three issues this package created:\n\n1. It was relying on private API within Capacitor that could change in the future, thus preventing users of this package from upgrading to the latest version of Capacitor.\n2. It was circumventing the Capacitor plugin method calling mechanism entirely, which eventually could lead to unexpected behavior in future versions of Capacitor.\n3. It did not support lazy loading of plugins, which is now the recommended way.\n\nUsing standard Capacitor mechanisms instead of this package solves all of these issues.\n\n> **Note:** When plugins are lazy loaded, **all** of the methods in the plugin class must be async and return a Promise.\n\n### The remaining Capacitor issue\n\nThere is one problem with Capacitor 4 that needs to be solved if you want to get the most flexibility in your plugins. While you **can** call non-native methods in a plugin class, because of the way Capacitor implements plugins, within non-native plugin methods you **can’t** call native methods via `this`.\n\nWhy would you want to do this? There are two main advantages:\n\n- It allows you to create hybrid plugins that are part TypeScript, part native code. By putting as much functionality in TypeScript as possible, that’s one less language in which to write and test code.\n- You can use TypeScript methods to provide a more natural syntax for calling native methods, as is shown in the example below.\n\nThis can be achieved by storing the plugin reference returned by `registerPlugin` (which is actually a bare Proxy) inside your plugin class and calling native methods via that reference. Here is an example of how to do this:\n\n```typescript\n// definitions.ts\nexport interface AwesomePlugin extends WebPlugin {\n setItem(key: string, value: unknown): Promise\n getItem(key: string): Promise\n}","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/aparajita_capacitor-native-decorator.md","loc":{"lines":{"from":1,"to":51}}}}],["1f1a48c6-0c74-4be9-896f-98694106cb6a",{"pageContent":"// base.ts\nexport abstract class AwesomeBase extends WebPlugin implements AwesomePlugin {\n private readonly _plugin: AwesomePlugin\n\n constructor(plugin: AwesomePlugin) {\n super()\n this._plugin = plugin\n }\n\n abstract setItem(key: string, value: unknown): Promise\n\n abstract getItem(key: string): Promise\n}\n\n// web.ts\nexport class AwesomeWeb extends AwesomeBase {\n async setItem(key: string, value: unknown): Promise {\n return localStorage.setItem(key, value)\n }\n\n async getItem(key: string): Promise {\n return Promise.resolve(localStorage.getItem(key))\n }\n}\n\n// native.ts\nexport class AwesomeNative extends AwesomeBase {\n async nativeSetItem({\n key,\n value\n }: {\n key: string\n value: unknown\n }): Promise {\n // Code is never called, but we have to keep TS happy\n return Promise.resolve()\n }\n\n async setItem(key: string, value: unknown): Promise {\n // We can't use `this` directly, we have to use the Capacitor plugin reference\n return this._plugin.nativeSetItem({ key, value })\n }\n\n async nativeGetItem({ key }: { key: string }): Promise {\n // Code is never called, but we have to keep TS happy\n return Promise.resolve(undefined)\n }\n\n async getItem(key: string): Promise {\n // We can't use `this` directly, we have to use the Capacitor plugin reference\n const { value } = await this._plugin.nativeGetItem({ key })\n return Promise.resolve(value)\n }\n}\n\n// index.ts\nimport { registerPlugin } from '@capacitor/core'\nimport type { AwesomePlugin } from './definitions'\n\nconst proxy = registerPlugin('AwesomeNative', {\n web: async () =>\n import('./web').then((module) => new module.AwesomeWeb(proxy)),\n ios: async () =>\n import('./native').then((module) => new module.AwesomeNative(proxy)),\n android: async () =>\n import('./native').then((module) => new module.AwesomeNative(proxy))\n})\n\nexport * from './definitions'\nexport { proxy as Awesome }\n\n// somefile.ts\nimport { Awesome } from '@awesome/awesome'\n\nasync function setCredentials(credentials: {\n username: string\n password: string\n}) {\n await Awesome.setItem('credentials', JSON.stringify(credentials))\n}\n\nasync function getCredentials(): Promise<{\n username: string\n password: string\n}> {\n const credentials = await Awesome.getItem('credentials')\n return JSON.parse(credentials)\n}\n```\n\n```swift\n// ios/Plugin/Plugin.m\n#import \n#import \n\nCAP_PLUGIN(AwesomeNative, \"AwesomeNative\",\n CAP_PLUGIN_METHOD(nativeSetItem, CAPPluginReturnPromise);\n CAP_PLUGIN_METHOD(nativeGetItem, CAPPluginReturnPromise);\n)\n```\n\nAnd so on with the other native files. Some examples:\n\n[capacitor-biometric-auth](https://github.com/aparajita/capacitor-biometric-auth)\n\n
","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/aparajita_capacitor-native-decorator.md","loc":{"lines":{"from":53,"to":158}}}}],["1d34967f-1b13-4463-8101-55f2eda51c54",{"pageContent":"# sqlite-electron","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/DevAashishCodes_sqlite-electron.md","loc":{"lines":{"from":1,"to":1}}}}],["2c3e4170-b0a8-4404-bf82-f8e9c400f9d8",{"pageContent":"# Capacitor File Picker\n\n## Description\n\nPresents the device's native file picking ui and returns the selected file's uri.\n\n## Installation\n\n- `npm i capacitor2-file-picker --save`\n\nFor Capacitor V3\n\n- `npm i filepicker-updated --save`\n- `https://github.com/mantosh59/capacitor-file-picker`\n\n## Usage\n\n```ts\nimport { Plugins } from \"@capacitor/core\";\n\nconst { FilePicker } = Plugins;\n\nFilePicker.showFilePicker({\n fileTypes: [\"image/*\", \"application/pdf\"],\n}).then(\n (fileResult: FilePickerResult) => {\n const fileUri = fileResult.uri;\n const fileName = fileResult.name;\n const fileMimeType = fileResult.mimeType;\n const fileExtension = fileResult.extension;\n const fileSize = fileResult.size;\n },\n (error) => {\n console.log(error);\n }\n);\n```\n \n## Android\n\nRegister the plugin by adding it to your MainActivity's onCreate:\n\n```java\nimport com.devmantosh.filepicker.FilePicker;\n\npublic class MainActivity extends BridgeActivity {\n @Override\n public void onCreate(Bundle savedInstanceState) {\n super.onCreate(savedInstanceState);\n\n // Initializes the Bridge\n this.init(savedInstanceState, new ArrayList
Google Maps
\n@capacitor-community/google-maps
Capacitor Plugin using native Google Maps SDK for Android and iOS.
\n\n
\n\n\n ![](\"https://img.shields.io/badge/Capacitor%20V3%20Support-yes-green?logo=Capacitor&style=flat-square\"){kind=icon}
![](\"https://img.shields.io/github/workflow/status/capacitor-community/google-maps/Build?style=flat-square\")
![](\"https://img.shields.io/npm/l/@capacitor-community/google-maps?style=flat-square\")
\n ![](\"https://img.shields.io/npm/dw/@capacitor-community/google-maps?style=flat-square\")
![](\"https://img.shields.io/npm/v/@capacitor-community/google-maps?style=flat-square\")
![](\"https://img.shields.io/badge/all%20contributors-13-orange?style=flat-square\"){kind=icon}
App Actions
\ncapacitor-app-actions
\n Capacitor iOS and Android Plugin for App Actions\n
\n\n\n ![](\"https://img.shields.io/maintenance/yes/2021?style=flat-square\")
![](\"https://img.shields.io/github/workflow/status/uioporqwerty/capacitor-app-actions/Plugin-CI?style=flat-square\")
![](\"https://img.shields.io/npm/l/capacitor-app-actions?style=flat-square\")
\n ![](\"https://img.shields.io/npm/dw/capacitor-app-actions?style=flat-square\")
![](\"https://img.shields.io/npm/v/capacitor-app-actions?style=flat-square\")
![](\"https://img.shields.io/badge/all%20contributors-1-orange?style=flat-square\"){kind=icon}
![\"\"/](\"https://avatars.githubusercontent.com/u/4053751?v=4?s=100\") Nitish Sachar 🚧 💻 | \n
LocationCameraOptions |\n\n**Returns:** Promise<any>\n\n--------------------\n\n\n### getLocationCameraSwap(...)\n\n```typescript\ngetLocationCameraSwap(options?: LocationCameraOptions | undefined) => PromiseLocationCameraOptions |\n\n**Returns:** Promise<any>\n\n--------------------\n\n\n### getLocationRadiusCamera(...)\n\n```typescript\ngetLocationRadiusCamera(options?: LocationRadiusCameraOptions | undefined) => PromiseLocationRadiusCameraOptions |\n\n**Returns:** Promise<any>\n\n--------------------\n\n\n### getLocationRadiusCameraSwap(...)\n\n```typescript\ngetLocationRadiusCameraSwap(options?: LocationRadiusCameraOptions | undefined) => PromiseLocationRadiusCameraOptions |\n\n**Returns:** Promise<any>\n\n--------------------\n\n\n### Interfaces\n\n\n#### LocationCameraOptions\n\n| Prop | Type |\n| --------------- | ------------------- |\n| **`photoName`** | string |\n| **`quality`** | string |\n| **`maxSize`** | string |\n\n\n#### LocationRadiusCameraOptions","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/asephermann_capacitor-greatday-camera-location.md","loc":{"lines":{"from":1,"to":99}}}}],["374c49a5-7529-471a-ba14-8d7a7633f070",{"pageContent":"#### LocationRadiusCameraOptions\n\n| Prop | Type |\n| ----------------- | -------------------- |\n| **`photoName`** | string |\n| **`quality`** | string |\n| **`maxSize`** | string |\n| **`location`** | string |\n| **`label1`** | string |\n| **`label2`** | string |\n| **`showAddress`** | boolean |\n\nLorem
'})\n```\n\nSuggestion for multiple lines:\n```typescript\n let contentTest: string = \"\";\n\n contentTest += 'PrintOptions |\n\n--------------------\n\n\n### Interfaces\n\n\n#### PrintOptions\n\n| Prop | Type | Description | Default | Since |\n| ----------------- | ------------------- | ----------------------------------------------------------- | -------------------------------------------------------------- | ----- |\n| **`content`** | string | HTML content for print. | | 0.0.1 |\n| **`name`** | string | Name of the print of the document. | iOS=YourAppName/Android=Document+CurrentTimestamp | 0.0.1 |\n| **`orientation`** | string | Orientation of the printing page. \"portrait\" or \"landscape\" | \"portrait\" | 0.0.1 |\n\n\n\n npm install capacitor-screen-orientation \n\n# Android Configuration:
\n\nOpen MainActivity.java and add the following code inside this.init()
\n add(ScreenOrientation.class);
\nAdding the above mentioned line will add the following import statement:
\n import com.bkon.capacitor.screenorientation.ScreenOrientation;
\nIf you encounter errors, please add both the lines manually to MainActivity.java
\n\nIf you want to listen for the orientation change event on Android:
\n\n1. Open “AndroidManifest.xml” for your app
\n2. Find the Activity tag
\n3. Go to android:configChanges=”...”
\n4. Remove ‘orientation |’ from configChanges
\n\nSupported Orientations:
\n\n1. LANDSCAPE: left of right is decided by the device’s sensor
\n2. LANDSCAPE_PRIMARY: explicitly specified by developer
\n3. LANDSCAPE_SECONDARY: explicitly specified by developer
\n4. PORTRAIT: up or upside down is decided by the device’s sensor
\n5. PORTRAIT_PRIMARY: explicitly specified by the user
\n6. PORTRAIT_SECONDARY: explicitly specified by the user
\n7. CURRENT: current orientation of the device
\n\nSPECIAL NOTE: Ionic has implicitly disabled PORTRAIT_SECONDARY.
\n\n# iOS Configuration:
\n\nIf you want to lock the screen to the specified orientation on iOS:
\n\n1. Open AppDelegate.swift for your app
\n2. Add the following code:
\n\nvar orientationLock = UIInterfaceOrientationMask.all
\n\nfunc application(\\_ application: UIApplication, supportedInterfaceOrientationsFor window: UIWindow?) -> UIInterfaceOrientationMask {
\nreturn self.orientationLock
\n}
","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/hinddeep_capacitor-screen-orientation.md","loc":{"lines":{"from":1,"to":54}}}}],["fe66f2c9-c032-48c5-9012-cd5d1bde260c",{"pageContent":"@objc func setOrientationLock(_ notification: Notification)
\n {
\n if let data = notification.userInfo as? [String: Int]
\n {
\n for (_, mask) in data
\n {
\n switch mask
\n {
\n case 1: self.orientationLock = UIInterfaceOrientationMask.portrait
\n break;
\n case 2: self.orientationLock = UIInterfaceOrientationMask.portraitUpsideDown
\n break;
\n case 3: self.orientationLock = UIInterfaceOrientationMask.landscapeRight
\n break;
\n case 4: self.orientationLock = UIInterfaceOrientationMask.landscapeLeft
\n break;
\n case 5: self.orientationLock = UIInterfaceOrientationMask.landscape
\n break;
\n default: self.orientationLock = UIInterfaceOrientationMask.all
\n }
\n }
\n }
\n }
\n\n3. Locate: \"func application(\\_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {\"
\n4. Add the following code inside the function:
\n NotificationCenter.default.addObserver(self, selector: #selector(self.setOrientationLock), name: NSNotification.Name(rawValue: \"CAPOrientationLocked\"), object: nil)
\n\n\nSupported Orientations:
\n\n1. all: all orientations
\n2. allButUpsideDown: all orientations other than upside down
\n3. landscape: left of right is decided by the device’s sensor
\n4. landscapeLeft: explicitly specified by the user
\n5. landscapeRight: explicitly specified by the user
\n6. portrait: up or upside down is decided by the device’s sensor
\n7. portraitUpsideDown: explicitly specified by the user
\n\n SPECIAL NOTE: Ionic has implicitly disabled portraitUpsideDown.
\n\n# Import the Plugin in your Web app
\n\nOpen app.component.ts file and import the plugin as follows:
\n import { Plugins } from \"@capacitor/core\";
\n const { ScreenOrientation } = Plugins;
\n import 'capacitor-screen-orientation'
\n\n SPECIAL NOTE: Remove import 'capacitor-screen-orientation' when compiling app for Android and iOS. THe native plugin will not be invoked if you forget to remove the import statement before building for Android and iOS Platform.
\n\n# Handle screen orientation:\n\n1. Create a function to get the current screen orientation:
\n async getOrientation() {
\n let obj = await ScreenOrientation.getScreenOrientation();
\n this.screen_orientation = obj.orientation;
\n }
\n\n2. Create a function to lock the screen in a particular orientation:\n async lockOrientation() {
\n await ScreenOrientation.lockScreenOrientation({
\n orientation: this.screen_orientation_lock,
\n });
\n }
","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/hinddeep_capacitor-screen-orientation.md","loc":{"lines":{"from":56,"to":119}}}}],["2fb6f3d9-0fea-4ce6-94a0-aaf731b88500",{"pageContent":"Supported values for screen_orientation_lock variable:
\n\n1. LANDSCAPE_PRIMARY (Android and iOS)
\n2. PORTRAIT_PRIMARY (Android and iOS)
\n3. LANDSCAPE_SECONDARY (Android and iOS)
\n4. PORTRAIT_SECONDARY (Android and iOS)
\n5. LANDSCAPE (Android only)
\n6. PORTRAIT (Android only)
\n7. CURRENT (Android only)
\n\n3) Create a function to unlock screen rotation:
\n async UnlockOrientation() {
\n await ScreenOrientation.unlockScreenOrientation({});
\n }
\n\n4) Create a function that handles subscription to the orientation change event:
\n subscribeToOrientationChanges() {
\n ScreenOrientation.addListener(\"orientation_changed\", (data) => {
\n this.screen_orientation_event = data.orientation;
\n });
\n }
\n\n# Rotate to a specific orientation (without locking the orientation): \nNOTE: NOT supported on Android
\nasync rotate() {
\n await ScreenOrientation.rotateTo({
\n orientation: this.rotateTo,
\n });
\n }
","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/hinddeep_capacitor-screen-orientation.md","loc":{"lines":{"from":121,"to":149}}}}],["d57a2082-ed9c-4896-95ee-d55f37cfe982",{"pageContent":"# Capacitor Contacts plugin\n\nThis plugin retrieves all your phone contacts: name and phones (Only works in Android)\n\n## Installation\n\n```bash\nnpm install @arturober/capacitor-contacts@latest\n```\n\n## Necessary permissions\n\n```xml\n
\n
\n \n
\n
\n\n ![\"Capacitor](\"https://user-images.githubusercontent.com/13857929/161965231-b2c7f586-2ee8-4342-a71a-0532bb8b4c1f.png\")
\n
\n\n
\n ![](\"https://img.shields.io/github/actions/workflow/status/capawesome-team/capacitor-firebase/ci.yml?branch=main&style=flat-square\")
![](\"https://img.shields.io/github/license/capawesome-team/capacitor-firebase?style=flat-square\")
![](\"https://img.shields.io/badge/part%20of-capawesome-%234f46e5?style=flat-square\"){kind=icon}
![](\"https://img.shields.io/badge/maintained%20with-turborepo-%237f6ab2?style=flat-square\"){kind=icon}
![](\"https://img.shields.io/badge/part%20of-DevLibrary-9cf?color=4285F4&logoColor=4285F4&logo=google&style=flat-square\"){kind=icon}
![\"cycraft\"](\"https://github.com/cycraft.png\")
\n\n## Installation\n\nEach plugin has its own installation instructions.\nClick on the name of the desired plugin under the [`Plugins`](#plugins) section to get to the installation guide.\n\n## Plugins","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/robingenz_capacitor-firebase.md","loc":{"lines":{"from":1,"to":52}}}}],["0a70aed4-8ea6-4843-9f26-b1d78126a21d",{"pageContent":"| Name | Package | Version | Downloads |\n| ------------------------------------------------ | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [Analytics](./packages/analytics) | `@capacitor-firebase/analytics` | [](https://www.npmjs.com/package/@capacitor-firebase/analytics) | [](https://www.npmjs.com/package/@capacitor-firebase/analytics) |\n| [App](./packages/app) | `@capacitor-firebase/app` | [](https://www.npmjs.com/package/@capacitor-firebase/app) | [](https://www.npmjs.com/package/@capacitor-firebase/app) |\n| [App Check](./packages/app-check) | `@capacitor-firebase/app-check` | [](https://www.npmjs.com/package/@capacitor-firebase/app-check) | [](https://www.npmjs.com/package/@capacitor-firebase/app-check) |\n| [Authentication](./packages/authentication) | `@capacitor-firebase/authentication` | [](https://www.npmjs.com/package/@capacitor-firebase/authentication) | [](https://www.npmjs.com/package/@capacitor-firebase/authentication) |\n| [Crashlytics](./packages/crashlytics) | `@capacitor-firebase/crashlytics` | [](https://www.npmjs.com/package/@capacitor-firebase/crashlytics) | [](https://www.npmjs.com/package/@capacitor-firebase/crashlytics) |","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/robingenz_capacitor-firebase.md","loc":{"lines":{"from":54,"to":60}}}}],["62266037-faaf-4f8d-b437-f48e36f79cb3",{"pageContent":"| [Cloud Messaging](./packages/messaging) | `@capacitor-firebase/messaging` | [](https://www.npmjs.com/package/@capacitor-firebase/messaging) | [](https://www.npmjs.com/package/@capacitor-firebase/messaging) |\n| [Performance Monitoring](./packages/performance) | `@capacitor-firebase/performance` | [](https://www.npmjs.com/package/@capacitor-firebase/performance) | [](https://www.npmjs.com/package/@capacitor-firebase/performance) |\n| [Remote Config](./packages/remote-config) | `@capacitor-firebase/remote-config` | [](https://www.npmjs.com/package/@capacitor-firebase/remote-config) | [](https://www.npmjs.com/package/@capacitor-firebase/remote-config) |","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/robingenz_capacitor-firebase.md","loc":{"lines":{"from":61,"to":63}}}}],["cd7ea6bd-6f3b-4e2b-b9b8-4465a76ea15e",{"pageContent":"## Changelogs\n\nEach plugin has its own `CHANGELOG.md` file which contains information about version changes.\nClick on the name of the desired plugin under the [`Plugins`](#plugins) section to get to the plugin folder.\n\n## Breaking Changes\n\nEach plugin has its own `BREAKING.md` file which contains information about breaking changes.\nClick on the name of the desired plugin under the [`Plugins`](#plugins) section to get to the plugin folder.\n\n## Contributing\n\nSee [CONTRIBUTING.md](./CONTRIBUTING.md).\n\n## License\n\nSee [LICENSE](./LICENSE).\n\n[^1]: This project is not affiliated with, endorsed by, sponsored by, or approved by Google LLC or any of their affiliates or subsidiaries.","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/robingenz_capacitor-firebase.md","loc":{"lines":{"from":65,"to":83}}}}],["6252c99d-d3dd-4f47-a43e-4d07d3b3a014",{"pageContent":"# capacitor-notificationlistener\n\nObserve android notification being posted / removed using this NotificationListenerService wrapper for capacitor.\n\n## Installation\n\n```\nnpm i capacitor-notificationlistener\nnpx cap sync\n```\n\nRegister this plugin using ```add(NotificationListenerPlugin.class)``` in your ```MainActivity.java``` like in the following example:\n```java\n// ... code ...\nimport ch.asinz.capacitornotificationlistener.NotificationListenerPlugin;\n// ... code ...\n this.init(savedInstanceState, new ArrayListThis is a README file for hello-cap
\nlatest version: \n1.0.0
","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/iamshubh_capacitorPlugin.md","loc":{"lines":{"from":1,"to":3}}}}],["5baad486-0217-42b4-878a-b58934cf48ca",{"pageContent":"## Capacitor Plugin Sensors\n\n### Support platform\n\n* android\n\n### Install\n\n> npm i --save capacitor-plugin-sensors\n\n### Usage example\n\n``` typescript\n\nimport { SensorsPlugin, SensorType, Sensor } from 'capacitor-plugin-sensors/dist/esm';\n\n// query sensors by type\nSensorsPlugin.get(SensorType.ALL).then(\n sensors => {\n\n // find sensor whos type is SensorType.LIGHT\n let lightSensor: Sensor = null;\n for (const sensor of sensors) {\n if (sensor.type == SensorType.LIGHT && lightSensor == null) {\n lightSensor = sensor;\n }\n \n console.log(`get sensor: ${sensor.id} ${sensor.name} ${sensor.type}`);\n }\n\n if (lightSensor != null) {\n // start sensor and listening its values\n SensorsPlugin.start(lightSensor, values => {\n console.log(`get light values: ${values}`);\n }, error => {\n console.error(`get light value error: ${error}`);\n });\n }\n }\n).catch(e => console.error(e));\n\n```","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/zzlcoding_capacitor-plugin-sensors.md","loc":{"lines":{"from":1,"to":42}}}}],["898ac6f0-dccf-4bfb-a726-11792c06cdcc",{"pageContent":"# Capacitor Plugin Demo\nAn example of a Capacitor plugin which make native Swift and Java code available for use in Typescript for an Ionic project\n\n## TypeScript Interface\n\nOpen [src/definitions.ts](src/definitions.ts)\n\n```\ndeclare module \"@capacitor/core\" {\n interface PluginRegistry {\n DemoPlugin: DemoPluginPlugin;\n }\n}\n\nexport interface DemoPluginPlugin {\n sum(options: { first: number, second: number}): Promise<{value: number}>;\n}\n```\n\n## Example of exposing native code\n### iOS\n\nOpen [ios/Plugin/Plugin.swift](ios/Plugin/Plugin.swift)\n\nA Capacitor plugin for iOS is a simple Swift class that extends CAPPlugin and has some exported methods that will be callable from Typescript.\n\n```\n@objc(DemoPlugin)\npublic class DemoPlugin: CAPPlugin {\n \n @objc func sum(_ call: CAPPluginCall) {\n guard let first = call.getInt(\"first\"),\n let second = call.getInt(\"second\") else {\n call.reject(\"Received invalid input\")\n return\n }\n let sum = first + second\n call.success([\"sum\": sum])\n }\n}\n```\n\nEach plugin method receives an instance of CAPPluginCall containing all the information of the plugin method invocation from the client.\n\n#### Export to Capacitor\n\nOpen [ios/Plugin/Plugin.m](ios/Plugin/Plugin.m)\n\nTo make sure Capacitor can see your plugin, you must do two things: export your Swift class to Objective-C, and register it using the provided Capacitor Objective-C Macros.\n\n```\nCAP_PLUGIN(DemoPlugin, \"DemoPlugin\",\n CAP_PLUGIN_METHOD(sum, CAPPluginReturnPromise);\n```\n\n### Android\n\nOpen [android/src/main/java/com/louisdebaere/demo/plugin/DemoPlugin.java](android/src/main/java/com/louisdebaere/demo/plugin/DemoPlugin.java)\n\nA Capacitor plugin for Android is a simple Java class that extends com.getcapacitor.Plugin and have a @NativePlugin annotation. It has some methods with @PluginMethod() annotation that will be callable from Typescript.\n\n```\n@NativePlugin()\npublic class DemoPlugin extends Plugin {\n\n @PluginMethod()\n public void sum(PluginCall call) {\n Integer first = call.getInt(\"first\");\n Integer second = call.getInt(\"second\");\n Integer sum = first + second;\n JSObject ret = new JSObject();\n ret.put(\"sum\", sum);\n call.success(ret);\n }\n}\n```\n\nEach plugin method receives an instance of com.getcapacitor.PluginCall containing all the information of the plugin method invocation from the client.\n\n#### Export to Capacitor\n\nBy using the @NativePlugin and @PluginMethod() annotations in your plugins, you make them available to Capacitor, but you still need an extra step in your application to make Capacitor aware of the plugins.\n\nThis is done in your apps MainActivity, where you add it in e.g. `src/main/java/com/example/myapp/MainActivity.java` like so:\n\n```\npublic class MainActivity extends BridgeActivity {\n @Override\n public void onCreate(Bundle savedInstanceState) {\n super.onCreate(savedInstanceState);","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/louisdebaere_capacitor-demo-plugin.md","loc":{"lines":{"from":1,"to":90}}}}],["7ebda04f-9f3a-4a7c-8061-0fed07e6ec73",{"pageContent":"// Initializes the Bridge\n this.init(savedInstanceState, new ArrayList{ value: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### deviceSupportBiometricLogin()\n\n```typescript\ndeviceSupportBiometricLogin() => Promise<{ value: boolean; }>\n```\n\n**Returns:** Promise<{ value: boolean; }>\n\n--------------------\n\nany |\n\n**Returns:** Promise<SuccessResponse>\n\n--------------------\n\n\n### Interfaces\n\n\n#### SuccessResponse\n\n| Prop | Type |\n| ------------- | ------------------- |\n| **`message`** | string |\n\n![\"Capacitor](\"https://jbaysolutions.github.io/capacitor-android-hotspot/assets/img/logo.png\"){kind=logo}
Capacitor-Android-Hotspot
\n\n\n\n ![](\"https://img.shields.io/npm/v/capacitor-android-hotspot.svg\"/)
\n ![](\"https://img.shields.io/npm/dm/capacitor-android-hotspot.svg\"/)
\n
\nDocumentation Website\n
\n\n**Current version: 0.0.8**\n\n**NPM release: https://www.npmjs.com/package/capacitor-android-hotspot**\n\n--- \n\n**Only for Android .... in case the name of the plugin is not explicit enough**\n\nCapacitor plugin to allow creating a local only hotspot that an application can use to communicate \nbetween co-located devices connected to the created WiFi hotspot. \n\nThe network created by this method **WILL NOT HAVE INTERNET ACCESS**. This is an Android *limitation*, or design decision. \n\nEach application can make a single request for the hotspot, but multiple applications could be requesting \nthe hotspot at the same time. When multiple applications have successfully registered concurrently, \nthey will be sharing the underlying hotspot. \n\n**This is a work in progress for an internal project**\n\n## How to use this\n\nIf you want to use the official version that is published on npm : \n\n```\nyarn add capacitor-android-hotspot\n```\n\nIf you want to use a clone of this repository: \n\n* Git clone this code\n\n* Build it using : `yarn build`\n\n* Add the plugin to your Capacitor Android Project\n\n```\nyarn add file:/path/to/capacitor-android-hotspot\n```\n\n**Now do Android Plugin integration:**\n\n```java\npackage com.example.android.project;\n\nimport android.os.Bundle;\n\nimport com.getcapacitor.BridgeActivity;\nimport com.getcapacitor.Plugin;\n\nimport java.util.ArrayList;\n\n// ----------------- IMPORT THE PLUGIN ---------------------- \nimport com.jbaysolutions.capacitor.hotspot.AndroidHotspotPlugin; \n\npublic class MainActivity extends BridgeActivity {\n @Override\n public void onCreate(Bundle savedInstanceState) {\n super.onCreate(savedInstanceState);\n\n // Initializes the Bridge\n this.init(savedInstanceState, new ArrayList{ value: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### waitNFC()\n\n```typescript\nwaitNFC() => PromisePromise<ScanResult>\n\n--------------------\n\n\n### Interfaces\n\n\n#### IScanResultWithContent","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/harrisonkungu_coopnfc.md","loc":{"lines":{"from":1,"to":85}}}}],["c36965fa-c381-4976-b802-bc7593787ffa",{"pageContent":"--------------------\n\n\n### Interfaces\n\n\n#### IScanResultWithContent\n\n| Prop | Type | Description | Since |\n| ---------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |\n| **`hasContent`** | true | This indicates whether or not the scan resulted in readable content. When stopping the scan with `resolveScan` set to `true`, for example, this parameter is set to `false`, because no actual content was scanned. | 1.0.0 |\n| **`content`** | string | This holds the content of the nfc if available. | 1.0.0 |\n| **`cardType`** | string | This holds the card type detected. | 1.0.0 |\n| **`cardNumber`** | string | This holds the card number detected. | 1.0.0 |\n| **`expiryDate`** | string | This holds the expiry date of the card detected. | 1.0.0 |\n| **`format`** | string | This returns format of scan result. | 2.1.0 |\n\n\n#### IScanResultWithoutContent","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/harrisonkungu_coopnfc.md","loc":{"lines":{"from":85,"to":103}}}}],["8de07120-32bf-442d-96d3-9fa931423122",{"pageContent":"#### IScanResultWithoutContent\n\n| Prop | Type | Description | Since |\n| ---------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |\n| **`hasContent`** | false | This indicates whether or not the scan resulted in readable content. When stopping the scan with `resolveScan` set to `true`, for example, this parameter is set to `false`, because no actual content was scanned. | 1.0.0 |\n| **`content`** | | This holds the content of the nfc if available. | 1.0.0 |\n| **`format`** | | This returns format of scan result. | 2.1.0 |\n\n\n### Type Aliases\n\n\n#### ScanResult\n\nIScanResultWithContent | IScanResultWithoutContent\n\n{ license: string; } |\n\n--------------------\n\n\n### recognizeBase64String(...)\n\n```typescript\nrecognizeBase64String(options: { base64: string; }) => Promise<{ results: DLRResult[]; }>\n```\n\n| Param | Type |\n| ------------- | -------------------------------- |\n| **`options`** | { base64: string; } |\n\n**Returns:** Promise<{ results: DLRResult[]; }>\n\n--------------------\n\n\n### updateRuntimeSettings(...)\n\n```typescript\nupdateRuntimeSettings(options: { settings: RuntimeSettings; }) => Promise{ settings: RuntimeSettings; } |\n\n--------------------\n\n\n### resetRuntimeSettings()\n\n```typescript\nresetRuntimeSettings() => Promise{ path: string; } |\n\n--------------------\n\n\n### addListener('onResourcesLoadStarted', ...)\n\n```typescript\naddListener(eventName: 'onResourcesLoadStarted', listenerFunc: onResourcesLoadStartedListener) => Promise'onResourcesLoadStarted' |\n| **`listenerFunc`** | onResourcesLoadStartedListener |\n\n**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle\n\n--------------------\n\n\n### addListener('onResourcesLoaded', ...)\n\n```typescript\naddListener(eventName: 'onResourcesLoaded', listenerFunc: onResourcesLoadedListener) => Promise'onResourcesLoaded' |\n| **`listenerFunc`** | onResourcesLoadedListener |\n\n**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle\n\n--------------------\n\n\n### removeAllListeners()\n\n```typescript\nremoveAllListeners() => PromiseDLRQuadrilateral |\n| **`confidence`** | number |\n| **`lineResults`** | DLRLineResult[] |\n\n\n#### DLRQuadrilateral\n\n| Prop | Type |\n| ------------ | ----------------------- |\n| **`points`** | DLRPoint[] |\n\n\n#### DLRPoint\n\n| Prop | Type |\n| ------- | ------------------- |\n| **`x`** | number |\n| **`y`** | number |\n\n\n#### DLRLineResult\n\n| Prop | Type |\n| ------------------------- | ------------------------------------------------------------- |\n| **`text`** | string |\n| **`location`** | DLRQuadrilateral |\n| **`confidence`** | number |\n| **`isCheckDigitMatched`** | boolean |\n\n\n#### RuntimeSettings","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/tony-xlh_capacitor-plugin-dynamsoft-label-recognizer.md","loc":{"lines":{"from":115,"to":187}}}}],["ea7b3271-c824-4dbc-a8b0-3aad34406a78",{"pageContent":"#### RuntimeSettings\n\n| Prop | Type |\n| ----------------------- | --------------------------------------------------------------- |\n| **`template`** | string |\n| **`customModelConfig`** | CustomModelConfig |\n\n\n#### CustomModelConfig\n\n| Prop | Type |\n| -------------------------- | --------------------- |\n| **`customModelFolder`** | string |\n| **`customModelFileNames`** | string[] |\n\n\n#### PluginListenerHandle\n\n| Prop | Type |\n| ------------ | ----------------------------------------- |\n| **`remove`** | () => Promise<void> |\n\n\n### Type Aliases\n\n\n#### onResourcesLoadStartedListener\n\n(resourcePath: string): void\n\n\n#### onResourcesLoadedListener\n\n(resourcePath: string): void\n\nCapacitor Background Geolocation
\ncapacitor-background-geolocation
\n Capacitor plugin for enabling background geolocation service\n
\n\n[](https://badge.fury.io/js/capacitor-background-geolocation)\n\n\n## Maintainers\n\n| Maintainer | GitHub |\n| --------------- | ------------------------------------------- |\n| Damiano Brunori | [seididieci](https://github.com/seididieci) |\n\n## Notice 🚀\n\nThis plugin actually works only in android. It creates a foreground service (with a notification on android) to keep your app getting location updates.\n\n## Installation\n\nUsing npm:\n\n```bash\nnpm install capacitor-background-geolocation\n```\n\nSync native files:\n\n```bash\nnpx cap sync\n```\n\n## API\n\n| method | info | platform |\n| ---------------- | -------------------------------------------------------- | ----------- |\n| `initialize` | initialize/start service and configure | web/android |\n| `start` | starts the service getting location updates | web/android |\n| `stop` | stops the service getting location updates | web/android |\n| `goForeground` | bring the service on foreground (showing a notification) | android |\n| `stopForeground` | bring the service back to the bacground | android |\n\n## Usage steps (TypeScript)\n\n### Import plugin and types\n\n```ts\nimport { Plugins } from '@capacitor/core';\nconst { BackgroundGeolocation } = Plugins;\n\nimport {\n BgLocationEvent,\n BgGeolocationAccuracy,\n} from 'capacitor-background-geolocation';\n```\n\n### Add listner(s) for location updates\n\n```ts\nBackgroundGeolocation.addListener('onLocation', (location: BgLocationEvent) => {\n console.log('Got new location', location);\n // Put your logic here.\n});\n```\n\n### Start service after the user accept permissions (through Android popup)\n```ts\nBackgroundGeolocation.addListener('onPermissions', (data: BgPermissions) => {\n console.log('BGLocation permissions:', location);\n\n // Start geolocation if user granted location permisiions\n if (data.fineLocation)\n BackgroundGeolocation.start();\n});\n```\n\n### Initialize the plugin settings (required)","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/seididieci_capacitor-backround-geolocation.md","loc":{"lines":{"from":1,"to":78}}}}],["84012d5d-2950-4fee-96bb-fa9548b45bb8",{"pageContent":"### Initialize the plugin settings (required)\n\n```ts\nBackgroundGeolocation.initialize({\n notificationText: 'Your app is running, tap to open.',\n notificationTitle: 'App Running',\n updateInteval: 10000,\n requestedAccuracy: BgGeolocationAccuracy.HIGH_ACCURACY,\n // Small icon has to be in 'drawable' resources of your app\n // if you does not provide one (or it is not found) a fallback icon will be used.\n smallIcon: 'ic_small_icon',\n // Start getting location updates right away. You can set this to false or not set at all (se below).\n startImmediately: true,\n});\n```\n### Request permissions to user\n```ts\n// After user accept permissions the handler above will start the service\nBackgroundGeolocation.requestPermissions();\n```\n\n### Evnetually stop getting location updates when done\n```ts\nBackgroundGeolocation.stop();\n```\n\n### Control background/foreground behaviour\n```ts\n// Force the service to run in foreground\n// It will show the android notification also when your app is up and running\nBackgroundGeolocation.goFroreground();\n\n// Restore the service to run in backgroud/default mode: the android notification will be shown only when your app goes in background.\nBackgroundGeolocation.stopForeground();\n\n```\nKeep in mind that the plugin will send the service in the foreground when your APP is going into background until you stop the service or quit the APP.\n\n### Android\n\n> ### Notice\n>\n> Remember to add this plugin to your app main acctivity:\n>\n> ```java\n> import com.getcapacitor.community.bglocation.BackgroundGeolocation;\n>\n> //....\n>\n> // Initializes the Bridge\n> this.init(savedInstanceState, new ArrayList\n>Check that there are `FOREGROUND_SERVICE` and `ACCESS_FINE_LOCATION` permissions. in your App Manifest.\n\n### iOS\n\nThis plugin is not yet implemented iOS side, if someone wants to help I will appreciate it...\n\n## License\n\ncapacitor-background-geolocation is 100% free and open-source, under the [MIT license](LICENSE). Use it however you want.","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/seididieci_capacitor-backround-geolocation.md","loc":{"lines":{"from":78,"to":145}}}}],["a079df39-14da-48d3-a105-07ee5512f004",{"pageContent":"# capacitor-firebase-upload-file\nCapacitor Firebase Upload File use the Firebase Storage Native, With the plugin you can upload any type of formats.\n> especially for MP4 for Videos and PNG/JPG for Images also compress the file.\n> Android Platform use the siliCompressor for compress MP4 and PNG/JPG files; [More information:](https://github.com/Tourenathan-G5organisation/SiliCompressor)\n\nNOTE: The plugin its supports only for Android also the compress its only available for Video format, not iOS and Web for now.\n\n| Platform | |\n|----------|:-:|\n| Android |✅|\n| iOS |🧠|\n| Web |🧠|\n\n✅ - Ready\n🧠 - Thinking about, date to be defined\n\n\n## How to install\nInstall the plugin into your Capacitor project with npm.\n\n```\nnpm install --save capacitor-firebase-upload-file@0.0.1\n```\n\n## How to use on JavaAndroid\n\nImport the class in the MainActivity.java:\n\n```java:\nimport com.jdesigner.firebaseuploadfile.plugin.FirebaseUploadFile;\n```\n\nAdd class inside the public MainActivity class:\n\n```java:\npublic class MainActivity extends BridgeActivity {\n @Override\n public void onCreate(Bundle savedInstanceState) {\n super.onCreate(savedInstanceState);\n\n // Initializes the Bridge\n this.init(savedInstanceState, new ArrayList
Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### isRootedWithBusyBox()\n\n```typescript\nisRootedWithBusyBox() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### isRootedWithEmulator()\n\n```typescript\nisRootedWithEmulator() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### isRootedWithBusyBoxWithEmulator()\n\n```typescript\nisRootedWithBusyBoxWithEmulator() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### isDetectRootManagementAppsRooted()","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/asephermann_capacitor-root-jailbreak-detector.md","loc":{"lines":{"from":1,"to":99}}}}],["5ff4416b-b00a-400d-8a6e-55df53a56fd4",{"pageContent":"**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### isDetectRootManagementAppsRooted()\n\n```typescript\nisDetectRootManagementAppsRooted() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### isDetectPotentiallyDangerousAppsRooted()\n\n```typescript\nisDetectPotentiallyDangerousAppsRooted() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### isTestKeysRooted()\n\n```typescript\nisTestKeysRooted() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### isCheckForBusyBoxBinaryRooted()\n\n```typescript\nisCheckForBusyBoxBinaryRooted() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### isCheckForSuBinaryRooted()\n\n```typescript\nisCheckForSuBinaryRooted() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### isCheckSuExistsRooted()\n\n```typescript\nisCheckSuExistsRooted() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### isCheckForRWPathsRooted()\n\n```typescript\nisCheckForRWPathsRooted() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### isCheckForDangerousPropsRooted()\n\n```typescript\nisCheckForDangerousPropsRooted() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### isCheckForRootNativeRooted()\n\n```typescript\nisCheckForRootNativeRooted() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### isDetectRootCloakingAppsRooted()\n\n```typescript\nisDetectRootCloakingAppsRooted() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### isSelinuxFlagInEnabled()\n\n```typescript\nisSelinuxFlagInEnabled() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### isExistBuildTagsRooted()\n\n```typescript\nisExistBuildTagsRooted() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### doesSuperuserApkExistRooted()\n\n```typescript\ndoesSuperuserApkExistRooted() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### isExistSUPathRooted()\n\n```typescript\nisExistSUPathRooted() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### isCheckDirPermissionsRooted()\n\n```typescript\nisCheckDirPermissionsRooted() => Promise<{ isRooted: boolean; }>\n```","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/asephermann_capacitor-root-jailbreak-detector.md","loc":{"lines":{"from":99,"to":262}}}}],["cb4a9385-04d3-4f02-8984-9188b18f6033",{"pageContent":"### isCheckDirPermissionsRooted()\n\n```typescript\nisCheckDirPermissionsRooted() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### isCheckExecutingCommandsRooted()\n\n```typescript\nisCheckExecutingCommandsRooted() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### isCheckInstalledPackagesRooted()\n\n```typescript\nisCheckInstalledPackagesRooted() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### isCheckforOverTheAirCertificatesRooted()\n\n```typescript\nisCheckforOverTheAirCertificatesRooted() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### isRunningOnEmulatorRooted()\n\n```typescript\nisRunningOnEmulatorRooted() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### isRunningOnEmulator()\n\n```typescript\nisRunningOnEmulator() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### simpleCheckEmulatorRooted()\n\n```typescript\nsimpleCheckEmulatorRooted() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### simpleCheckSDKBF86Rooted()\n\n```typescript\nsimpleCheckSDKBF86Rooted() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### simpleCheckQRREFPHRooted()\n\n```typescript\nsimpleCheckQRREFPHRooted() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### simpleCheckBuildRooted()\n\n```typescript\nsimpleCheckBuildRooted() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### checkGenymotionRooted()\n\n```typescript\ncheckGenymotionRooted() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### checkGenericRooted()\n\n```typescript\ncheckGenericRooted() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### checkGoogleSDKRooted()\n\n```typescript\ncheckGoogleSDKRooted() => Promise<{ isRooted: boolean; }>\n```\n\n**Returns:** Promise<{ isRooted: boolean; }>\n\n--------------------\n\n\n### getDeviceInfo()\n\n```typescript\ngetDeviceInfo() => PromisePromise<DeviceInfo>\n\n--------------------\n\n\n### Interfaces\n\n\n#### DeviceInfo","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/asephermann_capacitor-root-jailbreak-detector.md","loc":{"lines":{"from":262,"to":419}}}}],["0b235f13-3bf5-4311-adfb-f7e9928cce8a",{"pageContent":"--------------------\n\n\n### Interfaces\n\n\n#### DeviceInfo\n\n| Prop | Type |\n| ------------------- | ------------------- |\n| **`DEVICE`** | string |\n| **`MODEL`** | string |\n| **`MANUFACTURER`** | string |\n| **`BRAND`** | string |\n| **`BOARD`** | string |\n| **`HARDWARE`** | string |\n| **`PRODUCT`** | string |\n| **`FINGERPRINT`** | string |\n| **`HOST`** | string |\n| **`USER`** | string |\n| **`OSNAME`** | string |\n| **`OSVERSION`** | string |\n| **`V_INCREMENTAL`** | string |\n| **`V_RELEASE`** | string |\n| **`V_SDK_INT`** | string |\n\nUnzipOptions |\n\n**Returns:** Promise<UnzipResult>\n\n--------------------\n\n\n### Interfaces\n\n\n#### UnzipResult\n\n| Prop | Type |\n| ------------- | ------------------- |\n| **`message`** | string |\n| **`uri`** | string |\n\n\n#### UnzipOptions\n\n| Prop | Type |\n| ----------------- | ------------------- |\n| **`source`** | string |\n| **`destination`** | string |\n| **`password`** | string |\n\n{ value: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n\n### changeAppIcon(...)\n\n```typescript\nchangeAppIcon(options: { name: string; allNames: string[]; }) => Promise<{ name: string; allNames: string[]; }>\n```\n\n| Param | Type |\n| ------------- | -------------------------------------------------- |\n| **`options`** | { name: string; allNames: string[]; } |\n\n**Returns:** Promise<{ name: string; allNames: string[]; }>\n\n--------------------\n\n{ value: string; } |\n\n**Returns:** any\n\n--------------------\n\n\n### getValueFromConfig(...)\n\n```typescript\ngetValueFromConfig(options: { key: string; }) => any\n```\n\n| Param | Type |\n| ------------- | ----------------------------- |\n| **`options`** | { key: string; } |\n\n**Returns:** any\n\n--------------------\n\n\n### storeConfigValue(...)\n\n```typescript\nstoreConfigValue(options: { key: string; }) => any\n```\n\n| Param | Type |\n| ------------- | ----------------------------- |\n| **`options`** | { key: string; } |\n\n**Returns:** any\n\n--------------------\n\nCapacitor Phone Event Usage
\ncapacitor-phone-event-usage
A capacitor plugin to track phone app usage.
\n\n## Maintainers\n\n| Maintainer | GitHub | Social |\n| ------------- | ------------------------------------------- | ------------------------------------------------ |\n| Daniel Leightley| [DrDanL](https://github.com/DrDanL) | [@_Dr_Daniel](https://twitter.com/_Dr_Daniel) |\n\nMaintenance Status: Actively Maintained.\n\nHudge credit to [ciitamjadibraheem UsageStats Package](https://github.com/ciitamjadibraheem/UsageStats).\n\n**This is an early release and the plugin requires further development. All contributions welcome.**\n\n## Installation\n\nUsing npm:\n\n```bash\nnpm install capacitor-phone-event-usage\n```\n\nSync native files:\n\n```bash\nnpx cap sync\n```\nOn Android, register the plugin in your main activity:\n\n```java\nimport cap.phone.usage.PhoneEventUsage;\n\npublic class MainActivity extends BridgeActivity {\n\n @Override\n public void onCreate(Bundle savedInstanceState) {\n super.onCreate(savedInstanceState);\n\n // Initializes the Bridge\n this.init(\n savedInstanceState,\n new ArrayListwww/js and open index.js\n\n ![\"setting-api-keys\"](\"screenshots/api-keys.png\")
\n
APP_ID and APP_SECRET with the credentials from your Cashfree's account PG dashboard.\n\n* Set the ENV as per the environment from where the credentials are used ( 'TEST' or 'PROD' ).\n\n---\n\n## Installing The App\n### Android\nTo install the app in android run the following command.\n\n```shell\ncordova run android\n```\n\n### iOS\nTo install the app in iOS run the following command.\n\n```shell\ncordova run ios\n```","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/cashfree_cordova-pgsdk-demo-app.md","loc":{"lines":{"from":1,"to":53}}}}],["f337fd32-eda0-4fce-ab21-8d63ac758476",{"pageContent":"# Capacitor pdf\n\nEl propósito del plugin es tener una alternativa a un lector de pdf nativo para capacitor. En este momento se encuentra funcional solo para andriod pero, no en mucho tiempo, tenemos la version actualizada para ios. En las siguientes secciones vamos a documentar como utilizar el plugin y las entradas que tiene el mismo.\n\n## Contribución\n\n![\"Buy](\"https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png\")
\n\n## Instalación\n\nnpm i capacitor-pdf\n\n## Utilización en javascript\n\n### Anotaciones en pdf\n\nEn este momento solo se tiene anotaciones de tipo link, que se insertan como un boton en el pdf. Cuando se da click en el este, abre un navegador interno que muestra la página del enlace enviado.\n\nSe debe enviar al método del plugin, un dato tipo json que incluyes los siguientes parámetros:\npage: 1, // no funcionan por ahora\npoint_x: 500,\npoint_y: 500,\npoint_link: \"Enlace del link\",\npoint_icon: 'ic_info',// no funcionan por ahora\npoint_color_icon: 'white',// no funcionan por ahora\npoint_background_icon: 'blue' // no funcionan por ahora\n\nPor ahora está funcionando la los items point_x, point_y y point_link. Los demas parámetros irán funcionando poco a poco.\n\n### Integración javascript\n\nEn el ejemplo se está utilizando angular, pero puede funcionar con cualquier aplicacion hecha en javascript.\n\n```Javascript\nimport { Plugins } from '@capacitor/core';\nconst { PdfPlugin } = Plugins;\n...\n viewPdf() {\n const annotations: any[] = [\n {\n page: 1, // no funcionan por ahora\n point_x: 500,\n point_y: 500,\n point_link: \"https://www.elpais.com.co\",\n point_icon: 'ic_info',// no funcionan por ahora\n point_color_icon: 'white',// no funcionan por ahora\n point_background_icon: 'blue' // no funcionan por ahora\n }\n ]\n const options: any = {\n linkPdf: \"enlace del pdf\",\n annotations\n }\n PdfPlugin.viewPdf({...options});\n }\n```\n\n## Integración en android\n\nPasos para integrar el plugin en android:\n\n- ionic capacitor run android\n- En el MainActivity.java, debes añadir el siguiente código:\n ```Java\n public class MainActivity extends BridgeActivity {\n @Override\n public void onCreate(Bundle savedInstanceState) {\n super.onCreate(savedInstanceState);\n\n // Initializes the Bridge\n this.init(savedInstanceState, new ArrayList{ value: string; } |\n\n**Returns:** any\n\n--------------------\n\n\n### wxPayRequest(...)\n\n```typescript\nwxPayRequest(options: WxParams) => any\n```\n\n| Param | Type |\n| ------------- | --------------------------------------------- |\n| **`options`** | WxParams |\n\n**Returns:** any\n\n--------------------\n\n\n### aliPayRequest(...)\n\n```typescript\naliPayRequest(options: AlipayParams) => any\n```\n\n| Param | Type |\n| ------------- | ----------------------------------------------------- |\n| **`options`** | AlipayParams |\n\n**Returns:** any\n\n--------------------\n\n\n### Interfaces\n\n\n#### WxParams\n\n| Prop | Type |\n| --------------- | ------------------- |\n| **`appId`** | string |\n| **`mchId`** | string |\n| **`prepayId`** | string |\n| **`noncestr`** | string |\n| **`timestamp`** | number |\n| **`sign`** | string |\n\n\n#### AlipayParams\n\n| Prop | Type |\n| --------------- | ------------------- |\n| **`orderInfo`** | string |\n\n'getSentIntent' |\n| **`listenerFunc`** | (data: IntentData) => void |\n\n**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle\n\n--------------------\n\n\n### Interfaces\n\n\n#### PluginListenerHandle\n\n| Prop | Type |\n| ------------ | ----------------------------------------- |\n| **`remove`** | () => Promise<void> |\n\n\n#### IntentData\n\n| Prop | Type |\n| --------------- | ---------------- |\n| **`extraData`** | any |\n| **`type`** | any |\n\n\n Message from Capacitor
\n First argument: ${event.args[0]}
\n Second argument: ${event.args[1]}\n
string | Relative path of the integrated Node.js project based on the Capacitor webdir. | \"nodejs\" | 1.0.0 |\n| **`startMode`** | 'auto' \\| 'manual' | Startup mode of the Node.js engine. The following values are accepted: **`auto`**: The Node.js engine starts automatically when the application is launched. **`manual`**: The Node.js engine is started via the `NodeJS.start()` method. | \"auto\" | 1.0.0 |\n\n### Examples\n\nIn `capacitor.config.json`:\n\n```json\n{\n \"plugins\": {\n \"CapacitorNodeJS\": {\n \"nodeDir\": \"custom-nodejs\",\n \"startMode\": \"manual\"\n }\n }\n}\n```\n\nIn `capacitor.config.ts`:\n\n```ts\n/// string | The name of the event being send to. | 1.0.0 |\n| **`args`** | any[] | The Array of arguments to send. | 1.0.0 |\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### channel.on(string, ...)\n\n```typescript\non: (eventName: string, listener: (...args: any[]) => void) => void\n```\n\nListens to `eventName` and calls `listener(args...)` when a new message arrives from the Capacitor layer.\n\n| Param | Type |\n| --------------- | ------------------------------------- |\n| **`eventName`** | string |\n| **`listener`** | (...args: any[]) => void |\n\n```typescript\nlistener: (...args: any[]) => void\n```\n\n| Param | Type | Description | Since |\n| ---------- | ------------------- | -------------------------------- | ----- |\n| **`args`** | any[] | The received array of arguments. | 1.0.0 |\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### channel.once(string, ...)\n\n```typescript\nonce: (eventName: string, listener: (...args: any[]) => void) => void\n```\n\nListens one time to `eventName` and calls `listener(args...)` when a new message arrives from the Capacitor layer, after which it is removed.\n\n| Param | Type |\n| --------------- | ------------------------------------- |\n| **`eventName`** | string |\n| **`listener`** | (...args: any[]) => void |\n\n```typescript\nlistener: (...args: any[]) => void\n```\n\n| Param | Type | Description | Since |\n| ---------- | ------------------- | -------------------------------- | ----- |\n| **`args`** | any[] | The received array of arguments. | 1.0.0 |\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### channel.addListener(string, ...)\n\n```typescript\naddListener: (eventName: string, listener: (...args: any[]) => void) => void\n```\n\nAlias for [`channel.on(string, ...)`](#channelonstring).\n\n| Param | Type |\n| --------------- | ------------------------------------- |\n| **`eventName`** | string |\n| **`listener`** | (...args: any[]) => void |\n\n```typescript\nlistener: (...args: any[]) => void\n```","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/hampoelz_Capacitor-NodeJS.md","loc":{"lines":{"from":599,"to":694}}}}],["27959308-193e-43ff-9c6b-807efd790e70",{"pageContent":"```typescript\nlistener: (...args: any[]) => void\n```\n\n| Param | Type | Description | Since |\n| ---------- | ------------------- | -------------------------------- | ----- |\n| **`args`** | any[] | The received array of arguments. | 1.0.0 |\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### channel.removeListener(...)\n\n```typescript\nremoveListener: (eventName: string, listener: (...args: any[]) => void) => void\n```\n\nRemoves the specified `listener` from the listener array for the specified `eventName`.\n\n| Param | Type |\n| --------------- | ------------------------------------- |\n| **`eventName`** | string |\n| **`listener`** | (...args: any[]) => void |\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### channel.removeAllListeners(...)\n\n```typescript\nremoveAllListeners: (eventName?: string) => void\n```\n\nRemoves all listeners, or those of the specified `eventName`.\n\n| Param | Type | Description | Since |\n| --------------- | ------------------- | --------------------------------------------------------- | ----- |\n| **`eventName`** | string | The name of the event all listeners will be removed from. | 1.0.0 |\n\n**Since:** 1.0.0\n\n--------------------\n\n\n## API - Capacitor layer\n\nThe `NodeJS` module is the API used in the Capacitor app. It provides a few methods to send messages from the Node.js layer and wait for them.\n\nIt has the following methods:\n\nStartOptions |\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### send(...)\n\n```typescript\nsend(args: ChannelPayloadData) => PromiseChannelPayloadData |\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### whenReady()\n\n```typescript\nwhenReady() => Promisestring |\n| **`listenerFunc`** | ChannelListenerCallback |\n\n**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### removeListener(...)\n\n```typescript\nremoveListener(listenerHandle: PluginListenerHandle) => PromisePluginListenerHandle |\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### removeAllListeners(...)\n\n```typescript\nremoveAllListeners(eventName?: string) => Promisestring |\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### Interfaces\n\n\n#### StartOptions\n\nAn interface containing the options used when starting the Node.js engine manually.","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/hampoelz_Capacitor-NodeJS.md","loc":{"lines":{"from":808,"to":881}}}}],["7e93f800-92d6-4e2d-960a-5aa3d88dab1d",{"pageContent":"### Interfaces\n\n\n#### StartOptions\n\nAn interface containing the options used when starting the Node.js engine manually.\n\n| Prop | Type | Description | Since |\n| ------------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- |\n| **`nodeDir`** | string | Relative path of the integrated Node.js project based on the Capacitor webdir. Defaults to the `nodeDir` field of the global plugin configuration. If the `nodeDir` config is not set, `nodejs` in the Capacitor webdir is used as Node.js project directory. | 1.0.0 |\n| **`script`** | string | The primary entry point to the Node.js program. This should be a module relative to the root of the Node.js project folder. Defaults to the `main` field in the project's package.json. If the `main` field is not set, `index.js` in the project's root folder is used. | 1.0.0 |\n| **`args`** | string[] | A list of string arguments. | 1.0.0 |\n| **`env`** | NodeEnv | Environment key-value pairs. | 1.0.0 |\n\n\n#### NodeEnv\n\nAn interface that holds environment variables as string key-value pairs.\n\n\n#### ChannelPayloadData\n\nThe payload data to send a message to the web page via `eventName`,\nalong with arguments. Arguments will be serialized with JSON.\n\n| Prop | Type | Description | Since |\n| --------------- | ------------------- | ------------------------------------ | ----- |\n| **`eventName`** | string | The name of the event being send to. | 1.0.0 |\n| **`args`** | any[] | The array of arguments to send. | 1.0.0 |\n\n\n#### PluginListenerHandle\n\n| Prop | Type |\n| ------------ | ----------------------------------------- |\n| **`remove`** | () => Promise<void> |\n\n\n#### ChannelCallbackData\n\nThe callback data object when a message from the Node.js process arrives.","metadata":{"source":"/Users/rishirajjain/Desktop/pr-tut/openai-readmes/hampoelz_Capacitor-NodeJS.md","loc":{"lines":{"from":881,"to":921}}}}],["c2e2817d-a798-4364-bd90-5d6ba0f54622",{"pageContent":"#### ChannelCallbackData\n\nThe callback data object when a message from the Node.js process arrives.\n\n| Prop | Type | Description | Since |\n| ---------- | ------------------ | -------------------------------- | ----- |\n| **`args`** | any[] | The received array of arguments. | 1.0.0 |\n\n\n### Type Aliases\n\n\n#### ChannelListenerCallback\n\nThe callback function to be called when listen to messages from the Node.js process.\n\n(data: ChannelCallbackData): void\n\n\n Made with ❤️ by Rene Hampölz\n
\n ![\"GitHub\"](\"https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white\"){kind=icon}
![\"Instagram\"](\"https://img.shields.io/badge/Instagram-E4405F?style=for-the-badge&logo=instagram&logoColor=white\"){kind=icon}
![\"Twitter\"](\"https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white\"){kind=icon}
{ value: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n{ value: string; } |\n\n**Returns:** Promise<{ value: string; }>\n\n--------------------\n\n