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

[ADF-2905] Added JSDocs for core (#3281)

Browse Source 
* [ADF-2905] Updated JSDocs for core

* [ADF-2905] Added missing JSDoc for user pref service
This commit is contained in:
Andy Stark
2018-05-08 15:30:23 +01:00
committed by Eugenio Romano
parent d456b3cba1
commit dd1b8893cc
10 changed files with 102 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
lib/core/services/shared-links-api.service.ts
View File

@@ -36,6 +36,7 @@ export class SharedLinksApiService {
/**
* Gets shared links available to the current user.
* @param options Options supported by JSAPI
* @returns List of shared links
*/
getSharedLinks(options: any = {}): Observable<NodePaging> {
const { sharedLinksApi, handleError } = this;
@@ -54,9 +55,10 @@ export class SharedLinksApiService {
}
/**
* Create a shared links available to the current user.
* @param nodeId
* Creates a shared link available to the current user.
* @param nodeId ID of the node to link to
* @param options Options supported by JSAPI
* @returns The shared link just created
*/
createSharedLinks(nodeId: string, options: any = {}): Observable<SharedLinkEntry> {
const { sharedLinksApi, handleError } = this;
@@ -69,8 +71,9 @@ export class SharedLinksApiService {
}
/**
* delete shared links
* @param sharedId to delete
* Deletes a shared link.
* @param sharedId ID of the link to delete
* @returns Null response notifying when the operation is complete
*/
deleteSharedLink(sharedId: string): Observable<SharedLinkEntry> {
const { sharedLinksApi, handleError } = this;