import type { CropMode } from './CropMode';
/**
 * Interface for constructing a request to get thumbnail for given sharepoint resource
 * @internal
 */
export interface IThumbnailRequest {
    /**
     * Absolute Url of the current sharepoint page.
     */
    absoluteUrl?: string;
    /**
     * Relative url of Sharepoint resource for which thumbnail is requested
     * e.g. /sites/WEXDemo/SiteAssets/autumn2.jpg
     * Alternatively you are provide siteId, webId, listId and uniqueId of the resource
     */
    spResource?: string;
    /**
     * SiteId of the resource, required if spResource is not provided
     */
    siteId?: string;
    /**
     * WebId of the resource, required if spResource is not provided
     */
    webId?: string;
    /**
     * ListId of the resource, required if spResource is not provided
     */
    listId?: string;
    /**
     * UniqueId of the resource, required if spResource is not provided
     */
    uniqueId?: string;
    /**
     * When passed this all other params related to resource will be skipped except fileType if available.
     * Use this when you already have a URL which could be anything from getPreview to VROOM CDN or full path
     * to external. ThumbnailRequest will rewrite if possible or update width only or return same URL upon failure
     * to do anything.
     */
    unknownThumbnailUrl?: string;
    /**
     * File extension of the resource e.g. jpg, pdf, doc, xls etc..
     */
    fileType?: string;
    /**
     * Width of the thumbnail requested.
     * Note when height is unspecified, width is mapped to nearest resolution breakpoint.
     * When width is unspecified, the viewport width will be used.
     */
    width?: number;
    /**
     * Height of the thumbnail requested
     * By default thumbnail height would be based on width, maintaining aspect ratio for image
     * For document type it is recommended to provide desired height.
     * when height specified, width is not adjusted to the nearest resolution breakpoint
     */
    height?: number;
    /**
     * default thumbnail for the aspx page
     */
    thumbnail?: string;
    /**
     * Original Width of the image used to generate the thumbnail
     * This is required when viewport parameters are provided
     */
    originalWidth?: number;
    /**
     * Original Height of the image used to generate the thumbnail
     * This is required when viewport parameters are provided
     */
    originalHeight?: number;
    /**
     * Horizontal offset of top left corner of cropping view port
     * Specified in pixel, relative to the top left of the original image
     */
    viewportLeft?: number;
    /**
     * Vertical offset of top left corner of cropping view port
     * Specified in pixels, relative to the top left of the original image
     */
    viewportTop?: number;
    /**
     * Width of cropping view port
     * Specified in pixels
     */
    viewportWidth?: number;
    /**
     * Height of cropping view port
     * Specified in pixels
     */
    viewportHeight?: number;
    /***
     * Identification of the caller. This will be used for telemetry purpose only.
     */
    callerId: string;
    /***
     * Specify a CropMode to be used with the MeTA image generation.
     * Optional parameter meant for specific scenarios to crop image into aspect ratio
     * different then original image aspect ratio.
     */
    cropMode?: CropMode;
    /**
     * If true, generated URL will be fit for storage without expiration.
     */
    nonExpiring?: boolean;
    /**
     * Generate optimized thumbnail url for external images.
     */
    optimizePublicImage?: boolean;
    /**
     * guid generated for image to use as param to avoid caching from api for advanced edited images
     */
    cacheBuster?: string;
    /**
     * Base83 Encoded Image data for Low Quality Image Placeholder (LQIP) generation.
     * 20-30 characters sized string is expected.
     * This is decoded to generate a low quality image placeholder image webpart until the full size image is loaded.
     */
    encodedLQIPImage?: string;
}
export default IThumbnailRequest;
//# sourceMappingURL=IThumbnailRequest.d.ts.map