@capawesome/capacitor-haptics 0.0.1

package/dist/docs.json

@@ -0,0 +1,665 @@
+{
+  "api": {
+    "name": "HapticsPlugin",
+    "slug": "hapticsplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "impact",
+        "signature": "(options?: ImpactOptions | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "ImpactOptions | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Trigger an impact haptic feedback.\n\nUse this to simulate a physical impact, for example when user\ninterface elements collide or a drag operation snaps into place.\n\nOn Android, the impact style is mapped to a best-effort vibration effect.",
+        "complexTypes": [
+          "ImpactOptions"
+        ],
+        "slug": "impact"
+      },
+      {
+        "name": "isAvailable",
+        "signature": "() => Promise<IsAvailableResult>",
+        "parameters": [],
+        "returns": "Promise<IsAvailableResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Check if haptic feedback is available on the device.\n\nOn Android, this checks whether the device has a vibrator.\nOn iOS, this checks whether the device supports haptic event playback.\nOn the web, this checks whether the Vibration API is supported.",
+        "complexTypes": [
+          "IsAvailableResult"
+        ],
+        "slug": "isavailable"
+      },
+      {
+        "name": "notification",
+        "signature": "(options?: NotificationOptions | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "NotificationOptions | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Trigger a notification haptic feedback.\n\nUse this to communicate that a task or action has succeeded, failed,\nor produced a warning.\n\nOn Android, the notification type is mapped to a best-effort vibration\neffect.",
+        "complexTypes": [
+          "NotificationOptions"
+        ],
+        "slug": "notification"
+      },
+      {
+        "name": "performAndroidHaptic",
+        "signature": "(options: PerformAndroidHapticOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "PerformAndroidHapticOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Perform a predefined Android haptic feedback effect.\n\nIn contrast to the other methods, this method does not use the vibrator\nbut the semantic haptic feedback constants of the Android view system.\nThis respects the user's haptic feedback settings.\n\nOnly available on Android.",
+        "complexTypes": [
+          "PerformAndroidHapticOptions"
+        ],
+        "slug": "performandroidhaptic"
+      },
+      {
+        "name": "playPattern",
+        "signature": "(options: PlayPatternOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "PlayPatternOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Play a custom haptic pattern composed of individual haptic events.\n\nOn iOS, the pattern is played using Core Haptics with full support for\nintensity and sharpness. This requires a device with haptic event\nplayback support (for example an iPhone with a Taptic Engine).\nOtherwise, the call rejects as unavailable.\n\nOn Android, the pattern is played using vibration effects. Intensity is\nonly respected on devices with amplitude control.\n\nOn the web, the pattern is approximated using the Vibration API.",
+        "complexTypes": [
+          "PlayPatternOptions"
+        ],
+        "slug": "playpattern"
+      },
+      {
+        "name": "selectionChanged",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Trigger a selection changed haptic feedback.\n\nCall this method after `selectionStart()` whenever the selection changes.\n\nOn the web, this method does nothing.",
+        "complexTypes": [],
+        "slug": "selectionchanged"
+      },
+      {
+        "name": "selectionEnd",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "End a selection session.\n\nCall this method when the user finishes a selection interaction.\n\nOn the web, this method does nothing.",
+        "complexTypes": [],
+        "slug": "selectionend"
+      },
+      {
+        "name": "selectionStart",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Start a selection session.\n\nCall this method when the user starts a selection interaction, for\nexample when a picker starts scrolling. It prepares the haptic hardware\nto reduce the latency of subsequent `selectionChanged()` calls.\n\nOn the web, this method does nothing.",
+        "complexTypes": [],
+        "slug": "selectionstart"
+      },
+      {
+        "name": "vibrate",
+        "signature": "(options?: VibrateOptions | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "VibrateOptions | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Vibrate the device.",
+        "complexTypes": [
+          "VibrateOptions"
+        ],
+        "slug": "vibrate"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "ImpactOptions",
+      "slug": "impactoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "style",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "ImpactStyle.Medium",
+              "name": "default"
+            }
+          ],
+          "docs": "The style of the impact.",
+          "complexTypes": [
+            "ImpactStyle"
+          ],
+          "type": "ImpactStyle"
+        }
+      ]
+    },
+    {
+      "name": "IsAvailableResult",
+      "slug": "isavailableresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "available",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "true",
+              "name": "example"
+            }
+          ],
+          "docs": "Whether or not haptic feedback is available on the device.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "NotificationOptions",
+      "slug": "notificationoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "type",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "NotificationType.Success",
+              "name": "default"
+            }
+          ],
+          "docs": "The type of the notification.",
+          "complexTypes": [
+            "NotificationType"
+          ],
+          "type": "NotificationType"
+        }
+      ]
+    },
+    {
+      "name": "PerformAndroidHapticOptions",
+      "slug": "performandroidhapticoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "type",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The Android haptic feedback effect to perform.",
+          "complexTypes": [
+            "AndroidHapticType"
+          ],
+          "type": "AndroidHapticType"
+        }
+      ]
+    },
+    {
+      "name": "PlayPatternOptions",
+      "slug": "playpatternoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "events",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The haptic events that make up the pattern.",
+          "complexTypes": [
+            "HapticEvent"
+          ],
+          "type": "HapticEvent[]"
+        }
+      ]
+    },
+    {
+      "name": "HapticEvent",
+      "slug": "hapticevent",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "duration",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "0.5",
+              "name": "example"
+            }
+          ],
+          "docs": "The duration of the event in seconds.\n\nIf omitted, the event is a transient tap.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "intensity",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "1.0",
+              "name": "example"
+            }
+          ],
+          "docs": "The intensity of the event as a value between `0` and `1`.\n\nOn Android, the intensity is only respected on devices with amplitude\ncontrol.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "sharpness",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "0.5",
+              "name": "default"
+            },
+            {
+              "text": "0.7",
+              "name": "example"
+            }
+          ],
+          "docs": "The sharpness of the event as a value between `0` and `1`.\n\nA lower value results in a rounder, softer feedback while a higher value\nresults in a crisper, more precise feedback.\n\nOnly available on iOS.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "time",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "0.2",
+              "name": "example"
+            }
+          ],
+          "docs": "The relative time at which the event occurs, in seconds.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "VibrateOptions",
+      "slug": "vibrateoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "duration",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "300",
+              "name": "default"
+            },
+            {
+              "text": "500",
+              "name": "example"
+            }
+          ],
+          "docs": "The duration of the vibration in milliseconds.\n\nOnly available on Android and Web.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    }
+  ],
+  "enums": [
+    {
+      "name": "ImpactStyle",
+      "slug": "impactstyle",
+      "members": [
+        {
+          "name": "Heavy",
+          "value": "'HEAVY'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "A collision between large, heavy user interface elements."
+        },
+        {
+          "name": "Light",
+          "value": "'LIGHT'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "A collision between small, light user interface elements."
+        },
+        {
+          "name": "Medium",
+          "value": "'MEDIUM'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "A collision between moderately sized user interface elements."
+        },
+        {
+          "name": "Rigid",
+          "value": "'RIGID'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "A collision between hard or inflexible user interface elements."
+        },
+        {
+          "name": "Soft",
+          "value": "'SOFT'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "A collision between soft or flexible user interface elements."
+        }
+      ]
+    },
+    {
+      "name": "NotificationType",
+      "slug": "notificationtype",
+      "members": [
+        {
+          "name": "Error",
+          "value": "'ERROR'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "A task or action has failed."
+        },
+        {
+          "name": "Success",
+          "value": "'SUCCESS'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "A task or action has completed successfully."
+        },
+        {
+          "name": "Warning",
+          "value": "'WARNING'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "A task or action has produced a warning."
+        }
+      ]
+    },
+    {
+      "name": "AndroidHapticType",
+      "slug": "androidhaptictype",
+      "members": [
+        {
+          "name": "ClockTick",
+          "value": "'CLOCK_TICK'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The user has pressed either an hour or minute tick of a clock."
+        },
+        {
+          "name": "Confirm",
+          "value": "'CONFIRM'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The confirmation of a user's action.\n\nOn Android 10 and older, `ContextClick` is performed instead."
+        },
+        {
+          "name": "ContextClick",
+          "value": "'CONTEXT_CLICK'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The user has performed a context click on an object."
+        },
+        {
+          "name": "KeyboardTap",
+          "value": "'KEYBOARD_TAP'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The user has pressed a virtual or software keyboard key."
+        },
+        {
+          "name": "LongPress",
+          "value": "'LONG_PRESS'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The user has performed a long press on an object."
+        },
+        {
+          "name": "Reject",
+          "value": "'REJECT'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The rejection or failure of a user's action.\n\nOn Android 10 and older, `LongPress` is performed instead."
+        },
+        {
+          "name": "ToggleOff",
+          "value": "'TOGGLE_OFF'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The user has toggled a switch or button into the off position.\n\nOn Android 13 and older, `ClockTick` is performed instead."
+        },
+        {
+          "name": "ToggleOn",
+          "value": "'TOGGLE_ON'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The user has toggled a switch or button into the on position.\n\nOn Android 13 and older, `ClockTick` is performed instead."
+        },
+        {
+          "name": "VirtualKey",
+          "value": "'VIRTUAL_KEY'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The user has pressed on a virtual on-screen key."
+        }
+      ]
+    }
+  ],
+  "typeAliases": [],
+  "pluginConfigs": []
+}