@selfcommunity/api-services/lib/esm/types/media.d.ts

Client api for SelfCommunity.

import { SCEmbedType } from '@selfcommunity/types';
/**
 * Interface MediaCreateParams
 */
export interface MediaCreateParams {
    /**
     * The media type.
     */
    type: MediaTypes;
    /**
     * Required if media type is url
     */
    url?: string;
    /**
     * Required if media type is share
     */
    share_object?: number;
    /**
     * Required if media type is embed
     */
    embed?: SCEmbedType;
}
export declare enum MediaTypes {
    URL = "url",
    SHARE = "share",
    EMBED = "embed"
}
/**
 * Interface ChunkUploadParams
 */
export interface ChunkUploadParams {
    /**
     * String returned by the first call and required from the second
     */
    upload_id: string;
    /**
     * The expiration time.
     */
    expires?: string;
    /**
     * The image chunk to be uploaded
     */
    image?: Blob;
    /**
     * The document chunk to be uploaded
     */
    document?: Blob;
}
/**
 * Interface ChunkUploadCompleteParams
 */
export interface ChunkUploadCompleteParams {
    /**
     * Default to image or document based on file extension
     * It can be: image, doc, eimage.
     */
    type?: string;
    /**
     * Id of the chunk uploaded file.
     */
    upload_id: string;
    /**
     * MD5 hash of the original file for checksum proposal
     */
    md5: string;
}