communication-react-19/dist/dist-esm/react-components/src/types/Attachment.d.ts

React library for building modern communication user experiences utilizing Azure Communication Services (React 19 compatible fork)

/// <reference types="react" />
import { ChatMessage } from './ChatMessage';
import { AttachmentMetadata } from "../../../acs-ui-common/src";
/**
 * @beta
 *
 * Attachment Options that defines behaviour for uploading and downloading attachments.
 */
export interface AttachmentOptions {
    uploadOptions?: AttachmentUploadOptions;
    downloadOptions?: AttachmentDownloadOptions;
}
/**
 * @beta
 *
 * Attachment download options defines the list of actions that can be performed on an attachment.
 */
export interface AttachmentDownloadOptions {
    actionsForAttachment: AttachmentActionHandler;
}
/**
 * @beta
 *
 * Attachment menu action defines buttons that can be shown on the attachment card.
 * If there's one action, it will be shown as a button, if there are multiple actions, it will be shown as a dropdown.
 */
export interface AttachmentMenuAction {
    name: string;
    icon: JSX.Element;
    onClick: (attachment: AttachmentMetadata) => Promise<void>;
}
/**
 * @beta
 */
export interface AttachmentUploadOptions {
    /**
     * A list of strings containing the comma separated list of supported media (aka. mime) types.
     * i.e. ['image/*', 'video/*', 'audio/*']
     * Default value is `['*']`, meaning all media types are supported.
     * Similar to the `accept` attribute of the `<input type="attachment" />` element.
     * @beta
     */
    supportedMediaTypes?: string[];
    /**
     * Disable multiple attachments to be selected if set to `true`.
     * Default value is `false`, meaning multiple attachments can be selected.
     * Similar to the `multiple` attribute of the `<input type="attachment" />` element.
     * @beta
     */
    disableMultipleUploads?: boolean;
    /**
     * A callback function of type {@link AttachmentSelectionHandler} that will be called
     * when user finishes selecting files in browser's file picker. This function is required since
     * this would be where upload logic is implemented to your own storage.
     * @beta
     */
    handleAttachmentSelection: AttachmentSelectionHandler;
    /**
     * A optional callback function that will be called
     * when user removing files before clicking send message button. This function will be
     * where you can remove the file from your storage.
     * @beta
     */
    handleAttachmentRemoval?: AttachmentRemovalHandler;
}
/**
 * A upload task represents and manages an attachment that is being uploaded.
 * When using the Composite, an attachment upload task is created for each file user is selected to upload.
 * A upload task is complete when notifyUploadCompleted is called.
 * A upload task is failed when notifyUploadFailed is called.
 * @beta
 */
export interface AttachmentUploadTask {
    /**
     * Unique identifier for the attachment upload task.
     */
    taskId: string;
    /**
     * HTML {@link File} object for the uploaded attachment.
     */
    file?: File;
    /**
     * {@link Blob} object for the uploaded inline image.
     */
    image?: Blob;
    /**
     * Update the progress of the upload changed.
     * A upload is considered complete when the progress reaches 1.
     * @param value - number between 0 and 1
     */
    notifyUploadProgressChanged: (value: number) => void;
    /**
     * Mark the upload task as complete.
     * An attachment is considered completed uploading when ID and URL are provided.
     * @param id - the unique identifier of the attachment.
     * @param url - the download URL of the attachment.
     */
    notifyUploadCompleted: (id: string, url: string) => void;
    /**
     * Mark the upload task as failed.
     * @param message - An error message that can be displayed to the user.
     */
    notifyUploadFailed: (message: string) => void;
}
/**
 * @beta
 * A callback function that defines what actions user can perform on an attachment.
 * By default, the UI library would have default actions that opens attachment URL in a new tab.
 * You can override the default actions or add new actions by providing this callback function.
 * Moreover, you can also return dynamic actions based on the properties in {@link AttachmentMetadata} and/or {@link ChatMessage}.
 *
 * @param attachment - The file attachment that user is trying to perform actions on.
 * @param message - The chat message that contains this attachment.
 * @returns A list of {@link AttachmentMenuAction} that defines the type of actions user can perform on the attachment.
 */
export type AttachmentActionHandler = (attachment: AttachmentMetadata, message?: ChatMessage) => AttachmentMenuAction[];
/**
 * @beta
 * A callback function for handling list of upload tasks that contains files selected by user to upload.
 *
 * @param AttachmentUploads - The list of uploaded attachments. Each attachment is represented by an {@link AttachmentUpload} object.
 */
export type AttachmentSelectionHandler = (attachmentUploads: AttachmentUploadTask[]) => void;
/**
 * @beta
 * A callback function for handling attachment removed by the user in send box.
 *
 * @param attachmentId - The ID of uploaded attachments.
 */
export type AttachmentRemovalHandler = (attachmentId: string) => void;
/**
 * A wrapper for list of attachment metadata that is used for new message requests and update message requsts.
 * @internal
 */
export type AttachmentMetadataWrapper = {
    fileSharingMetadata: string;
};
//# sourceMappingURL=Attachment.d.ts.map