Device APIs

vibrate

Trigger device vibration.

Overview

my.vibrate triggers the device vibration. Use it for haptic feedback on button press or to get the user’s attention.

Sample Code

function vibrate() {
  my.vibrate({
    success: () => {
      my.alert({ title: "Vibration on" });
    },
    fail: (err) => {
      console.log("Vibrate failed", err);
    },
  });
}

Parameters

PropertyTypeRequiredDescription
successFunctionNoCallback function upon call success.
failFunctionNoCallback function upon call failure.
completeFunctionNoCallback function upon call completion (executed whether the call succeeds or fails).

Usage Notes

  • No input parameters are required; calling the API triggers a short vibration.
  • Useful for confirming user actions (e.g. long-press, success feedback).