inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-09-17 14:21:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added documentation. Fixed PR review comments

Browse Source
This commit is contained in:
swapnil.verma
2025-04-04 15:38:28 +05:30
parent 559cb504c1
commit e31f5886fc
5 changed files with 177 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
lib/js-api/src/api/content-rest-api/api/settings.api.ts
View File

@@ -22,8 +22,7 @@ export class SettingsApi extends BaseApi {
/**
* Gets the published extension configuration from
* the database
* @param instanceId Unique ID for a running instance of ADW
* for which configuration is to be fetched
* @param instanceId Unique ID for which configuration is to be fetched
*/
getSavedExtensionState(instanceId: string): Promise<any> {
throwIfNotDefined(instanceId, 'instanceId');
@@ -39,12 +38,9 @@ export class SettingsApi extends BaseApi {
}
/**
* Publish the extension configuration for an ADW instance
* in the database
* @param instanceId Unique ID for a running instance of ADW
* for which configuration is to be published
* @param extensionConfig Extension configuration that is to
* be saved
* Publish the extension configuration in the database
* @param instanceId Unique ID for which configuration is to be published
* @param extensionConfig Extension configuration that is to be saved
*/
publishExtensionConfig(instanceId: string, extensionConfig: any): Promise<void> {
throwIfNotDefined(instanceId, 'instanceId');

55
lib/js-api/src/api/content-rest-api/docs/SettingsApi.md Normal file
View File

@@ -0,0 +1,55 @@
# SettingsApi
All URIs are relative to *https://localhost/alfresco/api/-default-/public/alfresco/versions/1/*
| Method | HTTP request | Description |
|--------------------------------------------------------|--------------------------------|-------------------------------------------------------|
| [getSavedExtensionState](#getSavedExtensionState) | **GET** /settings/{instanceId} | Gets the extension configuration saved on the backend |
| [publishExtensionConfig](#publishExtensionComposition) | **PUT** /settings/{instanceId} | Saves an extension configuration on the backend |
## getSavedExtensionState
Gets the extension configuration saved on the backend
> this endpoint is available in <GET VERSION INFO HERE>**Alfresco 7.0.0** and newer versions.
**Parameters**
| Name | Type | Description | Notes |
|----------------|--------|----------------|-------|
| **instanceId** | string | The identifier | |
**Return type**: [ExtensionCompositionEntry](#ExtensionCompositionEntry)
## publishExtensionComposition
Saves an extension configuration on the backend
**Parameters**
| Name | Type | Description |
|---------------------|-----------------------------------------------|-----------------------------------------|
| **instanceId** | string | The identifier |
| **extensionConfig** | [ExtensionComposition](#ExtensionComposition) | The extension configuration to be saved |
**Example**
```javascript
import {AlfrescoApi, SitesApi} from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*..*/);
const settingsApi = new SettingsApi(alfrescoApi);
const extensionConfig = new ExtensionComposition();
extensionConfig = {
appConfig: {},
features: {},
actions: [],
rules: [],
routes: []
}
settingsApi.publishExtensionConfig(`<instanceId>`, extensionConfig).then(() => {
console.log('API called successfully.');
});
```