Interface SurfaceContext

The context provided to a surface module when running

interface SurfaceContext {
    get capabilities(): HostCapabilities;
    get isLocked(): boolean;
    changePage(forward: boolean): void;
    disconnect(error: Error): void;
    keyDownById(controlId: string): void;
    keyDownUpById(controlId: string): void;
    keyUpById(controlId: string): void;
    rotateLeftById(controlId: string): void;
    rotateRightById(controlId: string): void;
    sendVariableValue(variable: string, value: any): void;
}

Index

Accessors

capabilities isLocked

Methods

changePage disconnect keyDownById keyDownUpById keyUpById rotateLeftById rotateRightById sendVariableValue

Accessors

capabilities

get capabilities(): HostCapabilities
The capabilities of the host running the surface

Returns HostCapabilities
- Defined in packages/base/src/surface-api/context.ts:20

isLocked

get isLocked(): boolean
Whether the surface is currently locked

Returns boolean
- Defined in packages/base/src/surface-api/context.ts:15

Methods

changePage

changePage(forward: boolean): void
Change the current page of the surface
Parameters
- forward: boolean
  Whether to progress forward or backwards
Returns void
- Defined in packages/base/src/surface-api/context.ts:58

disconnect

disconnect(error: Error): void
Disconnect the surface
Parameters
- error: Error
  Disconnection reason
Returns void
- Defined in packages/base/src/surface-api/context.ts:26

keyDownById

keyDownById(controlId: string): void
Trigger a key down event on a control by its id
Parameters
- controlId: string
  Id of the control
Returns void
- Defined in packages/base/src/surface-api/context.ts:32

keyDownUpById

keyDownUpById(controlId: string): void
Trigger a key down and a key up event on a control by its id
Parameters
- controlId: string
  Id of the control
Returns void
- Defined in packages/base/src/surface-api/context.ts:42

keyUpById

keyUpById(controlId: string): void
Trigger a key up event on a control by its id
Parameters
- controlId: string
  Id of the control
Returns void
- Defined in packages/base/src/surface-api/context.ts:37

rotateLeftById

rotateLeftById(controlId: string): void
Trigger a left rotation event on a control by its id
Parameters
- controlId: string
  Id of the control
Returns void
- Defined in packages/base/src/surface-api/context.ts:47

rotateRightById

rotateRightById(controlId: string): void
Trigger a right rotation event on a control by its id
Parameters
- controlId: string
  Id of the control
Returns void
- Defined in packages/base/src/surface-api/context.ts:52

sendVariableValue

sendVariableValue(variable: string, value: any): void
Send a value of a transferVariable from surface
Parameters
- variable: string
  Name of the variable
- value: any
  Value of the variable
Returns void
- Defined in packages/base/src/surface-api/context.ts:65