Class Shake

A device motion handler that dispatches a "shake" event as appropriate.

Original author: Jesse Jackson - https://github.com/jsejcksn This part of the code is licensed under CC BY-SA 4.0

Hierarchy

EventTarget
- Shake

Index

Constructors

Methods

addEventListener approve dispatchEvent removeEventListener start stop

Constructors

constructor

new Shake(options?: Partial<ShakeOptions>): Shake
Construct a new device shake handler.
Parameters
- Optionaloptions: Partial<ShakeOptions>
  The options for the handler.
Returns Shake
Overrides EventTarget.constructor
- Defined in source/device/shake.ts:80

Methods

addEventListener

addEventListener(
    type: "shake",
    listener: null | ShakeEventListener,
    options?: boolean | AddEventListenerOptions,
): void
Add a new shake event listener.
Parameters
- type: "shake"
  The type of the event to handle.
- listener: null | ShakeEventListener
  The event handler to call.
- Optionaloptions: boolean | AddEventListenerOptions
  The options for this handler.
Returns void
Overrides EventTarget.addEventListener
- Defined in source/device/shake.ts:96

approve

approve(): Promise<boolean>
Requests approval to handle device motion events.

Returns Promise<boolean>
true if we got approval, false otherwise.
- Defined in source/device/shake.ts:134

dispatchEvent

dispatchEvent(event: ShakeEvent): boolean
Dispatch a shake event.
Parameters
- event: ShakeEvent
  The event to dispatch.
Returns boolean
true if the event was cancelled, false otherwise.
Overrides EventTarget.dispatchEvent
- Defined in source/device/shake.ts:110

removeEventListener

removeEventListener(
    type: "shake",
    callback: null | ShakeEventListener,
    options?: boolean | EventListenerOptions,
): void
Removes a previously added event listener.
Parameters
- type: "shake"
  The type of the event to remove.
- callback: null | ShakeEventListener
  The event handler to remove.
- Optionaloptions: boolean | EventListenerOptions
  The options the event handler was added with.
Returns void
Overrides EventTarget.removeEventListener
- Defined in source/device/shake.ts:121

start

start(): Promise<boolean>
Start handling device shake.

Returns Promise<boolean>
true if we were able to register our handler, false otherwise.
- Defined in source/device/shake.ts:181

stop

stop(): void
Stop handling device shake.

Returns void
- Defined in source/device/shake.ts:191