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-3551] Updates for doc review (#3784)

Browse Source 
* [ADF-3551] Updated doc comments

* [ADF-3551] Updated doc comments

* [ADF-3551] Doc files updated with new doc comments
This commit is contained in:
Andy Stark
2018-09-13 12:59:57 +01:00
committed by Eugenio Romano
parent 29c8c7fae6
commit 3ba72f00f8
19 changed files with 55 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
lib/content-services/document-list/services/custom-resources.service.ts
View File

@@ -261,6 +261,11 @@ export class CustomResourcesService {
return isCustomSources;
}
/**
* Is the folder ID a "-my", "-root-", or "-shared-" alias?
* @param folderId Folder ID name to check
* @returns True if the ID is one of the suppored sources, false otherwise
*/
isSupportedSource(folderId: string): boolean {
let isSupportedSources = false;
const sources = ['-my-', '-root-', '-shared-'];
@@ -330,6 +335,11 @@ export class CustomResourcesService {
return of([]);
}
/**
* Does the well-known alias have a corresponding node ID?
* @param nodeId Node to check
* @returns True if the alias has a corresponding node ID, false otherwise
*/
hasCorrespondingNodeIds(nodeId: string): boolean {
return this.isCustomSource(nodeId) || this.isSupportedSource(nodeId);
}

6
lib/content-services/document-list/services/document-list.service.ts
View File

@@ -150,8 +150,7 @@ export class DocumentListService {
}
/**
* @deprecated 2.3.0
* Gets a folder node via its node ID.
* @deprecated 2.3.0. Gets a folder node via its node ID.
* @param nodeId ID of the folder node
* @param includeFields Extra information to include (available options are "aspectNames", "isLink" and "association")
* @returns Details of the folder
@@ -195,8 +194,7 @@ export class DocumentListService {
}
/**
* @Deprecated 2.3.0 use the one in the content service
* Checks if a node has the specified permission.
* @Deprecated 2.3.0 - use the equivalent in the content service. Checks if a node has the specified permission.
* @param node Target node
* @param permission Permission level to query
* @returns True if the node has the permission, false otherwise