-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
updated documentation for modules: @tridion-sites-extensions-3.0.0,@t…
…ridion-sites-extensions-cli-1.2.0,@tridion-sites-extensions-cli-1.2.1,@tridion-sites-models-2.0.0,@tridion-sites-open-api-client-4.0.0
- Loading branch information
RWS
authored and
RWS
committed
Jan 8, 2025
1 parent
db5d599
commit 1690353
Showing
3,608 changed files
with
57,477 additions
and
0 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@tridion-sites/extensions-cli](./extensions-cli.md) > [extensionsRequestBasePath](./extensions-cli.extensionsrequestbasepath.md) | ||
|
||
## extensionsRequestBasePath variable | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
extensionsRequestBasePath = '/api/uiExtensionsRepository'; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@tridion-sites/extensions-cli](./extensions-cli.md) > [getLocalFrontendAddon](./extensions-cli.getlocalfrontendaddon.md) | ||
|
||
## getLocalFrontendAddon variable | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
getLocalFrontendAddon: ({ manifestPath, addonConfigPath }: GetLocalFrontendAddonParams) => BackendFrontendAddon; | ||
``` |
11 changes: 11 additions & 0 deletions
11
docs/extensions-cli.getlocalfrontendaddonparams.addonconfigpath.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@tridion-sites/extensions-cli](./extensions-cli.md) > [GetLocalFrontendAddonParams](./extensions-cli.getlocalfrontendaddonparams.md) > [addonConfigPath](./extensions-cli.getlocalfrontendaddonparams.addonconfigpath.md) | ||
|
||
## GetLocalFrontendAddonParams.addonConfigPath property | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
addonConfigPath?: string; | ||
``` |
11 changes: 11 additions & 0 deletions
11
docs/extensions-cli.getlocalfrontendaddonparams.manifestpath.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@tridion-sites/extensions-cli](./extensions-cli.md) > [GetLocalFrontendAddonParams](./extensions-cli.getlocalfrontendaddonparams.md) > [manifestPath](./extensions-cli.getlocalfrontendaddonparams.manifestpath.md) | ||
|
||
## GetLocalFrontendAddonParams.manifestPath property | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
manifestPath: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@tridion-sites/extensions-cli](./extensions-cli.md) > [GetLocalFrontendAddonParams](./extensions-cli.getlocalfrontendaddonparams.md) | ||
|
||
## GetLocalFrontendAddonParams interface | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export interface GetLocalFrontendAddonParams | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Modifiers | Type | Description | | ||
| ----------------------------------------------------------------------------------- | --------- | ------ | ------------ | | ||
| [addonConfigPath?](./extensions-cli.getlocalfrontendaddonparams.addonconfigpath.md) | | string | _(Optional)_ | | ||
| [manifestPath](./extensions-cli.getlocalfrontendaddonparams.manifestpath.md) | | string | | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@tridion-sites/extensions-cli](./extensions-cli.md) | ||
|
||
## extensions-cli package | ||
|
||
## Interfaces | ||
|
||
| Interface | Description | | ||
| ---------------------------------------------------------------------------------- | ----------- | | ||
| [GetLocalFrontendAddonParams](./extensions-cli.getlocalfrontendaddonparams.md) | | | ||
| [SetupExtensionsResponseParams](./extensions-cli.setupextensionsresponseparams.md) | | | ||
|
||
## Variables | ||
|
||
| Variable | Description | | ||
| -------------------------------------------------------------------------- | ----------- | | ||
| [extensionsRequestBasePath](./extensions-cli.extensionsrequestbasepath.md) | | | ||
| [getLocalFrontendAddon](./extensions-cli.getlocalfrontendaddon.md) | | | ||
| [setupExtensionsResponse](./extensions-cli.setupextensionsresponse.md) | | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@tridion-sites/extensions-cli](./extensions-cli.md) > [setupExtensionsResponse](./extensions-cli.setupextensionsresponse.md) | ||
|
||
## setupExtensionsResponse variable | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
setupExtensionsResponse: ({ app, webAppPath, manifestPath, addonConfigPath, targetUrl, }: SetupExtensionsResponseParams) => void | ||
``` |
11 changes: 11 additions & 0 deletions
11
docs/extensions-cli.setupextensionsresponseparams.addonconfigpath.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@tridion-sites/extensions-cli](./extensions-cli.md) > [SetupExtensionsResponseParams](./extensions-cli.setupextensionsresponseparams.md) > [addonConfigPath](./extensions-cli.setupextensionsresponseparams.addonconfigpath.md) | ||
|
||
## SetupExtensionsResponseParams.addonConfigPath property | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
addonConfigPath?: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@tridion-sites/extensions-cli](./extensions-cli.md) > [SetupExtensionsResponseParams](./extensions-cli.setupextensionsresponseparams.md) > [app](./extensions-cli.setupextensionsresponseparams.app.md) | ||
|
||
## SetupExtensionsResponseParams.app property | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
app: Application; | ||
``` |
11 changes: 11 additions & 0 deletions
11
docs/extensions-cli.setupextensionsresponseparams.manifestpath.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@tridion-sites/extensions-cli](./extensions-cli.md) > [SetupExtensionsResponseParams](./extensions-cli.setupextensionsresponseparams.md) > [manifestPath](./extensions-cli.setupextensionsresponseparams.manifestpath.md) | ||
|
||
## SetupExtensionsResponseParams.manifestPath property | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
manifestPath: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@tridion-sites/extensions-cli](./extensions-cli.md) > [SetupExtensionsResponseParams](./extensions-cli.setupextensionsresponseparams.md) | ||
|
||
## SetupExtensionsResponseParams interface | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export interface SetupExtensionsResponseParams | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Modifiers | Type | Description | | ||
| ------------------------------------------------------------------------------------- | --------- | ----------- | ------------ | | ||
| [addonConfigPath?](./extensions-cli.setupextensionsresponseparams.addonconfigpath.md) | | string | _(Optional)_ | | ||
| [app](./extensions-cli.setupextensionsresponseparams.app.md) | | Application | | | ||
| [manifestPath](./extensions-cli.setupextensionsresponseparams.manifestpath.md) | | string | | | ||
| [targetUrl?](./extensions-cli.setupextensionsresponseparams.targeturl.md) | | string | _(Optional)_ | | ||
| [webAppPath](./extensions-cli.setupextensionsresponseparams.webapppath.md) | | string | | |
11 changes: 11 additions & 0 deletions
11
docs/extensions-cli.setupextensionsresponseparams.targeturl.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@tridion-sites/extensions-cli](./extensions-cli.md) > [SetupExtensionsResponseParams](./extensions-cli.setupextensionsresponseparams.md) > [targetUrl](./extensions-cli.setupextensionsresponseparams.targeturl.md) | ||
|
||
## SetupExtensionsResponseParams.targetUrl property | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
targetUrl?: string; | ||
``` |
11 changes: 11 additions & 0 deletions
11
docs/extensions-cli.setupextensionsresponseparams.webapppath.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@tridion-sites/extensions-cli](./extensions-cli.md) > [SetupExtensionsResponseParams](./extensions-cli.setupextensionsresponseparams.md) > [webAppPath](./extensions-cli.setupextensionsresponseparams.webapppath.md) | ||
|
||
## SetupExtensionsResponseParams.webAppPath property | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
webAppPath: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@tridion-sites/extensions](./extensions.md) > [AccessibleComponentProps](./extensions.accessiblecomponentprops.md) > [aria](./extensions.accessiblecomponentprops.aria.md) | ||
|
||
## AccessibleComponentProps.aria property | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
aria: Pick<Partial<AriaProps>, K>; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@tridion-sites/extensions](./extensions.md) > [AccessibleComponentProps](./extensions.accessiblecomponentprops.md) | ||
|
||
## AccessibleComponentProps interface | ||
|
||
Accessibility-related props | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export interface AccessibleComponentProps<K extends keyof AriaProps> | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Modifiers | Type | Description | | ||
| ----------------------------------------------------- | --------- | ---------------------------------------------------------------------------- | ----------- | | ||
| [aria](./extensions.accessiblecomponentprops.aria.md) | | Pick<Partial<[AriaProps](./extensions.ariaprops.md)<!-- -->>, K> | | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@tridion-sites/extensions](./extensions.md) > [ActionExtension](./extensions.actionextension.md) | ||
|
||
## ActionExtension type | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export type ActionExtension = () => ActionExtensionConfiguration; | ||
``` | ||
|
||
**References:** [ActionExtensionConfiguration](./extensions.actionextensionconfiguration.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@tridion-sites/extensions](./extensions.md) > [ActionExtensionConfiguration](./extensions.actionextensionconfiguration.md) > [icon](./extensions.actionextensionconfiguration.icon.md) | ||
|
||
## ActionExtensionConfiguration.icon property | ||
|
||
Icon associated with the action. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
readonly icon: CustomIcon; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@tridion-sites/extensions](./extensions.md) > [ActionExtensionConfiguration](./extensions.actionextensionconfiguration.md) > [id](./extensions.actionextensionconfiguration.id.md) | ||
|
||
## ActionExtensionConfiguration.id property | ||
|
||
A unique identifier for the action. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
readonly id: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@tridion-sites/extensions](./extensions.md) > [ActionExtensionConfiguration](./extensions.actionextensionconfiguration.md) > [label](./extensions.actionextensionconfiguration.label.md) | ||
|
||
## ActionExtensionConfiguration.label property | ||
|
||
Label associated with the action. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
readonly label: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@tridion-sites/extensions](./extensions.md) > [ActionExtensionConfiguration](./extensions.actionextensionconfiguration.md) | ||
|
||
## ActionExtensionConfiguration interface | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export interface ActionExtensionConfiguration | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Modifiers | Type | Description | | ||
| ------------------------------------------------------------------- | --------- | ---------------------------------------- | ------------------------------------------ | | ||
| [icon](./extensions.actionextensionconfiguration.icon.md) | | [CustomIcon](./extensions.customicon.md) | Icon associated with the action. | | ||
| [id](./extensions.actionextensionconfiguration.id.md) | | string | A unique identifier for the action. | | ||
| [label](./extensions.actionextensionconfiguration.label.md) | | string | Label associated with the action. | | ||
| [useAction](./extensions.actionextensionconfiguration.useaction.md) | | [ActionHook](./extensions.actionhook.md) | Hook that contains behavior of the action. | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@tridion-sites/extensions](./extensions.md) > [ActionExtensionConfiguration](./extensions.actionextensionconfiguration.md) > [useAction](./extensions.actionextensionconfiguration.useaction.md) | ||
|
||
## ActionExtensionConfiguration.useAction property | ||
|
||
Hook that contains behavior of the action. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
readonly useAction: ActionHook; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@tridion-sites/extensions](./extensions.md) > [ActionGroup](./extensions.actiongroup.md) > [actionIds](./extensions.actiongroup.actionids.md) | ||
|
||
## ActionGroup.actionIds property | ||
|
||
An ordered array of action IDs that are included in the group. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
readonly actionIds: readonly string[]; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@tridion-sites/extensions](./extensions.md) > [ActionGroup](./extensions.actiongroup.md) > [id](./extensions.actiongroup.id.md) | ||
|
||
## ActionGroup.id property | ||
|
||
A unique identifier for the action group. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
readonly id: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@tridion-sites/extensions](./extensions.md) > [ActionGroup](./extensions.actiongroup.md) > [label](./extensions.actiongroup.label.md) | ||
|
||
## ActionGroup.label property | ||
|
||
Label associated with the action group. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
readonly label: string; | ||
``` | ||
|
||
## Remarks | ||
|
||
It can be used to provide insight into why specific actions are grouped together. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@tridion-sites/extensions](./extensions.md) > [ActionGroup](./extensions.actiongroup.md) | ||
|
||
## ActionGroup interface | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export interface ActionGroup | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Modifiers | Type | Description | | ||
| -------------------------------------------------- | --------- | ------------------- | -------------------------------------------------------------- | | ||
| [actionIds](./extensions.actiongroup.actionids.md) | | readonly string\[\] | An ordered array of action IDs that are included in the group. | | ||
| [id](./extensions.actiongroup.id.md) | | string | A unique identifier for the action group. | | ||
| [label](./extensions.actiongroup.label.md) | | string | Label associated with the action group. | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@tridion-sites/extensions](./extensions.md) > [ActionHook](./extensions.actionhook.md) | ||
|
||
## ActionHook type | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export type ActionHook = () => ActionHookResult; | ||
``` | ||
|
||
**References:** [ActionHookResult](./extensions.actionhookresult.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@tridion-sites/extensions](./extensions.md) > [ActionHookResult](./extensions.actionhookresult.md) > [execute](./extensions.actionhookresult.execute.md) | ||
|
||
## ActionHookResult.execute property | ||
|
||
A callback function that is executed when the action is triggered. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
readonly execute: () => void; | ||
``` |
Oops, something went wrong.