Skip to content

Scripting API / inspection/GlobalTagAreaApi

inspection/GlobalTagAreaApi

Classes

GlobalTagAreaApi

Implements

TestContainer

Implements

Methods

addDateTimeTest()

addDateTimeTest(testProperties): Promise<void>

Adds a Date/Time test with the given properties to the global tag area

Parameters
Parameter Type Description
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
Parameter Type Description
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
Parameter Type Description
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
Parameter Type Description
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
Parameter Type Description
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
Parameter Type Description
scriptId string Unique id of the test.
Returns

DateTimeTestApi

Implementation of

TestContainer.dateTime

getTests()

getTests(): Promise<TestsInInspectionWorkerGet[]>

Gets a list of tests inside of the global tag area

Returns

Promise<TestsInInspectionWorkerGet[]>

A list of all tests in the global tag area.

Implementation of

TestContainer.getTests

input()

input(scriptId): InputTestApi

Parameters
Parameter Type Description
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
Parameter Type Description
fn (event) => void The function to fire.
Returns

ScriptEventSubscription

ScriptEventSubscription

part()

part(scriptId): PartTestApi

Allows modification and retrieval of a Part test with the given id.

Parameters
Parameter Type Description
scriptId string Unique id of the test.
Returns

PartTestApi

An object which allows access to the test methods

process()

process(scriptId): ProcessTestApi

Parameters
Parameter Type Description
scriptId string Unique id of the test.
Returns

ProcessTestApi

Implementation of

TestContainer.process

removeTest()

removeTest(scriptId): Promise<void>

Parameters
Parameter Type Description
scriptId string The id of the test to remove.
Returns

Promise<void>

Implementation of

TestContainer.removeTest

traceability()

traceability(scriptId): TraceabilityTestApi

Parameters
Parameter Type Description
scriptId string Unique id of the test.
Returns

TraceabilityTestApi

Implementation of

TestContainer.traceability