Class GlobalTagAreaApi

Implements

TestContainer

Implements

TestContainer

Index

Methods

addDateTimeTest addInputTest addPartTest addProcessTest addTraceabilityTest allTestEvents dateTime input onClose part process removeTest traceability

Methods

addDateTimeTest

addDateTimeTest(testProperties): Promise<void>
Adds a Date/Time test with the given properties to the global tag area
Parameters
- testProperties: DateTimeTestWorkerCreate
  The properties with which the test will be initialized
Returns Promise<void>
Implementation of TestContainer.addDateTimeTest

addInputTest

addInputTest(testProperties): Promise<void>
Adds an Input test with the given properties to the global tag area
Parameters
- testProperties: CopyableCreate<InputTestWorkerCreate, string>
  The properties with which the test will be initialized
Returns Promise<void>

addPartTest

addPartTest(testProperties): Promise<void>
Adds a Part test with the given properties to this sub-inspection
Parameters
- testProperties: PartTestWorkerCreate
  The properties with which the test will be initialized
Returns Promise<void>

addProcessTest

addProcessTest(testProperties): Promise<void>
Adds a Process test with the given properties to the global tag area
Parameters
- testProperties: ProcessTestWorkerCreate
  The properties with which the test will be initialized
Returns Promise<void>
Implementation of TestContainer.addProcessTest

addTraceabilityTest

addTraceabilityTest(testProperties): Promise<void>
Adds a Traceability test with the given properties to the global tag area
Parameters
- testProperties: CopyableCreate<TraceabilityTestWorkerCreate, string>
  The properties with which the test will be initialized
Returns Promise<void>
Implementation of TestContainer.addTraceabilityTest

allTestEvents

allTestEvents(): AllTestEventsApi
Allows event binding to all tests in the global tag area

Returns AllTestEventsApi
An object which allows access to test event bindings.

Implementation of TestContainer.allTestEvents

dateTime

dateTime(scriptId): DateTimeTestApi
Parameters
- scriptId: string
  Unique id of the test.
Returns DateTimeTestApi
Implementation of TestContainer.dateTime

input

input(scriptId): InputTestApi
Parameters
- scriptId: string
  Unique id of the test.
Returns InputTestApi
Implementation of TestContainer.input

onClose

onClose(fn): ScriptEventSubscription
Bind a function to fire when the global tag area has been completed and closed. This function fires every time the global tag area has been closed.
Parameters
- fn: ((event: ScriptEvent) => void)
  The function to fire.
  - - (event): void
    - Parameters
      event: ScriptEvent
      Returns void
Returns ScriptEventSubscription
ScriptEventSubscription

part

part(scriptId): PartTestApi
Allows modification and retrieval of a Part test with the given id.
Parameters
- scriptId: string
  Unique id of the test.
Returns PartTestApi
An object which allows access to the test methods

process

process(scriptId): ProcessTestApi
Parameters
- scriptId: string
  Unique id of the test.
Returns ProcessTestApi
Implementation of TestContainer.process

removeTest

removeTest(scriptId): Promise<void>
Parameters
- scriptId: string
  The id of the test to remove.
Returns Promise<void>
Implementation of TestContainer.removeTest

traceability

traceability(scriptId): TraceabilityTestApi
Parameters
- scriptId: string
  Unique id of the test.
Returns TraceabilityTestApi
Implementation of TestContainer.traceability