@nextcloud/files

    Class NodeAbstract

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Accessors

    attributes basename crtime data dirname displayname encodedSource extension fileid isDavResource isDavRessource mime mtime owner path permissions root size source status type

    Methods

    clone move rename update updateMtime

    Constructors

    Accessors

    • get basename(): string

      Get this object name There is no setter as the source is not meant to be changed manually. You can use the rename or move method to change the source.

      Returns string

    • get crtime(): undefined | Date

      Get the file creation time There is no setter as the creation time is not meant to be changed

      Returns undefined | Date

    • get dirname(): string

      Get the directory path leading to this object Will use the relative path to root if available

      There is no setter as the source is not meant to be changed manually. You can use the rename or move method to change the source.

      Returns string

    • get displayname(): string

      The nodes displayname By default the display name and the basename are identical, but it is possible to have a different name. This happens on the files app for example for shared folders.

      Returns string

    • set displayname(displayname: string): void

      Set the displayname

      Parameters

      • displayname: string

      Returns void

    • get encodedSource(): string

      Get the encoded source url to this object for requests purposes

      Returns string

    • get extension(): null | string

      Get this object's extension There is no setter as the source is not meant to be changed manually. You can use the rename or move method to change the source.

      Returns null | string

    • get fileid(): undefined | number

      Get the node id if defined. There is no setter as the fileid is not meant to be changed

      Returns undefined | number

    • get isDavResource(): boolean

      Is this a dav-related resource ?

      Returns boolean

    • get isDavRessource(): boolean

      Returns boolean

      use isDavResource instead - will be removed in next major version.

    • get mime(): string

      Get the file mime

      Returns string

    • set mime(mime: undefined | string): void

      Set the file mime Removing the mime type will set it to application/octet-stream

      Parameters

      • mime: undefined | string

      Returns void

    • get mtime(): undefined | Date

      Get the file modification time

      Returns undefined | Date

    • set mtime(mtime: undefined | Date): void

      Set the file modification time

      Parameters

      • mtime: undefined | Date

      Returns void

    • get owner(): null | string

      Get the file owner There is no setter as the owner is not meant to be changed

      Returns null | string

    • get path(): string

      Get the absolute path of this object relative to the root

      Returns string

    • get root(): null | string

      Get the dav root of this object There is no setter as the root is not meant to be changed

      Returns null | string

    • get size(): undefined | number

      Get the file size

      Returns undefined | number

    • set size(size: undefined | number): void

      Set the file size

      Parameters

      • size: undefined | number

      Returns void

    • get source(): string

      Get the source url to this object There is no setter as the source is not meant to be changed manually. You can use the rename or move method to change the source.

      Returns string

    Methods

    • Rename the node This aliases the move method for easier usage

      Parameters

      • basename: string

        The new name of the node

      Returns void

    • Update the attributes of the node Warning, updating attributes will NOT automatically update the mtime.

      Parameters

      • attributes: Attribute

        The new attributes to update on the Node attributes

      Returns void

    • Update the mtime if exists

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    MMNEPVFCICPMFPCPTTAAATR