Type Alias File

File: {
    access_type?: AccessTypeEnum;
    app_metadata?: Record<string, any>;
    content_extension: string | null;
    content_length: number | null;
    content_type: FileContentTypeEnum;
    content_url: string | null;
    created_at: string;
    created_by: MiniUser;
    download_type?: DownloadTypeEnum;
    expires_at?: string | null;
    folder: MiniFolder;
    folder_id?: string;
    global_id: string;
    id: string;
    instance_id: string;
    metadata?: Record<string, any>;
    modified_at: string;
    modified_by: MiniUser;
    name?: string;
    original_extension: string | null;
    original_url: string | null;
    owned_by: MiniUser;
    permissions?: FilePermission;
    published_at: string | null;
    role: CollaborationRoleEnum;
    search: string | null;
    shared_link: MiniSharedLink;
    size: number | null;
    status: FileStatusEnum;
    tags?: string[];
    thumbnail_url: string | null;
    transcript?: string;
    type: FileTypeEnum;
    zip_size: number | null;
    zip_url: string | null;
}

Type declaration

  • Optionalaccess_type?: AccessTypeEnum
  • Optionalapp_metadata?: Record<string, any>
  • Readonlycontent_extension: string | null
  • Readonlycontent_length: number | null
  • Readonlycontent_type: FileContentTypeEnum
  • Readonlycontent_url: string | null
  • Readonlycreated_at: string
  • Readonlycreated_by: MiniUser
  • Optionaldownload_type?: DownloadTypeEnum
  • Optionalexpires_at?: string | null
  • Readonlyfolder: MiniFolder
  • Optionalfolder_id?: string
  • Readonlyglobal_id: string
  • Readonlyid: string
  • Readonlyinstance_id: string
  • Optionalmetadata?: Record<string, any>
  • Readonlymodified_at: string
  • Readonlymodified_by: MiniUser
  • Optionalname?: string
  • Readonlyoriginal_extension: string | null
  • Readonlyoriginal_url: string | null
  • Readonlyowned_by: MiniUser
  • Optionalpermissions?: FilePermission
  • Readonlypublished_at: string | null
  • Readonlyrole: CollaborationRoleEnum

    Deprecated: Please use the 'permissions' field instead. This field is maintained for backward compatibility and may be removed in future releases.

  • Readonlysearch: string | null
  • Readonlyshared_link: MiniSharedLink
  • Readonlysize: number | null
  • Readonlystatus: FileStatusEnum
  • Optionaltags?: string[]
  • Readonlythumbnail_url: string | null
  • Optionaltranscript?: string
  • Readonlytype: FileTypeEnum
  • Readonlyzip_size: number | null
  • Readonlyzip_url: string | null

Settings

Member Visibility