AppVibrate Method (CLIENT)

PLB Web Only, 9.9

The AppVibrate method provides a way to vibrate the mobile device. The method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. A CLIENT object.

return

Optional. A Numeric Variable that returns the success or failure of the method.

time

Optional. A Numeric Variable or decimal number whose value specifies the amount of time to vibrate the mobile device.

Flags Affected: OVER, ZERO

Note the following:

1. This method is only used for a Sunbelt PL/B Web Client App using Cordova\PhoneGap operations. See the following link for details on the Cordova plugin used:

 

     https://www.npmjs.com/package/cordova-plugin-vibration

 

2. The ZERO flag is set when the {return} value is zero.

3. The OVER flag is set if the value returned is too large to be stored into the {return} variable.

4. The {time} parameter defines the time to vibrate the mobile device. The {time} value is given in milliseconds. The default time is 3000ms.

Example Code

      Client.AppVibrate Using 1000 // 1 second vibrate!

See Also: CLIENT, Client Methods, Method Syntax