Interface used for displaying file status to the user

interface FileStatus {
    error: boolean;
    errorStatus?: FileStatusError;
    id: string;
    linked: boolean;
    name: string;
    progress?: number;
    size?: number;
    type: string;
    uploaded: boolean;
}

Properties

error: boolean

whether client side validation or server side uploading failed

errorStatus?: FileStatusError

if error is true, the type of error that occured

id: string

a unique id to identify the file. Before linking to the case, this is a client side generated id After the file is linked to the casee, this value is replaced with the pzInsKey coming from the server

linked: boolean

whether the uploaded file is succesfully linked to the case

name: string

the file name of the selected or uploaded file

progress?: number

a percentage between 0 - 100 to indicate the progress of the file upload

size?: number

file size of the selected file, not available when file is already linked to case

type: string

mime type of the file

uploaded: boolean

whether the file is fully available on the server