Class Sentinel

Hierarchy

Sentinel

Index

Constructors

constructor

Properties

Accessors

started

Methods

Constructors

constructor

new Sentinel(): Sentinel

- Defined in src/sentinel/index.ts:57
Creates an instance of Sentinel

Returns Sentinel

Properties

offline

offline: SentinelOffline

The sentinel offline features

performance

performance: SentinelPerformance

The sentinel performance features

status

status: SentinelStatus

The sentinel and EVA status

Accessors

started

get started(): boolean

- Defined in src/sentinel/index.ts:38
Indicates sentinel support has been enabled

readonly

Returns boolean

Methods

getConfiguration

getConfiguration(): undefined | GetApplicationConfigurationResponse

- Defined in src/sentinel/index.ts:126
Returns a copy of the configuration from the Sentinel

Returns undefined | GetApplicationConfigurationResponse

Protected getEndpoint

getEndpoint(): string

- Defined in src/sentinel/index.ts:76
Helper method to get the current sentinel endpoint

Returns string

getOrganizationUnitID

getOrganizationUnitID(): undefined | number

- Defined in src/sentinel/index.ts:135
Returns the organization unit the sentinel belongs to

Returns undefined | number

number|undefined

Protected getSignalREndpoint

getSignalREndpoint(): any

- Defined in src/sentinel/index.ts:90
Helper method to get the current sentinel SignalR endpoint

Returns any

getStatusHubDetails

getStatusHubDetails(): IEvaSignalRHub

- Defined in src/sentinel/index.ts:107
Returns the SignalR hub from getApplicationConfiguration response for the sentinel Only available after sentinel has been bootstrapped

Returns IEvaSignalRHub

start

start(): Promise<void>

- Defined in src/sentinel/index.ts:146
Start listening to the getApplicationConfig Will resolve its promise when first application config is received

memberof

Sentinel

Returns Promise<void>

stop

stop(): Promise<void>

- Defined in src/sentinel/index.ts:221
Stops EVA Sentinel support

Returns Promise<void>