mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
1fa81962a0
* fix after rebase * new release strategy for ng next Signed-off-by: eromano <eugenioromano16@gmail.com> * peer dep Signed-off-by: eromano <eugenioromano16@gmail.com> * Angular 14 fix unit test and storybook Signed-off-by: eromano <eugenioromano16@gmail.com> fix after rebase Signed-off-by: eromano <eugenioromano16@gmail.com> update pkg.json Signed-off-by: eromano <eugenioromano16@gmail.com> missing dep Signed-off-by: eromano <eugenioromano16@gmail.com> Fix mistake and missing code Dream....build only affected libs Add utility run commands * Use nx command to run affected tests * Fix nx test core fix content tests Run unit with watch false core test fixes reduce test warnings Fix process cloud unit Fix adf unit test Fix lint process cloud Disable lint next line Use right core path Fix insights unit fix linting insights Fix process-services unit fix the extensions test report fix test warnings Fix content unit Fix bunch of content unit * Produce an adf alpha of 14 * hopefully fixing the content * Push back the npm publish * Remove flaky unit * Fix linting * Make the branch as root * Get rid of angualar13 * Remove the travis depth * Fixing version for npm * Enabling cache for unit and build * Fix scss for core and paths Copy i18 and asset by using ng-packager Export the theming alias and fix path Use ng-package to copy assets process-services-cloud Use ng-package to copy assets process-services Use ng-package to copy assets content-services Use ng-package to copy assets insights * feat: fix api secondary entry point * fix storybook rebase * Move dist under dist/libs from lib/dist * Fix the webstyle * Use only necessary nrwl deps and improve lint * Fix unit for libs * Convert lint.sh to targets - improve performance * Use latest of angular * Align alfresco-js-api Signed-off-by: eromano <eugenioromano16@gmail.com> Co-authored-by: eromano <eugenioromano16@gmail.com> Co-authored-by: Mikolaj Serwicki <mikolaj.serwicki@hyland.com> Co-authored-by: Tomasz <tomasz.gnyp@hyland.com>
64 lines
3.4 KiB
Markdown
64 lines
3.4 KiB
Markdown
---
|
|
Title: Alfresco Api Service
|
|
Added: v2.0.0
|
|
Status: Active
|
|
Last reviewed: 2019-01-17
|
|
---
|
|
|
|
# [Alfresco Api Service](lib/core/src/lib/services/alfresco-api.service.ts "Defined in alfresco-api.service.ts")
|
|
|
|
Provides access to an initialized **AlfrescoJSApi** instance.
|
|
|
|
## Basic Usage
|
|
|
|
```ts
|
|
export class MyComponent implements OnInit {
|
|
|
|
constructor(private apiService: AlfrescoApiService) {
|
|
}
|
|
|
|
ngOnInit() {
|
|
let nodeId = 'some-node-id';
|
|
let params = {};
|
|
this.apiService.getInstance().nodes
|
|
.getNodeChildren(nodeId, params)
|
|
.then(result => console.log(result));
|
|
}
|
|
}
|
|
```
|
|
|
|
### Properties
|
|
|
|
| Name | Type | Default value | Description |
|
|
| ---- | ---- | ------------- | ----------- |
|
|
| contentApi | [`ContentApi`](https://github.com/Alfresco/alfres/co-js-api/blob/develop/src/api/content-rest-api/api/content.api.ts) | | (Read only) Accesses the Content API |
|
|
| nodesApi | [`NodesApi`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/api/nodes.api.ts) | | (Read only) Accesses the Nodes API |
|
|
| renditionsApi | [`RenditionsApi`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/api/renditions.api.ts) | | (Read only) Accesses the Renditions API |
|
|
| sharedLinksApi | [`SharedLinksApi`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/api/sharedlinks.api.ts) | | (Read only) Accesses the Shared Links API |
|
|
| sitesApi | [`SitesApi`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/api/sites.api.ts) | | (Read only) Accesses the Sites API |
|
|
| favoritesApi | [`FavoritesApi`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/api/favorites.api.ts) | | (Read only) Accesses the Favorites API |
|
|
| peopleApi | [`PeopleApi`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/api/people.api.ts) | | (Read only) Accesses the People API |
|
|
| searchApi | [`SearchApi`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api-legacy/legacy.ts) | | (Read only) Accesses the Search API |
|
|
| versionsApi | [`VersionsApi`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/api/versions.api.ts) | | (Read only) Accesses the Versions API |
|
|
| classesApi | [`ClassesApi`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/api/classes.api.ts) | | (Read only) Accesses the Classes API |
|
|
| groupsApi | [`GroupsApi`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/api/groups.api.ts) | | (Read only) Accesses the Groups API |
|
|
|
|
### Events
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| nodeUpdated | [`Subject`](http://reactivex.io/documentation/subject.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when a node updates. |
|
|
|
|
## Details
|
|
|
|
**Note for developers**: The TypeScript declaration files for the Alfresco JS API
|
|
are still under development and some Alfresco APIs may not be accessible
|
|
via your IDE's intellisense or TypeScript compiler.
|
|
To avoid these TypeScript type check errors, you can call any supported
|
|
Alfresco JS api by casting the instance to the `any` type as in the following example:
|
|
|
|
```ts
|
|
let api: any = this.apiService.getInstance();
|
|
api.nodes.addNode('-root-', body, {});
|
|
```
|