inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
alfresco-ng2-components/docs/content-node-dialog.service.md

2.9 KiB
Raw Blame History

Content Node Dialog service

Displays and manages dialogs for selecting content to open, copy or upload.

Methods

openFileBrowseDialogByFolderId(folderNodeId: string): Observable<MinimalNodeEntryEntity[]>
Opens a file browser at a chosen folder location.

openFolderBrowseDialogByFolderId(folderNodeId: string): Observable<MinimalNodeEntryEntity[]>
Opens a folder browser at a chosen folder location.

openFileBrowseDialogBySite(): Observable<MinimalNodeEntryEntity[]>
Opens a file browser at a chosen site location.

openFolderBrowseDialogBySite(): Observable<MinimalNodeEntryEntity[]>
Opens a folder browser at a chosen site location.

openCopyMoveDialog(action: string, contentEntry: MinimalNodeEntryEntity, permission?: string): Observable<MinimalNodeEntryEntity[]>
Opens a dialog to copy or move an item to a new location.

openUploadFileDialog(action: string, contentEntry: MinimalNodeEntryEntity): Observable<MinimalNodeEntryEntity[]>
Opens a dialog to choose a file to upload.

openUploadFolderDialog(action: string, contentEntry: MinimalNodeEntryEntity): Observable<MinimalNodeEntryEntity[]>
Opens a dialog to choose a folder to upload.

close()
Closes the currently open dialog.

Details

The openXXX methods return an Observable that you can subscribe to in order to get the information from the result:

import { ContentNodeDialogService } from '@adf/content-services'


constructor(private contentDialogService: ContentNodeDialogService){}

yourFunctionOnCopyOrMove(){
        this.contentDialogService
            .openCopyMoveDialog(actionName, targetNode, neededPermissionForAction)
            .subscribe((selections: MinimalNodeEntryEntity[]) => {
                // place your action here on operation success!
            });
}

The openXXXByFolderId methods let you set the initial folder location of the browser using a folder ID string. This can be obtained from the id property of a MinimalNodeEntryEntity object (returned from a previous dialog operation, say) or be set to one of the well-known names "-my-" , "-shared-" or "-root-".

The openCopyMoveDialog and openUploadXXX methods require the following parameters:

Name Type Description
action string The label for the confirm button of the dialog.
contentEntry MinimalNodeEntryEntity The node we want to be copied/moved or uploaded.
neededPermissionForAction string (openCopyMoveDialog only) Permission required to perform the relative action (eg: copy will need the 'update' permission ).

See Also