inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-31 17:38:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF- 2670] Checked and updated docs for 2.3 (#3197)

Browse Source 
* [ADF-2670] Reviewed docs for 2.3 with only minor changes

* [ADF-2670] Checked and updated docs for 2.3
This commit is contained in:
Andy Stark
2018-04-16 15:51:29 +01:00
committed by Eugenio Romano
parent e4b9d775a2
commit 460e33ccdb
21 changed files with 226 additions and 137 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/core/alfresco-api.service.md
View File

@@ -1,10 +1,12 @@
---
Added: v2.0.0
Status: Active
Last reviewed: 2018-04-13
---
# Alfresco Api Service
Provides access to initialized **AlfrescoJSApi** instance.
Provides access to an initialized **AlfrescoJSApi** instance.
## Basic Usage
@@ -24,19 +26,37 @@ export class MyComponent implements OnInit {
}
```
## Events
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| contentApi | `ContentApi` | | (Read only) Accesses the Content API |
| nodesApi | `NodesApi` | | (Read only) Accesses the Nodes API |
| renditionsApi | `RenditionsApi` | | (Read only) Accesses the Renditions API |
| sharedLinksApi | `SharedLinksApi` | | (Read only) Accesses the Shared Links API |
| sitesApi | `SitesApi` | | (Read only) Accesses the Sites API |
| favoritesApi | `FavoritesApi` | | (Read only) Accesses the Favorites API |
| peopleApi | `PeopleApi` | | (Read only) Accesses the People API |
| searchApi | `SearchApi` | | (Read only) Accesses the Search API |
| versionsApi | `VersionsApi` | | (Read only) Accesses the Versions API |
| classesApi | `ClassesApi` | | (Read only) Accesses the Classes API |
| groupsApi | `GroupsApi` | | (Read only) Accesses the Groups API |
### Events
| Name | Type | Description |
| --- | --- | --- |
| nodeUpdated | `Subject<MinimalNodeEntryEntity>` | Publish/subscribe to events related to node updates. |
| nodeUpdated | `Subject<MinimalNodeEntryEntity>` | Emitted when a node updates. |
## Details
**Note for developers**: _the TypeScript declaration files for Alfresco JS API
are still under development and some Alfresco APIs may not be accessed
via your favourite IDE's intellisense or TypeScript compiler.
In case of any TypeScript type check errors you can still call any supported
Alfresco JS api by casting the instance to `any` type like the following:_
**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();