SAS logoSAS® Mobile Investigator API
    Preparing search index...

    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;
    }
    Index

    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: string

    The file category.

    deletable: boolean

    Determines whether the file can be deleted.

    deleteFetch?: Promise<void>

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

    description?: string

    The file description.

    displayOrder?: number

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

    download?: Promise<void>

    A promise which resolves on download completion.

    downloading: boolean

    Determines whether the file is in the process of downloading.

    file?: Blob | File

    The File or Blob object contained in the file.

    id?: string

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

    isLink: boolean

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

    location?: string

    The location of the file.

    name: string

    The name of the file.

    nameWithExtension?: string

    The name of the file and extension concatenated.

    progress?: number

    Progress of the download or upload process.

    saved: boolean

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

    size: number

    The file size.

    type: string

    The file type.

    upload?: Promise<SmiFileUploadResponse>

    Promise which resolves on file upload completion.

    uploaded: boolean

    Determines whether the file has been uploaded.

    uploadedAt?: string

    The time and date the file was uploaded.

    uploadedBy?: string

    The name of the user who uploaded the file.

    uploadError?: SmiMessage

    A user message detailing upload errors.

    uploading: boolean

    Determines whether the file is in the process of uploading.

    url: string

    The file URL.

    uuid: string

    A unique identifier for the file.

    Settings

    Member Visibility

    On This Page

    Properties