Class File

Hierarchy (View Summary)

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

constructor

Accessors

attributes

  • get attributes(): Attribute

  • Get the file attribute This contains all additional attributes not provided by the Node class

    Returns Attribute

basename

  • 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

crtime

  • 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

data

dirname

  • 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

displayname

  • 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

encodedSource

  • get encodedSource(): string

  • Get the encoded source url to this object for requests purposes

    Returns string

extension

  • 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

fileid

  • 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

isDavResource

  • get isDavResource(): boolean

  • Is this a dav-related resource ?

    Returns boolean

isDavRessource

  • get isDavRessource(): boolean

  • Returns boolean

    Deprecated

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

mime

  • get mime(): undefined | string

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

    Returns undefined | string

mtime

  • 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

owner

  • get owner(): null | string

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

    Returns null | string

path

  • get path(): string

  • Get the absolute path of this object relative to the root

    Returns string

permissions

root

  • 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

size

  • 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

source

  • 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

status

type

Methods

clone

move

rename

  • rename(basename: string): void

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

    Parameters

    • basename: string

      The new name of the node

    Returns void

update

  • update(attributes: Attribute): 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

updateMtime

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods