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-2557] Updated docs with new props script (#3149)

Browse Source 
* [ADF-2557] Updated docs for services with new props script

* [ADF-2557] Updated service docs with new props script
This commit is contained in:
Andy Stark
2018-04-08 16:23:04 +01:00
committed by Eugenio Romano
parent 8769c257f8
commit 1d517d3a8a
27 changed files with 612 additions and 299 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -75,6 +75,7 @@ export class DocumentListService {
/**
* Deletes a node.
* @param nodeId ID of the node to delete
* @returns Empty response when the operation is complete
*/
deleteNode(nodeId: string): Observable<any> {
return Observable.fromPromise(this.apiService.getInstance().nodes.deleteNode(nodeId));
@@ -85,6 +86,7 @@ export class DocumentListService {
*
* @param nodeId The id of the node to be copied
* @param targetParentId The id of the folder where the node will be copied
* @returns NodeEntry for the copied node
*/
copyNode(nodeId: string, targetParentId: string) {
return Observable.fromPromise(this.apiService.getInstance().nodes.copyNode(nodeId, { targetParentId }))
@@ -96,6 +98,7 @@ export class DocumentListService {
*
* @param nodeId The id of the node to be moved
* @param targetParentId The id of the folder where the node will be moved
* @returns NodeEntry for the moved node
*/
moveNode(nodeId: string, targetParentId: string) {
return Observable.fromPromise(this.apiService.getInstance().nodes.moveNode(nodeId, { targetParentId }))
@@ -106,6 +109,7 @@ export class DocumentListService {
* Create a new folder in the path.
* @param name Folder name
* @param parentId Parent folder ID
* @returns Details of the created folder node
*/
createFolder(name: string, parentId: string): Observable<MinimalNodeEntity> {
return Observable.fromPromise(this.apiService.getInstance().nodes.createFolder(name, '/', parentId))
@@ -116,6 +120,8 @@ export class DocumentListService {
* Gets the folder node with the specified relative name path below the root node.
* @param folder Path to folder.
* @param opts Options.
* @param includeFields Extra information to include (available options are "aspectNames", "isLink" and "association")
* @returns Details of the folder
*/
getFolder(folder: string, opts?: any, includeFields: string[] = []): Observable<NodePaging> {
return Observable.fromPromise(this.getNodesPromise(folder, opts, includeFields))
@@ -126,6 +132,8 @@ export class DocumentListService {
/**
* 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
*/
getFolderNode(nodeId: string, includeFields: string[] = []): Promise<MinimalNodeEntryEntity> {
@@ -144,6 +152,7 @@ export class DocumentListService {
/**
* Get thumbnail URL for the given document node.
* @param node Node to get URL for.
* @returns Thumbnail URL string
*/
getDocumentThumbnailUrl(node: MinimalNodeEntity): string {
return this.thumbnailService.getDocumentThumbnailUrl(node);
@@ -152,6 +161,7 @@ export class DocumentListService {
/**
* Gets the icon that represents a MIME type.
* @param mimeType MIME type to get the icon for
* @returns Path to the icon file
*/
getMimeTypeIcon(mimeType: string): string {
return this.thumbnailService.getMimeTypeIcon(mimeType);
@@ -159,6 +169,7 @@ export class DocumentListService {
/**
* Gets a default icon for MIME types with no specific icon.
* @returns Path to the icon file
*/
getDefaultMimeTypeIcon(): string {
return this.thumbnailService.getDefaultMimeTypeIcon();
@@ -168,6 +179,7 @@ export class DocumentListService {
* 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
*/
hasPermission(node: any, permission: PermissionsEnum | string): boolean {
return this.contentService.hasPermission(node, permission);

3
lib/content-services/document-list/services/folder-actions.service.ts
View File

@@ -44,6 +44,7 @@ export class FolderActionsService {
/**
* Gets the handler function for an action.
* @param key Identifier for the action
* @returns The handler function
*/
getHandler(key: string): ContentActionHandler {
if (key) {
@@ -57,6 +58,7 @@ export class FolderActionsService {
* Sets a new handler function for an action.
* @param key Identifier for the action
* @param handler The new handler function
* @returns True if the key was a valid action identifier, false otherwise
*/
setHandler(key: string, handler: ContentActionHandler): boolean {
if (key) {
@@ -70,6 +72,7 @@ export class FolderActionsService {
/**
* Checks if an action is available for a particular item.
* @param obj Item to check
* @returns True if the action is available, false otherwise
*/
canExecuteAction(obj: any): boolean {
return this.documentListService && obj && obj.entry.isFolder === true;

8
lib/content-services/tag/services/tag.service.ts
View File

@@ -33,13 +33,17 @@ export class TagService {
/**
* Gets a list of tags added to a node.
* @param nodeId ID of the target node
* @returns TagPaging object (defined in JSAPI) containing the tags
*/
getTagsByNodeId(nodeId: string): any {
return Observable.fromPromise(this.apiService.getInstance().core.tagsApi.getNodeTags(nodeId))
.catch(err => this.handleError(err));
}
/** Gets a list of all the tags already defined in the repository. */
/**
* Gets a list of all the tags already defined in the repository.
* @returns TagPaging object (defined in JSAPI) containing the tags
*/
getAllTheTags() {
return Observable.fromPromise(this.apiService.getInstance().core.tagsApi.getTags())
.catch(err => this.handleError(err));
@@ -49,6 +53,7 @@ export class TagService {
* Adds a tag to a node.
* @param nodeId ID of the target node
* @param tagName Name of the tag to add
* @returns TagEntry object (defined in JSAPI) with details of the new tag
*/
addTag(nodeId: string, tagName: string): any {
let alfrescoApi: any = this.apiService.getInstance();
@@ -70,6 +75,7 @@ export class TagService {
* Removes a tag from a node.
* @param nodeId ID of the target node
* @param tag Name of the tag to remove
* @returns Null object when the operation completes
*/
removeTag(nodeId: string, tag: string): any {
let promiseRemove = Observable.fromPromise(this.apiService.getInstance().core.tagsApi.removeTag(nodeId, tag));

74
lib/core/form/services/process-content.service.ts
View File

@@ -38,18 +38,38 @@ export class ProcessContentService {
return this.apiService.getInstance().activiti.contentApi;
}
/**
* Create temporary related content from an uploaded file.
* @param file File to use for content
* @returns The created content data
*/
createTemporaryRawRelatedContent(file: any): Observable<RelatedContentRepresentation> {
return Observable.fromPromise(this.contentApi.createTemporaryRawRelatedContent(file)).catch(err => this.handleError(err));
}
/**
* Gets the metadata for a related content item.
* @param contentId ID of the content item
* @returns Metadata for the content
*/
getFileContent(contentId: number): Observable<RelatedContentRepresentation> {
return Observable.fromPromise(this.contentApi.getContent(contentId)).catch(err => this.handleError(err));
}
/**
* Gets raw binary content data for a related content file.
* @param contentId ID of the related content
* @returns Binary data of the related content
*/
getFileRawContent(contentId: number): Observable<Blob> {
return Observable.fromPromise(this.contentApi.getRawContent(contentId)).catch(err => this.handleError(err));
}
/**
* Gets the preview for a related content file.
* @param contentId ID of the related content
* @returns Binary data of the content preview
*/
getContentPreview(contentId: number): Observable<Blob> {
return new Observable(observer => {
this.contentApi.getContentPreview(contentId).then(
@@ -73,39 +93,83 @@ export class ProcessContentService {
});
}
/**
* Gets a URL for direct access to a related content file.
* @param contentId ID of the related content
* @returns URL to access the content
*/
getFileRawContentUrl(contentId: number): string {
return this.contentApi.getRawContentUrl(contentId);
}
/**
* Gets the thumbnail for a related content file.
* @param contentId ID of the related content
* @returns Binary data of the thumbnail image
*/
getContentThumbnail(contentId: number): Observable<Blob> {
return Observable.fromPromise(this.contentApi.getContentThumbnail(contentId)).catch(err => this.handleError(err));
}
/**
* Gets related content items for a task instance.
* @param taskId ID of the target task
* @returns Metadata for the content
*/
getTaskRelatedContent(taskId: string): Observable<any> {
return Observable.fromPromise(this.contentApi.getRelatedContentForTask(taskId))
.catch(err => this.handleError(err));
}
/**
* Gets related content items for a process instance.
* @param processId ID of the target process
* @returns Metadata for the content
*/
getProcessRelatedContent(processId: string): Observable<any> {
return Observable.fromPromise(this.contentApi.getRelatedContentForProcessInstance(processId))
.catch(err => this.handleError(err));
}
/**
* Deletes related content.
* @param contentId Identifier of the content to delete
* @returns Null response that notifies when the deletion is complete
*/
deleteRelatedContent(contentId: number): Observable<any> {
return Observable.fromPromise(this.contentApi.deleteContent(contentId))
.catch(err => this.handleError(err));
}
/**
* Associates an uploaded file with a process instance.
* @param processInstanceId ID of the target process instance
* @param content File to associate
* @param opts Options supported by JSAPI
* @returns Details of created content
*/
createProcessRelatedContent(processInstanceId: string, content: any, opts?: any): Observable<any> {
return Observable.fromPromise(this.contentApi.createRelatedContentOnProcessInstance(processInstanceId, content, opts))
.catch(err => this.handleError(err));
}
/**
* Associates an uploaded file with a task instance.
* @param taskId ID of the target task
* @param file File to associate
* @param opts Options supported by JSAPI
* @returns Details of created content
*/
createTaskRelatedContent(taskId: string, file: any, opts?: any) {
return Observable.fromPromise(this.contentApi.createRelatedContentOnTask(taskId, file, opts))
.catch(err => this.handleError(err));
}
/**
* Creates a JSON representation of data.
* @param res Object representing data
* @returns JSON object
*/
toJson(res: any) {
if (res) {
return res || {};
@@ -113,6 +177,11 @@ export class ProcessContentService {
return {};
}
/**
* Creates a JSON array representation of data.
* @param res Object representing data
* @returns JSON array object
*/
toJsonArray(res: any) {
if (res) {
return res.data || [];
@@ -120,6 +189,11 @@ export class ProcessContentService {
return [];
}
/**
* Reports an error message.
* @param error Data object with optional `message` and `status` fields for the error
* @returns Callback when an error occurs
*/
handleError(error: any): Observable<any> {
let errMsg = ProcessContentService.UNKNOWN_ERROR_MESSAGE;
if (error) {

14
lib/core/services/apps-process.service.ts
View File

@@ -30,6 +30,10 @@ export class AppsProcessService {
private logService: LogService) {
}
/**
* Gets a list of deployed apps for this user.
* @returns The list of deployed apps
*/
getDeployedApplications(): Observable<AppDefinitionRepresentation[]> {
return Observable.fromPromise(this.apiService.getInstance().activiti.appsApi.getAppDefinitions())
.map((response: any) => {
@@ -38,6 +42,11 @@ export class AppsProcessService {
.catch(err => this.handleError(err));
}
/**
* Gets a list of deployed apps for this user, where the app name is `name`.
* @param name Name of the app
* @returns The list of deployed apps
*/
getDeployedApplicationsByName(name: string): Observable<AppDefinitionRepresentation> {
return Observable.fromPromise(this.apiService.getInstance().activiti.appsApi.getAppDefinitions())
.map((response: any) => {
@@ -46,6 +55,11 @@ export class AppsProcessService {
.catch(err => this.handleError(err));
}
/**
* Gets the details for a specific app ID number.
* @param appId ID of the target app
* @returns Details of the app
*/
getApplicationDetailsById(appId: number): Observable<AppDefinitionRepresentation> {
return Observable.fromPromise(this.apiService.getInstance().activiti.appsApi.getAppDefinitions())
.map((response: any) => {

22
lib/core/services/comment-process.service.ts
View File

@@ -32,6 +32,12 @@ export class CommentProcessService {
private logService: LogService) {
}
/**
* Adds a comment to a task.
* @param taskId ID of the target task
* @param message Text for the comment
* @returns Details about the comment
*/
addTaskComment(taskId: string, message: string): Observable<CommentModel> {
return Observable.fromPromise(this.apiService.getInstance().activiti.taskApi.addTaskComment({message: message}, taskId))
.map(res => res)
@@ -46,6 +52,11 @@ export class CommentProcessService {
}
/**
* Gets all comments that have been added to a task.
* @param taskId ID of the target task
* @returns Details for each comment
*/
getTaskComments(taskId: string): Observable<CommentModel[]> {
return Observable.fromPromise(this.apiService.getInstance().activiti.taskApi.getTaskComments(taskId))
.map(res => res)
@@ -59,6 +70,11 @@ export class CommentProcessService {
}).catch(err => this.handleError(err));
}
/**
* Gets all comments that have been added to a process instance.
* @param processInstanceId ID of the target process instance
* @returns Details for each comment
*/
getProcessInstanceComments(processInstanceId: string): Observable<CommentModel[]> {
return Observable.fromPromise(this.apiService.getInstance().activiti.commentsApi.getProcessInstanceComments(processInstanceId))
.map(res => res)
@@ -72,6 +88,12 @@ export class CommentProcessService {
}).catch(err => this.handleError(err));
}
/**
* Adds a comment to a process instance.
* @param processInstanceId ID of the target process instance
* @param message Text for the comment
* @returns Details of the comment added
*/
addProcessInstanceComment(processInstanceId: string, message: string): Observable<CommentModel> {
return Observable.fromPromise(
this.apiService.getInstance().activiti.commentsApi.addProcessInstanceComment({message: message}, processInstanceId)

1
lib/core/services/deleted-nodes-api.service.ts
View File

@@ -36,6 +36,7 @@ export class DeletedNodesApiService {
/**
* Gets a list of nodes in the trash.
* @param options Options for JSAPI call
* @returns List of nodes in the trash
*/
getDeletedNodes(options?: Object): Observable<NodePaging> {
const { nodesApi, handleError } = this;

2
lib/core/services/discovery-api.service.ts
View File

@@ -30,6 +30,7 @@ export class DiscoveryApiService {
/**
* Gets product information for Content Services.
* @returns ProductVersionModel containing product details
*/
public getEcmProductInfo() {
return Observable.fromPromise(
@@ -40,6 +41,7 @@ export class DiscoveryApiService {
/**
* Gets product information for Process Services.
* @returns ProductVersionModel containing product details
*/
public getBpmProductInfo() {
return Observable.fromPromise(

8
lib/core/services/nodes-api.service.ts
View File

@@ -42,6 +42,7 @@ export class NodesApiService {
* Gets the stored information about a node.
* @param nodeId ID of the target node
* @param options Optional parameters supported by JSAPI
* @returns Node information
*/
getNode(nodeId: string, options: any = {}): Observable<MinimalNodeEntryEntity> {
const { nodesApi, handleError, getEntryFromEntity } = this;
@@ -62,6 +63,7 @@ export class NodesApiService {
* Gets the items contained in a folder node.
* @param nodeId ID of the target node
* @param options Optional parameters supported by JSAPI
* @returns List of child items from the folder
*/
getNodeChildren(nodeId: string, options: any = {}): Observable<NodePaging> {
const { nodesApi, handleError } = this;
@@ -84,6 +86,7 @@ export class NodesApiService {
* @param parentNodeId ID of the parent folder node
* @param nodeBody Data for the new node
* @param options Optional parameters supported by JSAPI
* @returns Details of the new node
*/
createNode(parentNodeId: string, nodeBody: any, options: any = {}): Observable<MinimalNodeEntryEntity> {
const { nodesApi, handleError, getEntryFromEntity } = this;
@@ -99,6 +102,7 @@ export class NodesApiService {
* @param parentNodeId ID of the parent folder node
* @param nodeBody Data for the new folder
* @param options Optional parameters supported by JSAPI
* @returns Details of the new folder
*/
createFolder(parentNodeId: string, nodeBody: any, options: any = {}): Observable<MinimalNodeEntryEntity> {
const body = Object.assign({ nodeType: 'cm:folder' }, nodeBody);
@@ -110,6 +114,7 @@ export class NodesApiService {
* @param nodeId ID of the target node
* @param nodeBody New data for the node
* @param options Optional parameters supported by JSAPI
* @returns Updated node information
*/
updateNode(nodeId: string, nodeBody: any, options: any = {}): Observable<MinimalNodeEntryEntity> {
const { nodesApi, handleError, getEntryFromEntity } = this;
@@ -124,6 +129,7 @@ export class NodesApiService {
* Moves a node to the trashcan.
* @param nodeId ID of the target node
* @param options Optional parameters supported by JSAPI
* @returns Empty result that notifies when the deletion is complete
*/
deleteNode(nodeId: string, options: any = {}): Observable<void> {
const { nodesApi, handleError } = this;
@@ -138,6 +144,7 @@ export class NodesApiService {
/**
* Restores a node previously moved to the trashcan.
* @param nodeId ID of the node to restore
* @returns Details of the restored node
*/
restoreNode(nodeId: string): Observable<MinimalNodeEntryEntity> {
const { nodesApi, handleError, getEntryFromEntity } = this;
@@ -153,6 +160,7 @@ export class NodesApiService {
/**
* Reports an error.
* @param error Object representing the error
* @returns Error information
*/
handleError(error: any): Observable<any> {
return Observable.throw(error);

6
lib/core/services/people-content.service.ts
View File

@@ -32,6 +32,7 @@ export class PeopleContentService {
/**
* Gets information about a user identified by their username.
* @param personId ID of the target user
* @returns User information
*/
getPerson(personId: string): Observable<any> {
const { peopleApi, handleError } = this;
@@ -42,7 +43,10 @@ export class PeopleContentService {
.catch(handleError);
}
/** Gets information about the user who is currently logged-in. */
/**
* Gets information about the user who is currently logged in.
* @returns User information
*/
getCurrentPerson(): Observable<any> {
return this.getPerson('-me-');
}

4
lib/core/services/people-process.service.ts
View File

@@ -35,6 +35,7 @@ export class PeopleProcessService {
* Gets information about users across all tasks.
* @param taskId ID of the task
* @param searchWord Filter text to search for
* @returns Array of user information objects
*/
getWorkflowUsers(taskId?: string, searchWord?: string): Observable<UserProcessModel[]> {
let option = { excludeTaskId: taskId, filter: searchWord };
@@ -46,6 +47,7 @@ export class PeopleProcessService {
/**
* Gets the profile picture URL for the specified user.
* @param user The target user
* @returns Profile picture URL
*/
getUserImage(user: UserProcessModel): string {
return this.getUserProfileImageApi(user.id);
@@ -55,6 +57,7 @@ export class PeopleProcessService {
* Sets a user to be involved with a task.
* @param taskId ID of the target task
* @param idToInvolve ID of the user to involve
* @returns Empty response when the update completes
*/
involveUserWithTask(taskId: string, idToInvolve: string): Observable<UserProcessModel[]> {
let node = {userId: idToInvolve};
@@ -66,6 +69,7 @@ export class PeopleProcessService {
* Removes a user who is currently involved with a task.
* @param taskId ID of the target task
* @param idToRemove ID of the user to remove
* @returns Empty response when the update completes
*/
removeInvolvedUser(taskId: string, idToRemove: string): Observable<UserProcessModel[]> {
let node = {userId: idToRemove};

12
lib/core/services/upload.service.ts
View File

@@ -60,14 +60,15 @@ export class UploadService {
/**
* Checks whether the service is uploading a file.
* @memberof UploadService
* @returns True if a file is uploading, false otherwise
*/
isUploading(): boolean {
return this.activeTask ? true : false;
}
/**
* Returns the file Queue
* Gets the file Queue
* @returns Array of files that form the queue
*/
getQueue(): FileModel[] {
return this.queue;
@@ -76,6 +77,7 @@ export class UploadService {
/**
* Adds files to the uploading queue to be uploaded
* @param files One or more separate parameters or an array of files to queue
* @returns Array of files that were not blocked from upload by the ignore list
*/
addToQueue(...files: FileModel[]): FileModel[] {
const allowedFiles = files.filter(f => this.filterElement(f));
@@ -95,10 +97,7 @@ export class UploadService {
/**
* Finds all the files in the queue that are not yet uploaded and uploads them into the directory folder.
*
* @param emitter (Deprecated) Emitter to invoke on file status change
*
* @memberof UploadService
*/
uploadFilesInTheQueue(emitter: EventEmitter<any>): void {
if (!this.activeTask) {
@@ -127,7 +126,7 @@ export class UploadService {
/**
* Cancels uploading of files.
* @param files One or more separate parameters or an array of files
* @param files One or more separate parameters or an array of files specifying uploads to cancel
*/
cancelUpload(...files: FileModel[]) {
files.forEach(file => {
@@ -154,6 +153,7 @@ export class UploadService {
/**
* Gets an upload promise for a file.
* @param file The target file
* @returns Promise that is resolved if the upload is successful or error otherwise
*/
getUploadPromise(file: FileModel) {
let opts: any = {

3
lib/core/userinfo/services/ecm-user.service.ts
View File

@@ -35,6 +35,7 @@ export class EcmUserService {
/**
* Gets information about a user identified by their username.
* @param userName Target username
* @returns User information
*/
getUserInfo(userName: string): Observable<EcmUserModel> {
return Observable.fromPromise(this.apiService.getInstance().core.peopleApi.getPerson(userName))
@@ -44,6 +45,7 @@ export class EcmUserService {
/**
* Gets information about the user who is currently logged-in.
* @returns User information as for getUserInfo
*/
getCurrentUserInfo() {
return this.getUserInfo('-me-');
@@ -52,6 +54,7 @@ export class EcmUserService {
/**
* Returns a profile image as a URL.
* @param avatarId Target avatar
* @returns Image URL
*/
getUserProfileImage(avatarId: string) {
if (avatarId) {