ActionsService
service
Properties
Section titled “Properties”iconRegistry
Section titled “iconRegistry”Type: unknown
Default Value: inject(MatIconRegistry)
Methods
Section titled “Methods”concealActions
Section titled “concealActions”Conceals actions that are no longer needed or should not be available. This will remove the actions from the registered actions list.
concealActions(actionIDs: string[]): voidArguments
Section titled “Arguments”| Name | Type | Description |
|---|---|---|
| actionIDs | string[] |
getActionById
Section titled “getActionById”getActionById(id: string, context?: ActionContext): Action | undefinedArguments
Section titled “Arguments”| Name | Type | Description |
|---|---|---|
| id | string | |
| context | ActionContext |
getActions
Section titled “getActions”Returns all actions that are executable for the given selection.
getActions(selection: DmsObject[], options?: ActionOptions): Observable<Action[]>Arguments
Section titled “Arguments”| Name | Type | Description |
|---|---|---|
| selection | DmsObject[] | |
| options | ActionOptions |
getActionsById
Section titled “getActionsById”getActionsById(ids: string[], context?: ActionContext): Action[]Arguments
Section titled “Arguments”| Name | Type | Description |
|---|---|---|
| ids | string[] | |
| context | ActionContext |
getActionsForType
Section titled “getActionsForType”getActionsForType(objectTypeId: string, context?: ActionContext): Action[]Arguments
Section titled “Arguments”| Name | Type | Description |
|---|---|---|
| objectTypeId | string | |
| context | ActionContext |
getAvailableActions
Section titled “getAvailableActions”Get all available actions. This includes the default actions and all registered actions but without checking if they are executable.
getAvailableActions(context?: ActionContext): Action[]Arguments
Section titled “Arguments”| Name | Type | Description |
|---|---|---|
| context | ActionContext |
openContextMenu
Section titled “openContextMenu”openContextMenu(actions: Signal<Action[]>, callback: function, overlayOrigin: literal type): voidArguments
Section titled “Arguments”| Name | Type | Description |
|---|---|---|
| actions | Signal<Action[]> | |
| callback | function | |
| overlayOrigin | literal type |
registerActions
Section titled “registerActions”Registers actions that can be used in the application. class that extends ActionClass
registerActions(a: literal type[]): voidArguments
Section titled “Arguments”| Name | Type | Description |
|---|---|---|
| a | literal type[] |
registerDefaultActions
Section titled “registerDefaultActions”Registers a set of default actions that are commonly used in the application. These actions include delete, download, copy and cut. This method can be called during the initialization of the application to ensure that these actions are available for use.
registerDefaultActions(): void