alfresco-ng2-components/docs/core/services/alfresco-api.service.md

Title, Added, Status, Last reviewed

Title	Added	Status	Last reviewed
Alfresco Api Service	v2.0.0	Active	2019-01-17

Alfresco Api Service

Provides access to an initialized AlfrescoJSApi instance.

Basic Usage

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		(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<Node>	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:

let api: any = this.apiService.getInstance();
api.nodes.addNode('-root-', body, {});