mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-4152] Restructured remaining doc folders and fixed links (#4441)
* [ADF-4152] Moved proc services cloud docs to subfolders * [ADF-4152] Fixed links in PS cloud docs * [ADF-4152] Added subfolders and checked links for extensions and insights docs * [ADF-4152] Moved proc services cloud docs to subfolders * [ADF-4152] Fixed links in PS cloud docs * [ADF-4152] Added subfolders and checked links for extensions and insights docs * [ADF-4152] Fixed links in Proc cloud, Insights and Extensions docs * [ADF-4152] Updated links in user guide * [ADF-4152] Fixed broken links in tutorials * [ADF-4152] Fixed remaining links in core docs * [ADF-4152] Fixed remaining links in proc services docs * [ADF-4152] Fixed remaining links in content services docs * [ADF-4152] Fixed links in breaking changes docs * [ADF-4152] Updated main README index page * [ADF-4152] Fixed glitches with preview ext component docs
This commit is contained in:
Andy Stark
committed by
Eugenio Romano
Eugenio Romano
parent
8edf92f325
commit
31479cfaa4
74
docs/extensions/services/extension.service.md
Normal file
74
docs/extensions/services/extension.service.md
Normal file
@@ -0,0 +1,74 @@
|
||||
---
|
||||
Title: Extension Service
|
||||
Added: v3.0.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2018-12-17
|
||||
---
|
||||
|
||||
# [Extension Service](../../../lib/extensions/src/lib/services/extension.service.ts "Defined in extension.service.ts")
|
||||
|
||||
Manages and runs basic extension functionality.
|
||||
|
||||
## Class members
|
||||
|
||||
### Methods
|
||||
|
||||
- **evaluateRule**(ruleId: `string`, context: [`RuleContext`](../../../lib/extensions/src/lib/config/rule.extensions.ts)): `boolean`<br/>
|
||||
Evaluates a rule.
|
||||
- _ruleId:_ `string` - ID of the rule to evaluate
|
||||
- _context:_ [`RuleContext`](../../../lib/extensions/src/lib/config/rule.extensions.ts) - Parameter object for the evaluator with details of app state
|
||||
- **Returns** `boolean` - True if the rule passed, false otherwise
|
||||
- **getActionById**(id: `string`): [`ActionRef`](../../../lib/extensions/src/lib/config/action.extensions.ts)<br/>
|
||||
Retrieves an action using its ID value.
|
||||
- _id:_ `string` - The ID value to look for
|
||||
- **Returns** [`ActionRef`](../../../lib/extensions/src/lib/config/action.extensions.ts) - Action or null if not found
|
||||
- **getAuthGuards**(ids: `string[]`): `Array<Type<__type>>`<br/>
|
||||
Retrieves one or more auth guards using an array of ID values.
|
||||
- _ids:_ `string[]` - Array of ID value to look for
|
||||
- **Returns** `Array<Type<__type>>` - Array of auth guards or empty array if none were found
|
||||
- **getComponentById**(id: `string`): `Type<>`<br/>
|
||||
Retrieves a registered [extension component](../../../lib/extensions/src/lib/services/component-register.service.ts) using its ID value.
|
||||
- _id:_ `string` - The ID value to look for
|
||||
- **Returns** `Type<>` - The component or null if not found
|
||||
- **getEvaluator**(key: `string`): `RuleEvaluator`<br/>
|
||||
Retrieves a RuleEvaluator function using its key name.
|
||||
- _key:_ `string` - Key name to look for
|
||||
- **Returns** `RuleEvaluator` - RuleEvaluator or null if not found
|
||||
- **getFeature**(key: `string`): `any[]`<br/>
|
||||
|
||||
- _key:_ `string` -
|
||||
- **Returns** `any[]` -
|
||||
|
||||
- **getRouteById**(id: `string`): [`RouteRef`](../../../lib/extensions/src/lib/config/routing.extensions.ts)<br/>
|
||||
Retrieves a route using its ID value.
|
||||
- _id:_ `string` - The ID value to look for
|
||||
- **Returns** [`RouteRef`](../../../lib/extensions/src/lib/config/routing.extensions.ts) - The route or null if not found
|
||||
- **getRuleById**(id: `string`): [`RuleRef`](../../../lib/extensions/src/lib/config/rule.extensions.ts)<br/>
|
||||
Retrieves a rule using its ID value.
|
||||
- _id:_ `string` - The ID value to look for
|
||||
- **Returns** [`RuleRef`](../../../lib/extensions/src/lib/config/rule.extensions.ts) - The rule or null if not found
|
||||
- **load**(): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`ExtensionConfig`](../../../lib/extensions/src/lib/config/extension.config.ts)`>`<br/>
|
||||
Loads and registers an extension config file and plugins (specified by path properties).
|
||||
- **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`ExtensionConfig`](../../../lib/extensions/src/lib/config/extension.config.ts)`>` - The loaded config data
|
||||
- **runExpression**(value: `string`, context?: `any`): `any`<br/>
|
||||
Runs a lightweight expression stored in a string.
|
||||
- _value:_ `string` - String containing the expression or literal value
|
||||
- _context:_ `any` - (Optional) Parameter object for the expression with details of app state
|
||||
- **Returns** `any` - Result of evaluated expression, if found, or the literal value otherwise
|
||||
- **setAuthGuards**(values: `Function`)<br/>
|
||||
Adds one or more new auth guards to the existing set.
|
||||
- _values:_ `Function` - The new auth guards to add
|
||||
- **setComponents**(values: `Function`)<br/>
|
||||
Adds one or more new components to the existing set.
|
||||
- _values:_ `Function` - The new components to add
|
||||
- **setEvaluators**(values: `Function`)<br/>
|
||||
Adds one or more new rule evaluators to the existing set.
|
||||
- _values:_ `Function` - The new evaluators to add
|
||||
- **setup**(config: [`ExtensionConfig`](../../../lib/extensions/src/lib/config/extension.config.ts))<br/>
|
||||
Registers extensions from a config object.
|
||||
- _config:_ [`ExtensionConfig`](../../../lib/extensions/src/lib/config/extension.config.ts) - Object with config data
|
||||
|
||||
## Details
|
||||
|
||||
Use the methods of this service to add extensibility features to your app. You can find further
|
||||
details in the [App extensions](../../user-guide/app-extensions.md) page.
|
||||
Reference in New Issue
Block a user