Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FileSystemElement

The file class represents a file in nextcloud. It exposes file properties and content handling, commenting and tagging

Hierarchy

  • FileSystemElement

Implemented by

Index

Accessors

Methods

Accessors

baseName

  • get baseName(): string

  • The base name of the file system element (name without path) The base name is readonly

    Returns string

id

  • get id(): number

lastmod

  • get lastmod(): Date

name

  • get name(): string

Methods

Abstract addComment

  • addComment(comment: string): Promise<void>

Abstract addTag

  • addTag(tagName: string): Promise<void>

  • adds a tag name to the file system element

    Parameters

    • tagName: string

      name of the tag

    Returns Promise<void>

Abstract delete

  • delete(): Promise<void>

Abstract getComments

  • getComments(top?: undefined | number, skip?: undefined | number): Promise<string[]>

  • get list of comments of file

    throws

    Exception

    Parameters

    • Optional top: undefined | number

      number of comments to return

    • Optional skip: undefined | number

      the offset

    Returns Promise<string[]>

    array of comment strings

Abstract getTags

  • getTags(): Promise<string[]>

Abstract getUIUrl

  • getUIUrl(): string

Abstract getUrl

  • getUrl(): string

Abstract move

Abstract removeTag

  • removeTag(tagName: string): Promise<void>

  • removes a tag of the file system element

    Parameters

    • tagName: string

      the name of the tag

    Returns Promise<void>

Generated using TypeDoc