Table of Contents

• 1. Introduction
• 2. Conformance
• 3. Terminology
• 4. Vibration Interface
• 5. Examples
• A. Acknowledgements
• B. References
  • B.1 Normative references
  • B.2 Informative references

2. Conformance

As well as sections marked as non-normative, all authoring guidelines, diagrams, examples, and notes in this specification are non-normative. Everything else in this specification is normative.

The key words MAY and MUST are to be interpreted as described in [RFC2119].

This specification defines conformance criteria that apply to a single product: the user agent that implements the interfaces that it contains.

Implementations that use ECMAScript to implement the APIs defined in this specification must implement them in a manner consistent with the ECMAScript Bindings defined in the Web IDL specification [WEBIDL], as this specification uses that specification and terminology.

3. Terminology

The concepts browsing context and spin the event loop are defined in [HTML5].

4. Vibration Interface

typedef (unsigned long or sequence<unsigned long>) VibratePattern;

partial interface Navigator {
    boolean vibrate (VibratePattern pattern);
};

The vibrate() method, when invoked, MUST run the algorithm for processing vibration patterns.

The rules for processing vibration patterns are as given in the following algorithm:

1. Let pattern be the first method argument of the vibrate() method.
2. Let valid pattern be the result of passing pattern to validate and normalize.
3. If the hidden attribute [PAGE-VISIBILITY] is set to true, then return false and terminate these steps.
   Note

   A trusted (also known as privileged) application that integrates closely with the operating system's functionality may vibrate the device even if such an application is not visible at all, and thus may ignore the previous step.
4. Perform vibration with valid pattern.

To validate and normalize a vibration pattern given pattern, run these steps:

1. If pattern is a list, proceed to the next step. Otherwise run the following substeps:
   1. Let list be an initially empty list, and add pattern to list.
   2. Set pattern to list.
2. Let max length be an implementation-dependent maximum length of pattern.
   Note

   If the length of a pattern is greater than max length an implementation of this API could consider breaking the request effectively into multiple shorter requests internally to achieve the same effect, rather than ignoring what follows the max length. There are cases, however, where it is appropriate to ignore the pattern exceeding the max length. An example is if the length is so long that it would effectively create a denial of service attack on the user. A web application might also make multiple requests if it is known to the application that the length is too long for some implementations and a possible gap in between patterns is acceptable.
3. If the length of pattern is greater than max length, truncate pattern, leaving only the first max length entries.
   Note

   If the length of the pattern is even and not zero then the last entry in the pattern will have no effect so an implementation can remove it from the pattern at this point.
4. Let max duration be an implementation-dependent maximum duration for a single vibration entry in a pattern.
5. For each entry in pattern whose value is greater than max duration, set the entry's value to max duration.
6. Return pattern.

To perform vibration using pattern, run these steps:

1. An implementation MAY return false and terminate these steps.
   Note

   For example, an implementation might abort the algorithm because the user has set a preference indicating that pages at a given origin should never be able to vibrate the device, or an implementation might cap the total amount of time a page may cause the device to vibrate and reject requests in excess of this limit.
2. If another instance of the perform vibration algorithm is already running, run the following substeps:
   1. Abort that other instance of the perform vibration algorithm, if any.
   2. If pattern is an empty list, contains a single entry with a value of 0, or if the device is unable to vibrate, then return true and terminate these steps.
3. Return true, and then continue running these steps asynchronously.
4. For each time in pattern, run the following substeps:
   1. If the index of time is even (the first entry has index 0), vibrate the device for time milliseconds.
   2. Otherwise wait for time milliseconds.

When the visibilitychange event [PAGE-VISIBILITY] is dispatched at the Document in a browsing context, the user agent MUST abort the already running processing vibration patterns algorithm, if any.