Class AllSubInspectionEventsApi

Allows event binding to all subinspections.

Hierarchy (view full)

CoreSubInspectionApi
- AllSubInspectionEventsApi

Index

Methods

onAfterEnd onAfterStart onBeforeEnd

Methods

onAfterEnd

onAfterEnd(fn): ScriptEventSubscription
Bind a function to fire after a sub-inspection has ended.
Parameters
- fn: ((event: SubInspectionAfterEndScriptEvent) => void)
  The function to fire.
  - - (event): void
    - Parameters
      event: SubInspectionAfterEndScriptEvent
      Returns void
Returns ScriptEventSubscription
ScriptEventSubscription

Inherited from CoreSubInspectionApi.onAfterEnd

onAfterStart

onAfterStart(fn): ScriptEventSubscription
Bind a function to fire after a sub-inspection has begun.
Parameters
- fn: ((event: SubInspectionAfterStartScriptEvent) => void)
  The function to fire.
  - - (event): void
    - Parameters
      event: SubInspectionAfterStartScriptEvent
      Returns void
Returns ScriptEventSubscription
ScriptEventSubscription

Inherited from CoreSubInspectionApi.onAfterStart

onBeforeEnd

onBeforeEnd(fn): ScriptEventSubscription
Bind a function to fire before a sub-inspection ends. preventDefault can be called on the event to prevent the sub inspection from ending.
Parameters
- fn: ((event: SubInspectionBeforeEndScriptEvent) => void)
  The function to fire.
  - - (event): void
    - Parameters
      event: SubInspectionBeforeEndScriptEvent
      Returns void
Returns ScriptEventSubscription
ScriptEventSubscription

Inherited from CoreSubInspectionApi.onBeforeEnd