Class OEETestApi

Implements

IHasTestFocusEvents

Implements

IFocusableTest

Implements

ISelectableTest

Implements

IUpdateablePropertyTest

Implements

IValueTest

Implements

IDataTest

Hierarchy (view full)

TestApi
- OEETestApi

Implements

Index

Properties

scriptId testType

Methods

clearValue focus getProperties onFocusIn onFocusOut onRTFChanged 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<OEETestWorkerGet>
Gets the test's properties

Returns Promise<OEETestWorkerGet>
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

onRTFChanged

onRTFChanged(fn): ScriptEventSubscription
Bind a function to fire after a real-time failure has changed.
Parameters
- fn: ((event: TestRTFChangedScriptEvent) => void)
  The function to fire.
  - - (event): void
    - Parameters
      event: TestRTFChangedScriptEvent
      Returns void
Returns ScriptEventSubscription
ScriptEventSubscription

Implementation of IDataTest.onRTFChanged

updateProperties

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