Scripting API / dashboard/retrievals/RetrievalListener

dashboard/retrievals/RetrievalListener

Modules

Module	Description
External	-

Classes

RetrievalListener

Extends

• GSEventListener<RetrievalEventOptions, RetrievalEventType>

Methods

addEventListener()

addEventListener(eventType, handler): ScriptEventSubscription

Binds the given function to an event fired by one or more sub-inspections. Returns a GUID that can be used to remove the added event

Parameters

Parameter	Type	Description
eventType	"before"	Type of event to bind to (e.g. 'afterStart'). Valid types are determined by the EventType generic.
handler	EventHandler<RetrievalEventOptions>	-

Returns

ScriptEventSubscription

Inherited from

GSEventListener.addEventListener

Type Aliases

RetrievalEventOptions

RetrievalEventOptions = object

Properties

Property	Type
retrievalId	string