@microsoft/teams-js 2.30.0 → 2.31.0-beta.0

package/dist/esm/packages/teams-js/dts/private/files.d.ts

@@ -0,0 +1,758 @@
+import { FileOpenPreference, SdkError } from '../public/interfaces';
+export declare namespace files {
+    /**
+     * @hidden
+     *
+     * Cloud storage providers registered with Microsoft Teams
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export enum CloudStorageProvider {
+        Dropbox = "DROPBOX",
+        Box = "BOX",
+        Sharefile = "SHAREFILE",
+        GoogleDrive = "GOOGLEDRIVE",
+        Egnyte = "EGNYTE",
+        SharePoint = "SharePoint"
+    }
+    interface IWopiThumbnail {
+        size: number;
+        url: string;
+    }
+    interface IWopiService {
+        name: string;
+        description: string;
+        thumbnails: IWopiThumbnail[];
+    }
+    /**
+     * @hidden
+     *
+     * External third-party cloud storages providers interface
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export interface IExternalProvider extends IWopiService {
+        providerType: CloudStorageProviderType;
+        providerCode: CloudStorageProvider;
+    }
+    /**
+     * @hidden
+     *
+     * Cloud storage provider type enums
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export enum CloudStorageProviderType {
+        Sharepoint = 0,
+        WopiIntegration = 1,
+        Google = 2,
+        OneDrive = 3,
+        Recent = 4,
+        Aggregate = 5,
+        FileSystem = 6,
+        Search = 7,
+        AllFiles = 8,
+        SharedWithMe = 9
+    }
+    /**
+     * @hidden
+     *
+     * Cloud storage folder interface
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export interface CloudStorageFolder {
+        /**
+         * @hidden
+         * ID of the cloud storage folder
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        id: string;
+        /**
+         * @hidden
+         * Display Name/Title of the cloud storage folder
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        title: string;
+        /**
+         * @hidden
+         * ID of the cloud storage folder in the provider
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        folderId: string;
+        /**
+         * @hidden
+         * Type of the cloud storage folder provider integration
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        providerType: CloudStorageProviderType;
+        /**
+         * @hidden
+         * Code of the supported cloud storage folder provider
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        providerCode: CloudStorageProvider;
+        /**
+         * @hidden
+         * Display name of the owner of the cloud storage folder provider
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        ownerDisplayName: string;
+        /**
+         * @hidden
+         * Sharepoint specific siteURL of the folder
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        siteUrl?: string;
+        /**
+         * @hidden
+         * Sharepoint specific serverRelativeUrl of the folder
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        serverRelativeUrl?: string;
+        /**
+         * @hidden
+         * Sharepoint specific libraryType of the folder
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        libraryType?: string;
+        /**
+         * @hidden
+         * Sharepoint specific accessType of the folder
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        accessType?: string;
+    }
+    /**
+     * @hidden
+     *
+     * Cloud storage item interface
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export interface CloudStorageFolderItem {
+        /**
+         * @hidden
+         * ID of the item in the provider
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        id: string;
+        /**
+         * @hidden
+         * Display name/title
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        title: string;
+        /**
+         * @hidden
+         * Key to differentiate files and subdirectory
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        isSubdirectory: boolean;
+        /**
+         * @hidden
+         * File extension
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        type: string;
+        /**
+         * @hidden
+         * Last modifed time of the item
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        lastModifiedTime: string;
+        /**
+         * @hidden
+         * Display size of the items in bytes
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        size: number;
+        /**
+         * @hidden
+         * URL of the file
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        objectUrl: string;
+        /**
+         * @hidden
+         * Temporary access token for the item
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        accessToken?: string;
+    }
+    /**
+     * @hidden
+     *
+     * Files entity user interface
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export interface IFilesEntityUser {
+        /**
+         * @hidden
+         * User name.
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        displayName: string;
+        /**
+         * @hidden
+         * User email.
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        email: string;
+        /**
+         * @hidden
+         * User MRI.
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        mri: string;
+    }
+    /**
+     * @hidden
+     *
+     * Special Document Library enum
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export enum SpecialDocumentLibraryType {
+        ClassMaterials = "classMaterials"
+    }
+    /**
+     * @hidden
+     *
+     * Document Library Access enum
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export enum DocumentLibraryAccessType {
+        Readonly = "readonly"
+    }
+    /**
+     * @hidden
+     *
+     * SharePoint file interface
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export interface ISharePointFile {
+        siteId?: string;
+        siteUrl: string;
+        objectId: string;
+        objectUrl: string;
+        openInWindowFileUrl: string;
+        title: string;
+        isFolder: boolean;
+        serverRelativeUrl: string;
+        lastModifiedByUser: IFilesEntityUser;
+        lastModifiedTime: string;
+        sentByUser: IFilesEntityUser;
+        createdByUser: IFilesEntityUser;
+        createdTime: string;
+        size: number;
+        type: string;
+        spItemUrl?: string;
+        libraryType?: SpecialDocumentLibraryType;
+        accessType?: DocumentLibraryAccessType;
+        etag?: string;
+        remoteItem?: string;
+        listUrl?: string;
+    }
+    /**
+     * @hidden
+     *
+     * Download status enum
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export enum FileDownloadStatus {
+        Downloaded = "Downloaded",
+        Downloading = "Downloading",
+        Failed = "Failed"
+    }
+    /**
+     * @hidden
+     *
+     * Download Files interface
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export interface IFileItem {
+        /**
+         * @hidden
+         * ID of the file metadata
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        objectId?: string;
+        /**
+         * @hidden
+         * Path of the file
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        path?: string;
+        /**
+         * @hidden
+         * Size of the file in bytes
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        sizeInBytes?: number;
+        /**
+         * @hidden
+         * Download status
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        status?: FileDownloadStatus;
+        /**
+         * @hidden
+         * Download timestamp
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        timestamp: Date;
+        /**
+         * @hidden
+         * File name
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        title: string;
+        /**
+         * @hidden
+         * Type of file i.e. the file extension.
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        extension: string;
+    }
+    /**
+     * @hidden
+     * Object used to represent a file
+     * @beta
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export interface File extends Blob {
+        /**
+         * A number that represents the number of milliseconds since the Unix epoch
+         */
+        lastModified: number;
+        /**
+         * Name of the file
+         */
+        name: string;
+        /**
+         * A string containing the path of the file relative to the ancestor directory the user selected
+         */
+        webkitRelativePath?: string;
+    }
+    /**
+     * @hidden
+     * Hide from docs
+     *
+     * Actions specific to 3P cloud storage provider file and / or account
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export enum CloudStorageProviderFileAction {
+        Download = "DOWNLOAD",
+        Upload = "UPLOAD",
+        Delete = "DELETE"
+    }
+    /**
+     * @hidden
+     * Hide from docs
+     *
+     * Interface for 3P cloud storage provider request content type
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export interface CloudStorageProviderRequest<T> {
+        content: T;
+    }
+    /**
+     * @hidden
+     * Hide from docs
+     *
+     * Base interface for 3P cloud storage provider action request content
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export interface CloudStorageProviderContent {
+        providerCode: CloudStorageProvider;
+    }
+    /**
+     * @hidden
+     * Hide from docs
+     *
+     * Interface representing 3P cloud storage provider add new file action.
+     * The file extension represents type of file e.g. docx, pptx etc. and need not be prefixed with dot(.)
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export interface CloudStorageProviderNewFileContent extends CloudStorageProviderContent {
+        newFileName: string;
+        newFileExtension: string;
+        destinationFolder: CloudStorageFolderItem | ISharePointFile;
+    }
+    /**
+     * @hidden
+     * Hide from docs
+     *
+     * Interface representing 3P cloud storage provider rename existing file action
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export interface CloudStorageProviderRenameFileContent extends CloudStorageProviderContent {
+        existingFile: CloudStorageFolderItem | ISharePointFile;
+        newFile: CloudStorageFolderItem | ISharePointFile;
+    }
+    /**
+     * @hidden
+     * Hide from docs
+     *
+     * Interface representing 3P cloud storage provider delete existing file(s) action
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export interface CloudStorageProviderDeleteFileContent extends CloudStorageProviderContent {
+        itemList: CloudStorageFolderItem[] | ISharePointFile[];
+    }
+    /**
+     * @hidden
+     * Hide from docs
+     *
+     * Interface representing 3P cloud storage provider download existing file(s) action
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export interface CloudStorageProviderDownloadFileContent extends CloudStorageProviderContent {
+        itemList: CloudStorageFolderItem[] | ISharePointFile[];
+    }
+    /**
+     * @hidden
+     * Hide from docs
+     * @beta
+     *
+     * Interface representing 3P cloud storage provider upload existing file(s) action
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export interface CloudStorageProviderUploadFileContent extends CloudStorageProviderContent {
+        itemList: File[];
+        destinationFolder: CloudStorageFolderItem | ISharePointFile;
+    }
+    /**
+     * @hidden
+     * Hide from docs
+     *
+     * Gets a list of cloud storage folders added to the channel. This function will not timeout;
+     * the callback will only return when the host responds with a list of folders or error.
+     *
+     * @param channelId - ID of the channel whose cloud storage folders should be retrieved
+     * @param callback - Callback that will be triggered post folders load
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export function getCloudStorageFolders(channelId: string, callback: (error: SdkError, folders: CloudStorageFolder[]) => void): void;
+    /**
+     * @hidden
+     * Hide from docs
+     * ------
+     * Initiates the add cloud storage folder flow
+     *
+     * @param channelId - ID of the channel to add cloud storage folder
+     * @param callback - Callback that will be triggered post add folder flow is compelete
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export function addCloudStorageFolder(channelId: string, callback: (error: SdkError, isFolderAdded: boolean, folders: CloudStorageFolder[]) => void): void;
+    /**
+     * @hidden
+     * Hide from docs
+     * ------
+     *
+     * Deletes a cloud storage folder from channel
+     *
+     * @param channelId - ID of the channel where folder is to be deleted
+     * @param folderToDelete - cloud storage folder to be deleted
+     * @param callback - Callback that will be triggered post delete
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export function deleteCloudStorageFolder(channelId: string, folderToDelete: CloudStorageFolder, callback: (error: SdkError, isFolderDeleted: boolean) => void): void;
+    /**
+     * @hidden
+     * Hide from docs
+     * ------
+     *
+     * Fetches the contents of a Cloud storage folder (CloudStorageFolder) / sub directory
+     *
+     * @param folder - Cloud storage folder (CloudStorageFolder) / sub directory (CloudStorageFolderItem)
+     * @param providerCode - Code of the cloud storage folder provider
+     * @param callback - Callback that will be triggered post contents are loaded
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export function getCloudStorageFolderContents(folder: CloudStorageFolder | CloudStorageFolderItem, providerCode: CloudStorageProvider, callback: (error: SdkError, items: CloudStorageFolderItem[]) => void): void;
+    /**
+     * @hidden
+     * Hide from docs
+     * ------
+     *
+     * Open a cloud storage file in Teams
+     *
+     * @param file - cloud storage file that should be opened
+     * @param providerCode - Code of the cloud storage folder provider
+     * @param fileOpenPreference - Whether file should be opened in web/inline
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export function openCloudStorageFile(file: CloudStorageFolderItem, providerCode: CloudStorageProvider, fileOpenPreference?: FileOpenPreference.Web | FileOpenPreference.Inline): void;
+    /**
+     * @hidden
+     * Allow 1st party apps to call this function to get the external
+     * third party cloud storage accounts that the tenant supports
+     * @param excludeAddedProviders: return a list of support third party
+     * cloud storages that hasn't been added yet.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export function getExternalProviders(excludeAddedProviders: boolean | undefined, callback: (error: SdkError, providers: IExternalProvider[]) => void): void;
+    /**
+     * @hidden
+     * Allow 1st party apps to call this function to move files
+     * among SharePoint and third party cloud storages.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export function copyMoveFiles(selectedFiles: CloudStorageFolderItem[] | ISharePointFile[], providerCode: CloudStorageProvider, destinationFolder: CloudStorageFolderItem | ISharePointFile, destinationProviderCode: CloudStorageProvider, isMove: boolean | undefined, callback: (error?: SdkError) => void): void;
+    /**
+     * @hidden
+     * Hide from docs
+     *  ------
+     *
+     * Gets list of downloads for current user
+     * @param callback Callback that will be triggered post downloads load
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export function getFileDownloads(callback: (error?: SdkError, files?: IFileItem[]) => void): void;
+    /**
+     * @hidden
+     * Hide from docs
+     *
+     * Open download preference folder if fileObjectId value is undefined else open folder containing the file with id fileObjectId
+     * @param fileObjectId - Id of the file whose containing folder should be opened
+     * @param callback Callback that will be triggered post open download folder/path
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export function openDownloadFolder(fileObjectId: string | undefined, callback: (error?: SdkError) => void): void;
+    /**
+     * @hidden
+     * Hide from docs
+     *
+     * Initiates add 3P cloud storage provider flow, where a pop up window opens for user to select required
+     * 3P provider from the configured policy supported 3P provider list, following which user authentication
+     * for selected 3P provider is performed on success of which the selected 3P provider support is added for user
+     * @beta
+     *
+     * @param callback Callback that will be triggered post add 3P cloud storage provider action.
+     * If the error is encountered (and hence passed back), no provider value is sent back.
+     * For success scenarios, error value will be passed as null and a valid provider value is sent.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export function addCloudStorageProvider(callback: (error?: SdkError, provider?: CloudStorageProvider) => void): void;
+    /**
+     * @hidden
+     * Hide from docs
+     *
+     * Initiates signout of 3P cloud storage provider flow, which will remove the selected
+     * 3P cloud storage provider from the list of added providers. No other user input and / or action
+     * is required except the 3P cloud storage provider to signout from
+     *
+     * @param logoutRequest 3P cloud storage provider remove action request content
+     * @param callback Callback that will be triggered post signout of 3P cloud storage provider action
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export function removeCloudStorageProvider(logoutRequest: CloudStorageProviderRequest<CloudStorageProviderContent>, callback: (error?: SdkError) => void): void;
+    /**
+     * @hidden
+     * Hide from docs
+     *
+     * Initiates the add 3P cloud storage file flow, which will add a new file for the given 3P provider
+     *
+     * @param addNewFileRequest 3P cloud storage provider add action request content
+     * @param callback Callback that will be triggered post adding a new file flow is finished
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export function addCloudStorageProviderFile(addNewFileRequest: CloudStorageProviderRequest<CloudStorageProviderNewFileContent>, callback: (error?: SdkError, actionStatus?: boolean) => void): void;
+    /**
+     * @hidden
+     * Hide from docs
+     *
+     * Initiates the rename 3P cloud storage file flow, which will rename an existing file in the given 3P provider
+     *
+     * @param renameFileRequest 3P cloud storage provider rename action request content
+     * @param callback Callback that will be triggered post renaming an existing file flow is finished
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export function renameCloudStorageProviderFile(renameFileRequest: CloudStorageProviderRequest<CloudStorageProviderRenameFileContent>, callback: (error?: SdkError, actionStatus?: boolean) => void): void;
+    /**
+     * @hidden
+     * Hide from docs
+     *
+     * Initiates the delete 3P cloud storage file(s) / folder (folder has to be empty) flow,
+     * which will delete existing file(s) / folder from the given 3P provider
+     *
+     * @param deleteFileRequest 3P cloud storage provider delete action request content
+     * @param callback Callback that will be triggered post deleting existing file(s) flow is finished
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export function deleteCloudStorageProviderFile(deleteFileRequest: CloudStorageProviderRequest<CloudStorageProviderDeleteFileContent>, callback: (error?: SdkError, actionStatus?: boolean) => void): void;
+    /**
+     * @hidden
+     * Hide from docs
+     *
+     * Initiates the download 3P cloud storage file(s) flow,
+     * which will download existing file(s) from the given 3P provider in the teams client side without sharing any file info in the callback
+     *
+     * @param downloadFileRequest 3P cloud storage provider download file(s) action request content
+     * @param callback Callback that will be triggered post downloading existing file(s) flow is finished
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export function downloadCloudStorageProviderFile(downloadFileRequest: CloudStorageProviderRequest<CloudStorageProviderDownloadFileContent>, callback: (error?: SdkError, actionStatus?: boolean) => void): void;
+    /**
+     * @hidden
+     * Hide from docs
+     *
+     * Initiates the upload 3P cloud storage file(s) flow, which will upload file(s) to the given 3P provider
+     * @beta
+     *
+     * @param uploadFileRequest 3P cloud storage provider upload file(s) action request content
+     * @param callback Callback that will be triggered post uploading file(s) flow is finished
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export function uploadCloudStorageProviderFile(uploadFileRequest: CloudStorageProviderRequest<CloudStorageProviderUploadFileContent>, callback: (error?: SdkError, actionStatus?: boolean) => void): void;
+    /**
+     * @hidden
+     * Hide from docs
+     *
+     * Register a handler to be called when a user's 3P cloud storage provider list changes i.e.
+     * post adding / removing a 3P provider, list is updated
+     *
+     * @param handler - When 3P cloud storage provider list is updated this handler is called
+     *
+     * @internal Limited to Microsoft-internal use
+     */
+    export function registerCloudStorageProviderListChangeHandler(handler: () => void): void;
+    /**
+     * @hidden
+     * Hide from docs
+     *
+     * Register a handler to be called when a user's 3P cloud storage provider content changes i.e.
+     * when file(s) is/are added / renamed / deleted / uploaded, the list of files is updated
+     *
+     * @param handler - When 3P cloud storage provider content is updated this handler is called
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export function registerCloudStorageProviderContentChangeHandler(handler: () => void): void;
+    export {};
+}