@alfresco/adf-content-services
Version:
Alfresco ADF content services
103 lines (102 loc) • 4.33 kB
TypeScript
/*!
* @license
* Copyright © 2005-2025 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { PaginationModel } from '@alfresco/adf-core';
import { Node, NodeEntry, NodePaging, NodesApi } from '@alfresco/js-api';
import { DocumentLoaderNode } from '../models/document-folder.model';
import { Observable } from 'rxjs';
import { DocumentListLoader } from '../interfaces/document-list-loader.interface';
import * as i0 from "@angular/core";
export declare class DocumentListService implements DocumentListLoader {
private nodesApiService;
private apiService;
private customResourcesService;
private _nodesApi;
get nodes(): NodesApi;
private _reload;
private _resetSelection;
/** Gets an observable that emits when the document list should be reloaded. */
reload$: Observable<void>;
/** Gets an observable that emits when the selection should be reset. */
resetSelection$: Observable<void>;
/** Reloads the document list. */
reload(): void;
/** Resets the selection. */
resetSelection(): void;
/**
* Deletes a node.
*
* @param nodeId ID of the node to delete
* @returns Empty response when the operation is complete
*/
deleteNode(nodeId: string): Observable<any>;
/**
* Copy a node to destination node
*
* @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): Observable<NodeEntry>;
/**
* Moves a node to destination node.
*
* @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): Observable<NodeEntry>;
/**
* 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>;
/**
* Gets a node via its node ID.
*
* @param nodeId ID of the target node
* @param includeFields Extra information to include (available options are "aspectNames", "isLink" and "association")
* @returns Details of the folder
*/
getNode(nodeId: string, includeFields?: string[]): Observable<Node>;
/**
* 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[]): Observable<NodeEntry>;
isCustomSourceService(nodeId: string): boolean;
/**
* Load a folder by Node Id.
*
* @param nodeId ID of the folder node
* @param pagination pagination model
* @param includeFields List of data field names to include in the results
* @param where Optionally filter the list
* @param orderBy order by node property
* @returns Details of the folder
*/
loadFolderByNodeId(nodeId: string, pagination: PaginationModel, includeFields: string[], where?: string, orderBy?: string[]): Observable<DocumentLoaderNode>;
private retrieveDocumentNode;
static ɵfac: i0.ɵɵFactoryDeclaration<DocumentListService, never>;
static ɵprov: i0.ɵɵInjectableDeclaration<DocumentListService>;
}