Interface SmiPageFile

The properties on a page file object.

interface SmiPageFile {
    category: string;
    deletable: boolean;
    deleteFetch?: Promise<void>;
    description?: string;
    displayOrder?: number;
    download?: Promise<void>;
    downloading: boolean;
    file?: Blob | File;
    id?: string;
    isLink: boolean;
    location?: string;
    name: string;
    nameWithExtension?: string;
    progress?: number;
    saved: boolean;
    size: number;
    type: string;
    upload?: Promise<SmiFileUploadResponse>;
    uploaded: boolean;
    uploadedAt?: string;
    uploadedBy?: string;
    uploadError?: SmiMessage;
    uploading: boolean;
    url: string;
    uuid: string;
}

Properties

category deletable deleteFetch? description? displayOrder? download? downloading file? id? isLink location? name nameWithExtension? progress? saved size type upload? uploaded uploadedAt? uploadedBy? uploadError? uploading url uuid

Properties

category

category: string

The file category.

deletable

deletable: boolean

Determines whether the file can be deleted.

OptionaldeleteFetch

deleteFetch?: Promise<void>

The delete fetch to the files service. Only defined if the file was deleted.

Optionaldescription

description?: string

The file description.

OptionaldisplayOrder

displayOrder?: number

The order that the file should be displayed in. This is used with controls which use multiple files.

Optionaldownload

download?: Promise<void>

A promise which resolves on download completion.

downloading

downloading: boolean

Determines whether the file is in the process of downloading.

Optionalfile

file?: Blob | File

The File or Blob object contained in the file.

Optionalid

id?: string

The ID of the file in the files microservice. Note that files that are not uploaded will not have one.

isLink

isLink: boolean

Used to determine whether an attachment should be displayed as a link.

Optionallocation

location?: string

The location of the file.

name

name: string

The name of the file.

OptionalnameWithExtension

nameWithExtension?: string

The name of the file and extension concatenated.

Optionalprogress

progress?: number

Progress of the download or upload process.

saved

saved: boolean

Determines whether the file has been uploaded to the files microservice and added to the page.

size

size: number

The file size.

type

type: string

The file type.

Optionalupload

upload?: Promise<SmiFileUploadResponse>

Promise which resolves on file upload completion.

uploaded

uploaded: boolean

Determines whether the file has been uploaded.

OptionaluploadedAt

uploadedAt?: string

The time and date the file was uploaded.

OptionaluploadedBy

uploadedBy?: string

The name of the user who uploaded the file.

OptionaluploadError

uploadError?: SmiMessage

A user message detailing upload errors.

uploading

uploading: boolean

Determines whether the file is in the process of uploading.

url

url: string

The file URL.

uuid

uuid: string

A unique identifier for the file.

Settings

Member Visibility

On This Page

Properties