SwitchWorkspaceAction
Extends
Constructors
Constructor
new SwitchWorkspaceAction(): SwitchWorkspaceAction;
Returns
SwitchWorkspaceAction
Overrides
Properties
| Property | Modifier | Type | Default value | Inherited from |
|---|---|---|---|---|
actionStore | public | ActionStore | undefined | EntityAction.actionStore |
options | public | ParameterizedActionOptions & EntityActionOptions<WorkspaceModel> | undefined | EntityAction.options |
ID | static | string | 'SWITCH_WORKSPACE' | - |
NAME | static | string | 'Switch workspace' | - |
Accessors
dialogStore
Inherited from
group
Get Signature
get group(): string;
Returns
string
Inherited from
id
Get Signature
get id(): string;
Returns
string
Inherited from
visorStore
Inherited from
workspaceStore
Methods
collectParams()
collectParams(event): Promise<boolean>;
Parameters
| Parameter | Type |
|---|---|
event | EntityActionEvent |
Returns
Promise<boolean>
Inherited from
fireAction()
fireAction(event): Promise<boolean>;
Parameters
| Parameter | Type |
|---|---|
event | Omit<T["EVENT"], "id"> |
Returns
Promise<boolean>
Inherited from
getExclusiveExecutionLock()
getExclusiveExecutionLock(event?): () => any;
Parameters
| Parameter | Type |
|---|---|
event? | { allowed?: (e) => boolean; } |
event.allowed? | (e) => boolean |
Returns
() => any
Inherited from
EntityAction.getExclusiveExecutionLock
getTypeDisplayName()
getTypeDisplayName(): string;
Returns
string
Inherited from
EntityAction.getTypeDisplayName
renderAsButton()
renderAsButton(render, extraData?): Element;
Parameters
| Parameter | Type |
|---|---|
render | (btn) => Element |
extraData | Partial<T["EVENT"]> |
Returns
Element
Inherited from
representAsButton()
representAsButton(extraData?): Btn;
Create a button representation of this action.
The button carries a live validation function, so consumers that render a Btn directly get the same dynamic enabled/disabled behavior as action controls.
Parameters
| Parameter | Type |
|---|---|
extraData | Partial<T["EVENT"]> |
Returns
Inherited from
EntityAction.representAsButton
representAsComboBoxItem()
representAsComboBoxItem(options?): ActionComboBoxItem<SwitchWorkspaceAction>;
Parameters
| Parameter | Type |
|---|---|
options | { eventData?: Partial<T["EVENT"]>; installAction: boolean; } |
options.eventData? | Partial<T["EVENT"]> |
options.installAction | boolean |
Returns
ActionComboBoxItem<SwitchWorkspaceAction>
Inherited from
EntityAction.representAsComboBoxItem
representAsControl()
representAsControl(options?): any;
Parameters
| Parameter | Type |
|---|---|
options | { eventData?: Partial<T["EVENT"]>; } |
options.eventData? | Partial<T["EVENT"]> |
Returns
any
Inherited from
EntityAction.representAsControl
representAsIcon()
representAsIcon(extraData?): Btn;
Parameters
| Parameter | Type |
|---|---|
extraData | Partial<T["EVENT"]> |
Returns
Inherited from
serialize()
serialize(): SerializedAction;
Returns
Inherited from
setActionStore()
setActionStore(store): void;
Parameters
| Parameter | Type |
|---|---|
store | ActionStore |
Returns
void
Inherited from
validate()
validate(event?): ValidationResult;
Parameters
| Parameter | Type |
|---|---|
event | Partial<T["EVENT"]> |
Returns
Inherited from
get()
static get(): SwitchWorkspaceAction;
Returns
SwitchWorkspaceAction