Type Alias WorkspaceItem<T>Beta

WorkspaceItem<T>: WorkspaceRecord & {
    #os_path?: string;
    os_content_size?: number;
    os_has_attachment?: boolean;
    os_item_content?: T & {
        image?: ImageInfo;
    };
    os_item_content_type?: string;
    os_parent_folder?: string;
    os_readonly?: boolean;
}

Represents a workspace item with optional content.

Type Parameters

  • T = any

Type declaration

  • Optional Beta#os_path?: string

    Optional path from the os_parent_folder or os_workspace to the item. Does not include the item name. Used only when saving by POST to the /entity API. eg. 'folder1/folder2'

  • Optional Betaos_content_size?: number

    The size in bytes of the content.

  • Optional Betaos_has_attachment?: boolean

    Whether the item has an attachment file content.

  • Optional Betaos_item_content?: T & {
        image?: ImageInfo;
    }

    The type-specific content of the workspace item.

  • Optional Betaos_item_content_type?: string

    The type of the content.

  • Optional Betaos_parent_folder?: string

    The id of the folder in which the item is stored.

  • Optional Betaos_readonly?: boolean

    Whether the item is readonly or not.