Methods

  • Adds a new sub-inspection with given values.

    Parameters

    • subInspectionProperties: SubInspectionWorkerCreate

      Object with properties for the new sub-inspection.

    • Optionalindex: number

      Index to insert the new sub-inspection in the list of sub-inspections.

    Returns Promise<void>

  • Cancels the current sub-inspection. If no sub-inspection is showing, does not do anything.

    Returns Promise<void>

  • The current Part that will be recorded for data records.

    This uses the following order of precedence:

    1. The value of a Part test on the current sub-inspection
    2. The value of a Part test in the global tag area
    3. The value of the Part set on the Inspection
    4. Null

    Note that some tests can override this Part on a per-test basis.

    Returns Promise<null | GSBaseEntity>

  • The current Process that will be recorded for data records.

    This uses the following order of precedence:

    1. The value of a Process test on the current sub-inspection
    2. The value of a Process test in the global tag area
    3. The value of the Process set on the Inspection
    4. Null

    Note that some tests can override this Process on a per-test basis.

    Returns Promise<null | GSBaseEntity>

  • Retrieves the id of the current sub-inspection. If no sub-inspection is active, then this will return null.

    Returns Promise<null | string>

  • Navigates to the list of inspections.

    If called during the onBeforeEnd event, any pending submissions will be cancelled.

    Calling this function will not trigger onBeforeEnd or onAfterEnd of the current sub-inspection.

    Returns Promise<void>

  • Navigates to the given sub-inspection.

    If called during the onBeforeEnd event, any pending submissions will be cancelled.

    Calling this function will not trigger onBeforeEnd or onAfterEnd of the current sub-inspection.

    Parameters

    • scriptId: string

      Unique id of the sub-inspection.

    Returns Promise<void>

  • Navigates to the given sub-inspection.

    If called during the onBeforeEnd event, any pending submissions will be cancelled.

    Calling this function will not trigger onBeforeEnd or onAfterEnd of the current sub-inspection.

    Parameters

    • scriptId: string

      Unique id of the sub-inspection.

    Returns Promise<void>

  • Navigates to the list of sub-inspections.

    If called during the onBeforeEnd event, any pending submissions will be cancelled.

    Calling this function will not trigger onBeforeEnd or onAfterEnd of the current sub-inspection.

    Returns Promise<void>

  • Bind a function to fire when all subinspections have been completed. This is checked on subinspection completion, and will never fire if there are no sub inspections.

    Parameters

    Returns ScriptEventSubscription

    ScriptEventSubscription

  • Removes a sub-inspection from the inspection.

    Parameters

    • scriptId: string

      Unique id of the sub-inspection to remove

    Returns Promise<void>

  • Removes a sub-inspection from the inspection.

    Parameters

    • scriptId: string

      Unique id of the sub-inspection to remove

    Returns Promise<void>

  • Allows modification, retrieval, and event binding of a sub-inspection with the given id.

    Type Parameters

    • T extends string

    Parameters

    • scriptId: T

      Unique id of the sub-inspection.

    Returns SubInspectionApi<T>

    An object which allows access to the sub-inspection methods

  • Allows modification, retrieval, and event binding of a sub-inspection with the given id.

    Parameters

    • scriptId: string

      Unique id of the sub-inspection.

    Returns SubInspectionApi<string>

    An object which allows access to the sub-inspection methods

  • Submits the current sub-inspection, if the sub-inspection is in a valid state. If no sub-inspection is showing, does not do anything.

    Returns Promise<boolean>

    Whether or not the current sub-inspection was valid to be submitted

  • Updates the inspection with new values.

    Parameters

    Returns Promise<void>