mise API - v0.0.0
    Preparing search index...

    Interface UserFile

    User file item resource object representing a user's file.

    interface UserFile {
        auth: Object;
        collection: Object | null;
        contentType: string;
        url: string;
        get data(): Object | null;
        get isEmpty(): boolean;
        _delete(timeout?: number): Promise<any>;
        _getResource(
            linkRelation: string,
            ResourceClass: Object,
            searchParams?: { limit?: number; offset?: number },
            timeout?: number,
        ): Promise<Object>;
        _put(
            data: Object,
            uploadFileObj: Object | null,
            timeout?: number,
        ): Promise<UserFile>;
        addGroupPermission(
            group_name: string,
            permission: string,
            timeout?: number,
        ): Promise<FileGroupPermission>;
        addUserPermission(
            username: string,
            permission: string,
            timeout?: number,
        ): Promise<FileUserPermission>;
        clone(): Resource;
        delete(timeout?: number): Promise<any>;
        get(timeout?: number): Promise<UserFile>;
        getFileBlob(timeout?: number): Promise<Blob>;
        getFileStream(timeout?: number): Promise<AxiosResponse>;
        getGroupPermission(
            group_name: string,
            timeout?: number,
        ): Promise<FileGroupPermission | null>;
        getGroupPermissions(
            searchParams?: {
                group_name?: string;
                id?: number;
                limit?: number;
                offset?: number;
            },
            timeout?: number,
        ): Promise<FileGroupPermissionList>;
        getParentFolder(timeout?: number): Promise<FileBrowserFolder>;
        getPUTParameters(): string[] | null;
        getUserPermission(
            username: string,
            timeout?: number,
        ): Promise<FileUserPermission | null>;
        getUserPermissions(
            searchParams?: {
                id?: number;
                limit?: number;
                offset?: number;
                username?: string;
            },
            timeout?: number,
        ): Promise<FileUserPermissionList>;
        makePublic(timeout?: number): Promise<UserFile>;
        makeUnpublic(timeout?: number): Promise<UserFile>;
        put(
            data: { public?: boolean; upload_path?: string },
            timeout?: number,
        ): Promise<UserFile>;
    }

    Hierarchy (View Summary)

    Index
    auth collection contentType url
    data isEmpty
    _delete _getResource _put addGroupPermission addUserPermission clone delete get getFileBlob getFileStream getGroupPermission getGroupPermissions getParentFolder getPUTParameters getUserPermission getUserPermissions makePublic makeUnpublic put
    auth: Object
    collection: Object | null
    contentType: string
    url: string
    • get data(): Object | null

      Get the item's data object (REST API descriptors).

      Returns Object | null

    • get isEmpty(): boolean

      Return true if the resource object contains any data.

      Returns boolean

    _delete

    • _delete(timeout?: number): Promise<any>

      Internal helper method to make a DELETE request to this item resource through the REST API.

      Parameters

      • Optionaltimeout: number

        request timeout

      Returns Promise<any>

      • JS Promise

    _getResource

    • _getResource(
          linkRelation: string,
          ResourceClass: Object,
          searchParams?: { limit?: number; offset?: number },
          timeout?: number,
      ): Promise<Object>

      Internal method to fetch a related resource from the REST API that is referenced by a link relation within the item object.

      Parameters

      • linkRelation: string
      • ResourceClass: Object
      • OptionalsearchParams: { limit?: number; offset?: number }

        search parameters object which is resource-specific

        • Optionallimit?: number

          page limit

        • Optionaloffset?: number

          page offset

      • Optionaltimeout: number

        request timeout

      Returns Promise<Object>

      • JS Promise, resolves to a ResourceClass object

      throw error if this item resource has not yet been fetched from the REST API

      throw error when the link relation is not found

    _put

    • _put(
          data: Object,
          uploadFileObj: Object | null,
          timeout?: number,
      ): Promise<UserFile>

      Internal helper method to make a PUT request to this item resource through the REST API.

      Parameters

      • data: Object

        request JSON data object

      • uploadFileObj: Object | null

        custom file object

        • Object
          • fname

            file blob

        • null
      • Optionaltimeout: number

        request timeout

      Returns Promise<UserFile>

      • JS Promise, resolves to this object

    • Add a group permission to access the file.

      Parameters

      • group_name: string

        group's name

      • permission: string

        permission, can be 'r' or 'w'

      • Optionaltimeout: number

        request timeout

      Returns Promise<FileGroupPermission>

      • JS Promise, resolves to a FileGroupPermission object

    • Add a user permission to access the file.

      Parameters

      • username: string

        user's username

      • permission: string

        permission, can be 'r' or 'w'

      • Optionaltimeout: number

        request timeout

      Returns Promise<FileUserPermission>

      • JS Promise, resolves to a FileUserPermission object

    • Make a deep copy clone of this object resource.

      Returns Resource

      • clone object

    • Make a DELETE request to delete this user file item resource through the REST API.

      Parameters

      • Optionaltimeout: number

        request timeout

      Returns Promise<any>

      • JS Promise

    • Fetch this item resource from the REST API.

      Parameters

      • Optionaltimeout: number

        request timeout

      Returns Promise<UserFile>

      • JS Promise, resolves to this object

    • Fetch the file blob associated to this file item from the REST API.

      Parameters

      • Optionaltimeout: number

        request timeout

      Returns Promise<Blob>

      • JS Promise, resolves to a Blob object

    • Fetch the file as a stream (Node) or blob (browser) from the REST API.

      Parameters

      • Optionaltimeout: number

        request timeout

      Returns Promise<AxiosResponse>

      • JS Promise, resolves to the axios response with streaming/blob data

    • Get a file group permission given the name of the group.

      Parameters

      • group_name: string

        file group permission's group name

      • Optionaltimeout: number

        request timeout

      Returns Promise<FileGroupPermission | null>

      • JS Promise, resolves to a FileGroupPermission object or null

    • Fetch a list of group permissions associated to this file from the REST API.

      Parameters

      • OptionalsearchParams: { group_name?: string; id?: number; limit?: number; offset?: number }

        search parameters object

        • Optionalgroup_name?: string

          match group name exactly with this string

        • Optionalid?: number

          match file group permission id exactly with this number

        • Optionallimit?: number

          page limit

        • Optionaloffset?: number

          page offset

      • Optionaltimeout: number

        request timeout

      Returns Promise<FileGroupPermissionList>

      • JS Promise, resolves to a FileGroupPermissionList object

    • Fetch the parent folder of this file from the REST API.

      Parameters

      • Optionaltimeout: number

        request timeout

      Returns Promise<FileBrowserFolder>

      • JS Promise, resolves to a FileBrowserFolder object

    • Get an array of parameter names that can be used as properties of the data object in PUT requests.

      Returns string[] | null

      • array of PUT data property name or null if this list resource's data has not been fetched from the API yet or it doesn't support PUT requests.

    • Get a file user permission given the username of the user.

      Parameters

      • username: string

        file user permission's username

      • Optionaltimeout: number

        request timeout

      Returns Promise<FileUserPermission | null>

      • JS Promise, resolves to a FileUserPermission object or null

    • Fetch a list of user permissions associated to this file from the REST API.

      Parameters

      • OptionalsearchParams: { id?: number; limit?: number; offset?: number; username?: string }

        search parameters object

        • Optionalid?: number

          match file user permission id exactly with this number

        • Optionallimit?: number

          page limit

        • Optionaloffset?: number

          page offset

        • Optionalusername?: string

          match username exactly with this string

      • Optionaltimeout: number

        request timeout

      Returns Promise<FileUserPermissionList>

      • JS Promise, resolves to a FileUserPermissionList object

    • Make the file public.

      Parameters

      • Optionaltimeout: number

        request timeout

      Returns Promise<UserFile>

      • JS Promise, resolves to this object

    • Make the file unpublic.

      Parameters

      • Optionaltimeout: number

        request timeout

      Returns Promise<UserFile>

      • JS Promise, resolves to this object

    • Make a PUT request to modify this user file item resource through the REST API.

      Parameters

      • data: { public?: boolean; upload_path?: string }

        request JSON data object

        • Optionalpublic?: boolean

          public status of the file

        • Optionalupload_path?: string

          absolute path including file name where the file will be uploaded on the storage service

      • Optionaltimeout: number

        request timeout

      Returns Promise<UserFile>

      • JS Promise, resolves to this object

    Settings
    Member Visibility

    On This Page
    Properties
    Accessors
    Methods