Cloud

2/14/2024 - 11:29:58 PM

Cloud

Constructors

Properties

utils: {
    signals: { PauseSignal: typeof PauseSignal };
    utils: {
        calculateChunkIndices: (
            param0: { chunks: number; end: number; start: number },
        ) => [number, number];
        readLocalFileChunk: (
            param0: { length: number; offset: number; path: string },
        ) => Promise<Buffer>;
        readWebFileChunk: (
            param0: { file: File; index: number; length: number },
        ) => Promise<Buffer>;
    };
} = ...

Methods

  • Change the color of a directory.

    Parameters

    • param0: { color: string; uuid: string }

    Returns Promise<void>

    2/15/2024 - 8:52:40 PM

  • Checks if the parent of an item is shared or public linked. If so, it adds the item and all children of the item (in case of a directory) to the share or public link.

    Parameters

    • param0: {
          itemMetadata: FileMetadata | FolderMetadata;
          parent: string;
          type: "file" | "directory";
          uuid: string;
      }

    Returns Promise<void>

    2/17/2024 - 4:26:44 AM

  • Create a directory under parent.

    Parameters

    • param0: { name: string; parent: string; renameIfExists?: boolean; uuid?: string }

    Returns Promise<string>

  • Permanently delete a directory.

    Parameters

    • param0: { uuid: string }

    Returns Promise<void>

    2/15/2024 - 11:42:13 PM

  • Permanently delete a file.

    Parameters

    • param0: { uuid: string }

    Returns Promise<void>

    2/15/2024 - 11:42:05 PM

  • Fetch contents of a directory public link or it's children.

    Parameters

    • param0: { key: string; parent: string; password?: string; salt?: string; uuid: string }

    Returns Promise<DirLinkContentDecryptedResponse>

  • Fetch directory size in bytes, including file and folder count.

    Parameters

    • param0: { receiverId?: number; sharerId?: number; trash?: boolean; uuid: string }

    Returns Promise<{ files: number; folders: number; size: number }>

    2/20/2024 - 9:21:16 PM

  • Fetch size of a directory inside a public link in bytes, including file and folder count.

    Parameters

    • param0: { linkUUID: string; uuid: string }

    Returns Promise<{ files: number; folders: number; size: number }>

    2/20/2024 - 9:21:53 PM

  • Recursively find the full path of a file using it's UUID.

    Parameters

    • param0: { uuid: string }

    Returns Promise<string>

  • Parameters

    • __namedParameters: { itemUUID: string; type: "directory" }

    Returns Promise<void>

  • Parameters

    • __namedParameters: { itemUUID: string; linkUUID: string; type: "file" }

    Returns Promise<void>

  • Download a directory to path. Only available in a Node.JS environment.

    Parameters

    • param0: {
          abortSignal?: AbortSignal;
          linkHasPassword?: boolean;
          linkKey?: string;
          linkPassword?: string;
          linkSalt?: string;
          linkUUID?: string;
          onError?: (err: Error) => void;
          onFinished?: () => void;
          onProgress?: ProgressCallback;
          onProgressId?: string;
          onQueued?: () => void;
          onStarted?: () => void;
          pauseSignal?: PauseSignal;
          to?: string;
          type?: DirDownloadType;
          uuid: string;
      }

    Returns Promise<string>

  • Download a file to a local path. Only works in a Node.JS environment.

    Parameters

    • param0: {
          abortSignal?: AbortSignal;
          bucket: string;
          chunks: number;
          end?: number;
          key: string;
          onError?: (err: Error) => void;
          onFinished?: () => void;
          onProgress?: ProgressCallback;
          onProgressId?: string;
          onQueued?: () => void;
          onStarted?: () => void;
          pauseSignal?: PauseSignal;
          region: string;
          size: number;
          start?: number;
          to?: string;
          uuid: string;
          version: FileEncryptionVersion;
      }

    Returns Promise<string>

  • Download a file to a ReadableStream.

    Parameters

    • param0: {
          abortSignal?: AbortSignal;
          bucket: string;
          chunks: number;
          end?: number;
          key: string;
          onError?: (err: Error) => void;
          onFinished?: () => void;
          onProgress?: ProgressCallback;
          onProgressId?: string;
          onQueued?: () => void;
          onStarted?: () => void;
          pauseSignal?: PauseSignal;
          region: string;
          size: number;
          start?: number;
          uuid: string;
          version: FileEncryptionVersion;
      }

    Returns ReadableStream<Buffer>

  • Edit directory metadata.

    Parameters

    • param0: { name: string; uuid: string }

    Returns Promise<void>

  • Edit metadata of a file.

    Parameters

    Returns Promise<void>

  • Edit a file/directory public link.

    Parameters

    • param0: {
          enableDownload?: boolean;
          expiration: PublicLinkExpiration;
          itemUUID: string;
          linkUUID?: string;
          password?: string;
          type: "file" | "directory";
      }

    Returns Promise<void>

    2/19/2024 - 4:57:03 AM

  • Enable a public link for a file or a directory.

    Parameters

    Returns Promise<string>

    2/19/2024 - 5:13:57 AM

  • Toggle the favorite status of a directory.

    Parameters

    • param0: { favorite: boolean; uuid: string }

    Returns Promise<void>

    2/15/2024 - 8:54:03 PM

  • Toggle the favorite status of a file.

    Parameters

    • param0: { favorite: boolean; uuid: string }

    Returns Promise<void>

    2/15/2024 - 8:54:23 PM

  • Fetch info of a file public link.

    Parameters

    • param0: { key: string; password?: string; salt?: string; uuid: string }

    Returns Promise<Omit<FileLinkInfoResponse, "size"> & { size: number }>

  • Recursively find the full path of a file using it's UUID.

    Parameters

    • param0: { uuid: string }

    Returns Promise<string>

  • Generate global search item hashes.

    Parameters

    • param0: { name: string; type: "file" | "directory"; uuid: string }

    Returns Promise<SearchAddItem[]>

  • Build a recursive directory tree which includes sub-directories and sub-files.

    Parameters

    • param0: {
          linkHasPassword?: boolean;
          linkKey?: string;
          linkPassword?: string;
          linkSalt?: string;
          linkUUID?: string;
          skipCache?: boolean;
          type?: DirDownloadType;
          uuid: string;
      }

    Returns Promise<Record<string, CloudItemTree>>

    2/22/2024 - 1:45:28 AM

  • Lists all files and directories in a directory.

    Parameters

    • param0: { onlyDirectories?: boolean; uuid: string }

    Returns Promise<CloudItem[]>

    3/14/2024 - 5:21:55 AM

  • List shared in files and directories based on parent.

    Parameters

    • param0: { uuid: string }

    Returns Promise<CloudItemShared[]>

    2/15/2024 - 1:16:49 AM

  • List shared out files and directories based on parent.

    Parameters

    • param0: { receiverId?: number; uuid: string }

    Returns Promise<CloudItemShared[]>

    2/15/2024 - 1:16:32 AM

  • Move a directory.

    Parameters

    • param0: {
          metadata: FolderMetadata;
          overwriteIfExists?: boolean;
          to: string;
          uuid: string;
      }

    Returns Promise<void>

  • Move a file.

    Parameters

    • param0: {
          metadata: FileMetadata;
          overwriteIfExists?: boolean;
          to: string;
          uuid: string;
      }

    Returns Promise<void>

  • Stop receiving a shared item.

    Parameters

    • param0: { uuid: string }

    Returns Promise<void>

    2/19/2024 - 4:38:36 AM

  • Rename a directory.

    Parameters

    • param0: { name: string; overwriteIfExists?: boolean; uuid: string }

    Returns Promise<void>

  • Rename a file.

    Parameters

    • param0: {
          metadata: FileMetadata;
          name: string;
          overwriteIfExists?: boolean;
          uuid: string;
      }

    Returns Promise<void>

  • Restore a directory from the trash.

    Parameters

    • param0: { uuid: string }

    Returns Promise<void>

    2/15/2024 - 11:43:29 PM

  • Restore a file from the trash.

    Parameters

    • param0: { uuid: string }

    Returns Promise<void>

    2/15/2024 - 11:43:21 PM

  • Restore a file version.

    Parameters

    • param0: { currentUUID: string; uuid: string }

    Returns Promise<void>

    2/15/2024 - 11:44:51 PM

  • Share a file or a directory (and all it's children) to a user.

    Parameters

    Returns Promise<void>

    2/19/2024 - 4:35:03 AM

  • Stop sharing an item with another user.

    Parameters

    • param0: { receiverId: number; uuid: string }

    Returns Promise<void>

    2/19/2024 - 4:38:21 AM

  • Send a directory to the trash bin.

    Parameters

    • param0: { uuid: string }

    Returns Promise<void>

    2/15/2024 - 2:07:13 AM

  • Send a file to the trash bin.

    Parameters

    • param0: { uuid: string }

    Returns Promise<void>

    2/15/2024 - 2:07:13 AM

  • Upload a web-based directory, such as from an field. Only works in a browser environment.

    Parameters

    • param0: {
          abortSignal?: AbortSignal;
          files: { file: File; path: string }[];
          name?: string;
          onDirectoryCreated?: (item: CloudItem) => void;
          onError?: (err: Error) => void;
          onFinished?: () => void;
          onProgress?: ProgressCallback;
          onProgressId?: string;
          onQueued?: () => void;
          onStarted?: () => void;
          onUploaded?: (item: CloudItem) => Promise<void>;
          parent: string;
          pauseSignal?: PauseSignal;
          throwOnSingleFileUploadError?: boolean;
      }

    Returns Promise<void>

  • Upload a local directory at path. Only works in a Node.JS environment.

    Parameters

    • param0: {
          abortSignal?: AbortSignal;
          name?: string;
          onDirectoryCreated?: (item: CloudItem) => void;
          onError?: (err: Error) => void;
          onFinished?: () => void;
          onProgress?: ProgressCallback;
          onProgressId?: string;
          onQueued?: () => void;
          onStarted?: () => void;
          onUploaded?: (item: CloudItem) => Promise<void>;
          parent: string;
          pauseSignal?: PauseSignal;
          source: string;
          throwOnSingleFileUploadError?: boolean;
      }

    Returns Promise<void>

  • Upload a local file. Only available in a Node.JS environment.

    Parameters

    • param0: {
          abortSignal?: AbortSignal;
          encryptionKey?: string;
          name?: string;
          onError?: (err: Error) => void;
          onFinished?: () => void;
          onProgress?: ProgressCallback;
          onProgressId?: string;
          onQueued?: () => void;
          onStarted?: () => void;
          onUploaded?: (item: CloudItem) => Promise<void>;
          parent: string;
          pauseSignal?: PauseSignal;
          source: string;
          uuid?: string;
      }

    Returns Promise<CloudItem>

  • Upload a file using Node.JS streams. It's not as fast as the normal uploadFile function since it's not completely multithreaded. Only available in a Node.JS environment.

    Parameters

    • param0: {
          abortSignal?: AbortSignal;
          creation?: number;
          encryptionKey?: string;
          lastModified?: number;
          name: string;
          onError?: (err: Error) => void;
          onFinished?: () => void;
          onProgress?: ProgressCallback;
          onProgressId?: string;
          onQueued?: () => void;
          onStarted?: () => void;
          onUploaded?: (item: CloudItem) => Promise<void>;
          parent: string;
          pauseSignal?: PauseSignal;
          source: Readable | ReadableStream<any>;
      }

    Returns Promise<CloudItem>

  • Upload a web-based file, such as from an field. Only works in a browser environment.

    Parameters

    • param0: {
          abortSignal?: AbortSignal;
          file: File;
          name?: string;
          onError?: (err: Error) => void;
          onFinished?: () => void;
          onProgress?: ProgressCallback;
          onProgressId?: string;
          onQueued?: () => void;
          onStarted?: () => void;
          onUploaded?: (item: CloudItem) => Promise<void>;
          parent: string;
          pauseSignal?: PauseSignal;
          uuid?: string;
      }

    Returns Promise<CloudItem>

MMNEPVFCICPMFPCPTTAAATR