Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 | 1x | import Client, { ClientError } from "./client";
/**
* The file class represents a file in nextcloud.
* It exposes file properties and content handling, commenting and tagging
*/
export default abstract class FileSystemElement {
/**
* The name of the file system element including the path
* The name is readonly
*/
abstract get name(): string;
/**
* The base name of the file system element (name without path)
* The base name is readonly
*/
abstract get baseName(): string;
/**
* The timestamp of the last file system element change
* readonly
*/
abstract get lastmod(): Date;
/**
* The unique id of the file system element.
*/
abstract get id(): number;
/**
* deletes a file system element
* @throws Error
*/
public abstract async delete(): Promise<void>;
/**
* moves or renames the current file system element to the new location
* target folder must exists
* @param targetFileName the name of the target file /f1/f2/myfile.txt
* @throws Error
*/
public abstract async move(targetName: string): Promise<FileSystemElement>;
/**
* @returns the url of the file sytsem element
* @throws Error
*/
public abstract getUrl(): string;
/**
* @returns the url of the file system element in the UI
* @throws Error
*/
public abstract getUIUrl(): string;
/**
* adds a tag name to the file system element
* @param tagName name of the tag
*/
public abstract async addTag(tagName: string): Promise<void>;
/**
* get tag names
* @returns array of tag names
*/
public abstract async getTags(): Promise<string[]>;
/**
* removes a tag of the file system element
* @param tagName the name of the tag
*/
public abstract async removeTag(tagName: string): Promise<void>;
/**
* add comment to file
* @param comment the comment
*/
public abstract async addComment(comment: string): Promise<void>;
/**
* get list of comments of file
* @param top number of comments to return
* @param skip the offset
* @returns array of comment strings
* @throws Exception
*/
public abstract async getComments(top?: number, skip?: number): Promise<string[]>;
}
|