SystemStatusApi

Provides access to System Status Module and associated state

export interface

Methods

Method Details

deleteAllSystemStatusMessages

Deletes all System Status messages

deleteAllSystemStatusMessages(): void;

Returns

void

getCurrentSystemStatusMessageInfo

Retrieves current System Status Message

getCurrentSystemStatusMessageInfo(): SystemStatusMessageInfo | undefined;

Returns

SystemStatusMessageInfo | undefined

openSystemStatusSettingsPanel

Opens Settings Panel with System Status section selected and visible

openSystemStatusSettingsPanel(): void;

Returns

void

setErrorSystemStatus

Sets an Error System Status Message

setErrorSystemStatus(statusMessage: string, furtherInformation?: string): void;

Parameters

Returns

void

setInfoSystemStatus

Sets an Info System Status Message

setInfoSystemStatus(statusMessage: string, furtherInformation?: string): void;

Parameters

Returns

void

setSuccessSystemStatus

Sets a Success System Status Message

setSuccessSystemStatus(statusMessage: string, furtherInformation?: string): void;

Parameters

Returns

void

setSystemStatus

Sets a new System Status message; appears in System Status toolbar, tool panel (and popup).

setSystemStatus(statusMessage: string, messageType: 'Success' | 'Info' | 'Warning' | 'Error', statusFurtherInformation?: string): void;

Parameters

Returns

void

setWarningSystemStatus

Sets a Warning System Status Message

setWarningSystemStatus(statusMessage: string, furtherInformation?: string): void;

Parameters

Returns

void