Interface FrameworkEvent

A framework event.

interface FrameworkEvent {
    getBundle(): Bundle;
    getError(): undefined | Error;
    getSource(): Bundle;
    getType(): FrameworkEventTypes;
    getTypeName(): FrameworkEventNames;
}

Index

Methods

getBundle getError getSource getType getTypeName

Methods

getBundle

getBundle(): Bundle
Get the bundle associated with the event.

Returns Bundle
the bundle
- Defined in apprt/api/index.ts:617

getError

getError(): undefined | Error
Get the error if the event is of type ERROR.

Returns undefined | Error
the error or 'undefined'
- Defined in apprt/api/index.ts:627

getSource

getSource(): Bundle
Get the source bundle that was throwing the event.

Returns Bundle
the source bundle.
- Defined in apprt/api/index.ts:622

getType

getType(): FrameworkEventTypes
Get the event type as number.

Returns FrameworkEventTypes
the type of the event as number constant.
- Defined in apprt/api/index.ts:607

getTypeName

getTypeName(): FrameworkEventNames
Get the name of the event type.

Returns FrameworkEventNames
the name of the event as string.
- Defined in apprt/api/index.ts:612