UNPKG

@esri/solution-common

Version:

Provides general helper functions for @esri/solution.js.

35 lines (34 loc) 1.68 kB
/** @license * Copyright 2021 Esri * * 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 { UserSession } from "../arcgisRestJS"; import { IAssociatedFileCopyResults, IAssociatedFileInfo, ISourceFile, IZipInfo } from "../interfaces"; /** * Copies a resource into a zipfile. * * @param file Information about the source and destination of the file such as its URL, folder, filename * @param zipInfo Information about a zipfile such as its name and its zip object * @returns The result of the copy */ export declare function copyResourceIntoZip(file: ISourceFile, zipInfo: IZipInfo): IAssociatedFileCopyResults; /** * Copies a resource into a zipfile. * * @param fileInfo Information about the source and destination of the file such as its URL, folder, filename * @param sourceAuthentication Credentials for the request to the source * @param zipInfo Information about a zipfile such as its name and its zip object * @returns A promise which resolves to the result of the copy */ export declare function copyResourceIntoZipFromInfo(fileInfo: IAssociatedFileInfo, sourceAuthentication: UserSession, zipInfo: IZipInfo): Promise<IAssociatedFileCopyResults>;