Class DataStoreModalToolContainer

Index

Constructors

Properties

toolActivationChanged

Methods

getSelectedTool getToolPayload getToolProperty hasToolPayload hasToolProperty registerTool unregisterTool updateRegisteredTool updateRegisteredToolProperty updateSelectedTool

Constructors

`Private`constructor

new DataStoreModalToolContainer(): DataStoreModalToolContainer
Returns DataStoreModalToolContainer

Properties

`Readonly`toolActivationChanged

toolActivationChanged: DataStoreModalToolActivationChangedEventSignal

Methods

getSelectedTool

getSelectedTool(): string
Returns string

getToolPayload

getToolPayload(id: string): string
Parameters
- id: string
Returns string
Remarks
Write Privilege
This function can't be called in read-only mode.

World Ready
This function can't be called in early-execution mode.

getToolProperty

getToolProperty(id: string, property: string): string | number | boolean
Parameters
- id: string
- property: string
Returns string | number | boolean
Remarks
Write Privilege
This function can't be called in read-only mode.

World Ready
This function can't be called in early-execution mode.

hasToolPayload

hasToolPayload(id: string): boolean
Parameters
- id: string
Returns boolean
Remarks
Write Privilege
This function can't be called in read-only mode.

World Ready
This function can't be called in early-execution mode.

hasToolProperty

hasToolProperty(id: string, property: string): boolean
Parameters
- id: string
- property: string
Returns boolean
Remarks
Write Privilege
This function can't be called in read-only mode.

World Ready
This function can't be called in early-execution mode.

registerTool

registerTool(id: string, payload: string): void
Parameters
- id: string
- payload: string
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

unregisterTool

unregisterTool(id: string): void
Parameters
- id: string
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

updateRegisteredTool

updateRegisteredTool(id: string, payload: string): void
Parameters
- id: string
- payload: string
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

updateRegisteredToolProperty

updateRegisteredToolProperty(
    id: string,
    payload: string,
    property: string,
): void
Parameters
- id: string
- payload: string
- property: string
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

updateSelectedTool

updateSelectedTool(toolId?: string): void
Parameters
- OptionaltoolId: string
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.