Class InputTestApi

Implements

IHasTestFocusEvents

Implements

IFocusableTest

Implements

ISelectableTest

Implements

IUpdateablePropertyTest

Implements

IValueTest

Hierarchy (view full)

TestApi
- InputTestApi

Implements

Index

Properties

scriptId testType

Methods

clearValue focus getProperties onFocusIn onFocusOut onOptionSelected onPaginate updateProperties

Properties

scriptId

scriptId: string

testType

testType: InspectionTest

Methods

clearValue

clearValue(): Promise<void>
Clears a currently-running test's value. This throws an error if the test is not in the currently-running sub-inspection or the global tag area.

Returns Promise<void>
Implementation of IValueTest.clearValue

focus

focus(): Promise<void>
Moves the focus to this test. This does nothing if the test is not in the currently-running sub-inspection or the global tag area.

Returns Promise<void>
Implementation of IFocusableTest.focus

getProperties

getProperties(): Promise<InputTestWorkerGet>
Gets the test's properties

Returns Promise<InputTestWorkerGet>
Implementation of IUpdateablePropertyTest.getProperties

onFocusIn

onFocusIn(fn): ScriptEventSubscription
Bind a function to fire after a test gained focus.
Parameters
- fn: ((event: TestScriptEvent) => void)
  The function to fire.
  - - (event): void
    - Parameters
      event: TestScriptEvent
      Returns void
Returns ScriptEventSubscription
ScriptEventSubscription

Implementation of IHasTestFocusEvents.onFocusIn

onFocusOut

onFocusOut(fn): ScriptEventSubscription
Bind a function to fire after a test lost focus.
Parameters
- fn: ((event: TestFocusOutScriptEvent) => void)
  The function to fire.
  - - (event): void
    - Parameters
      event: TestFocusOutScriptEvent
      Returns void
Returns ScriptEventSubscription
ScriptEventSubscription

Implementation of IHasTestFocusEvents.onFocusOut

onOptionSelected

onOptionSelected(fn): ScriptEventSubscription
Bind a function to fire when an option was selected on a selectable test.
Parameters
- fn: ((event: TestOptionSelectedScriptEvent) => void)
  The function to fire.
  - - (event): void
    - Parameters
      event: TestOptionSelectedScriptEvent
      Returns void
Returns ScriptEventSubscription
ScriptEventSubscription

Implementation of ISelectableTest.onOptionSelected

onPaginate

onPaginate(fn): ScriptEventSubscription
Bind a function to fire whenever pagination is requested. To return the pagination data, call setResponse() on the event. This expects a ListApiResponse.
Parameters
- fn: ((event: TestPaginationRequestedScriptEvent) => Promise<void>)
  The function to fire. The event data will be a ListRequestOptions.
  - - (event): Promise<void>
    - Parameters
      event: TestPaginationRequestedScriptEvent
      Returns Promise<void>
Returns ScriptEventSubscription
ScriptEventSubscription

Implementation of IPaginatableTest.onPaginate

updateProperties

updateProperties(newProps): Promise<any>
Updates the test with new values.
Parameters
- newProps: InputTestWorkerUpdate
  Object with new properties to use
Returns Promise<any>
Implementation of IUpdateablePropertyTest.updateProperties