Class Cloud

Cloud

Date

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

Export

Cloud

Index

Constructors

constructor

new Cloud(sdk: FilenSDK): Cloud
Parameters
- sdk: FilenSDK
Returns Cloud
- Defined in src/cloud/index.ts:183

Properties

`Readonly`utils

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

changeDirectoryColor

changeDirectoryColor(param0: { color: string; uuid: string }): Promise<void>
Change the color of a directory.
Parameters
- param0: { color: string; uuid: string }
Returns Promise<void>
Date
2/15/2024 - 8:52:40 PM

Async
- Defined in src/cloud/index.ts:1613

checkIfItemIsSharedForRename

checkIfItemIsSharedForRename(
param0: { itemMetadata: FileMetadata | FolderMetadata; uuid: string },
): Promise<void>
Checks if an item is shared or public linked. If so, it renames the item.
Parameters
- param0: { itemMetadata: FileMetadata | FolderMetadata; uuid: string }
Returns Promise<void>
Date
2/17/2024 - 4:37:30 AM

Async
- Defined in src/cloud/index.ts:3068

checkIfItemParentIsShared

checkIfItemParentIsShared(
    param0: {
        itemMetadata: FileMetadata | FolderMetadata;
        parent: string;
        type: "file" | "directory";
        uuid: string;
    },
): Promise<void>
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>
Date
2/17/2024 - 4:26:44 AM

Async
- Defined in src/cloud/index.ts:2703

createDirectory

createDirectory(
    param0: {
        name: string;
        parent: string;
        renameIfExists?: boolean;
        uuid?: string;
    },
): Promise<string>
Create a directory under parent.
Parameters
- param0: { name: string; parent: string; renameIfExists?: boolean; uuid?: string }
Returns Promise<string>
Async
- Defined in src/cloud/index.ts:1517

deleteDirectory

deleteDirectory(param0: { uuid: string }): Promise<void>
Permanently delete a directory.
Parameters
- param0: { uuid: string }
Returns Promise<void>
Date
2/15/2024 - 11:42:13 PM

Async
- Defined in src/cloud/index.ts:1690

deleteFile

deleteFile(param0: { uuid: string }): Promise<void>
Permanently delete a file.
Parameters
- param0: { uuid: string }
Returns Promise<void>
Date
2/15/2024 - 11:42:05 PM

Async
- Defined in src/cloud/index.ts:1668

directoryExists

directoryExists(
param0: { name: string; parent: string },
): Promise<DirExistsResponse>
Check if a directory with exists in parent.
Parameters
- param0: { name: string; parent: string }
Returns Promise<DirExistsResponse>
Async
- Defined in src/cloud/index.ts:890

directoryPublicLinkContent

directoryPublicLinkContent(
    param0: {
        key: string;
        parent: string;
        password?: string;
        salt?: string;
        uuid: string;
    },
): Promise<DirLinkContentDecryptedResponse>
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>
Async
- Defined in src/cloud/index.ts:2368

directoryPublicLinkInfo

directoryPublicLinkInfo(
param0: { key: string; uuid: string },
): Promise<DirLinkInfoDecryptedResponse>
Fetch info about a directory public link.
Parameters
- param0: { key: string; uuid: string }
Returns Promise<DirLinkInfoDecryptedResponse>
Async
- Defined in src/cloud/index.ts:2327

directorySize

directorySize(
    param0: {
        receiverId?: number;
        sharerId?: number;
        trash?: boolean;
        uuid: string;
    },
): Promise<{ files: number; folders: number; size: number }>
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 }>
Date
2/20/2024 - 9:21:16 PM

Async
- Defined in src/cloud/index.ts:3140

directorySizePublicLink

directorySizePublicLink(
param0: { linkUUID: string; uuid: string },
): Promise<{ files: number; folders: number; size: number }>
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 }>
Date
2/20/2024 - 9:21:53 PM

Async
- Defined in src/cloud/index.ts:3170

directoryUUIDToPath

directoryUUIDToPath(param0: { uuid: string }): Promise<string>
Recursively find the full path of a file using it's UUID.
Parameters
- param0: { uuid: string }
Returns Promise<string>
Async
- Defined in src/cloud/index.ts:5613

disablePublicLink

disablePublicLink(
__namedParameters: { itemUUID: string; type: "directory" },
): Promise<void>
Parameters
- __namedParameters: { itemUUID: string; type: "directory" }
Returns Promise<void>
- Defined in src/cloud/index.ts:2117
disablePublicLink(
__namedParameters: { itemUUID: string; linkUUID: string; type: "file" },
): Promise<void>
Parameters
- __namedParameters: { itemUUID: string; linkUUID: string; type: "file" }
Returns Promise<void>
- Defined in src/cloud/index.ts:2118

downloadDirectoryToLocal

downloadDirectoryToLocal(
    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;
    },
): Promise<string>
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>
Async
- Defined in src/cloud/index.ts:3997

downloadFileToLocal

downloadFileToLocal(
    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;
    },
): 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>
Async
- Defined in src/cloud/index.ts:3228

downloadFileToReadableStream

downloadFileToReadableStream(
    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;
    },
): ReadableStream<Buffer>
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>
- Defined in src/cloud/index.ts:3379

editDirectoryMetadata

editDirectoryMetadata(param0: { name: string; uuid: string }): Promise<void>
Edit directory metadata.
Parameters
- param0: { name: string; uuid: string }
Returns Promise<void>
Async
- Defined in src/cloud/index.ts:1011

editFileMetadata

editFileMetadata(
param0: { metadata: FileMetadata; uuid: string },
): Promise<void>
Edit metadata of a file.
Parameters
- param0: { metadata: FileMetadata; uuid: string }
Returns Promise<void>
Async
- Defined in src/cloud/index.ts:921

editPublicLink

editPublicLink(
    param0: {
        enableDownload?: boolean;
        expiration: PublicLinkExpiration;
        itemUUID: string;
        linkUUID?: string;
        password?: string;
        type: "file" | "directory";
    },
): 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>
Date
2/19/2024 - 4:57:03 AM

Async
- Defined in src/cloud/index.ts:2067

emptyTrash

emptyTrash(): Promise<void>
Empty the trash.

Returns Promise<void>
Async
- Defined in src/cloud/index.ts:5553

enablePublicLink

enablePublicLink(
    param0: {
        onProgress?: ProgressWithTotalCallback;
        type: "file" | "directory";
        uuid: string;
    },
): Promise<string>
Enable a public link for a file or a directory.
Parameters
- param0: {
      onProgress?: ProgressWithTotalCallback;
      type: "file" | "directory";
      uuid: string;
  }
Returns Promise<string>
Date
2/19/2024 - 5:13:57 AM

Async
- Defined in src/cloud/index.ts:1942

favoriteDirectory

favoriteDirectory(param0: { favorite: boolean; uuid: string }): Promise<void>
Toggle the favorite status of a directory.
Parameters
- param0: { favorite: boolean; uuid: string }
Returns Promise<void>
Date
2/15/2024 - 8:54:03 PM

Async
- Defined in src/cloud/index.ts:1631

favoriteFile

favoriteFile(param0: { favorite: boolean; uuid: string }): Promise<void>
Toggle the favorite status of a file.
Parameters
- param0: { favorite: boolean; uuid: string }
Returns Promise<void>
Date
2/15/2024 - 8:54:23 PM

Async
- Defined in src/cloud/index.ts:1650

fileExists

fileExists(
param0: { name: string; parent: string },
): Promise<FileExistsResponse>
Check if a file with exists in parent.
Parameters
- param0: { name: string; parent: string }
Returns Promise<FileExistsResponse>
Async
- Defined in src/cloud/index.ts:859

filePublicLinkHasPassword

filePublicLinkHasPassword(
param0: { uuid: string },
): Promise<FileLinkPasswordResponse>
Fetch password info of a public link.
Parameters
- param0: { uuid: string }
Returns Promise<FileLinkPasswordResponse>
Async
- Defined in src/cloud/index.ts:2215

filePublicLinkInfo

filePublicLinkInfo(
param0: { key: string; password?: string; salt?: string; uuid: string },
): Promise<Omit<FileLinkInfoResponse, "size"> & { size: number }>
Fetch info of a file public link.
Parameters
- param0: { key: string; password?: string; salt?: string; uuid: string }
Returns Promise<Omit<FileLinkInfoResponse, "size"> & { size: number }>
Async
- Defined in src/cloud/index.ts:2238

fileUUIDToPath

fileUUIDToPath(param0: { uuid: string }): Promise<string>
Recursively find the full path of a file using it's UUID.
Parameters
- param0: { uuid: string }
Returns Promise<string>
Async
- Defined in src/cloud/index.ts:5566

fileVersions

fileVersions(param0: { uuid: string }): Promise<FileVersionsResponse>
Retrieve all versions of a file.
Parameters
- param0: { uuid: string }
Returns Promise<FileVersionsResponse>
Date
2/15/2024 - 11:46:38 PM

Async
- Defined in src/cloud/index.ts:1792

generateSearchItems

generateSearchItems(
param0: { name: string; type: "file" | "directory"; uuid: string },
): Promise<SearchAddItem[]>
Generate global search item hashes.
Parameters
- param0: { name: string; type: "file" | "directory"; uuid: string }
Returns Promise<SearchAddItem[]>
Async
- Defined in src/cloud/index.ts:5727

getDirectory

getDirectory(param0: { uuid: string }): Promise<GetDirResult>
Get info about a directory and decrypt its metadata.
Parameters
- param0: { uuid: string }
Returns Promise<GetDirResult>
Async
- Defined in src/cloud/index.ts:5691

getDirectoryTree

getDirectoryTree(
    param0: {
        linkHasPassword?: boolean;
        linkKey?: string;
        linkPassword?: string;
        linkSalt?: string;
        linkUUID?: string;
        skipCache?: boolean;
        type?: DirDownloadType;
        uuid: string;
    },
): Promise<Record<string, CloudItemTree>>
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>>
Date
2/22/2024 - 1:45:28 AM

Async
- Defined in src/cloud/index.ts:3804

getFile

getFile(param0: { uuid: string }): Promise<GetFileResult>
Get info about a file and decrypt its metadata.
Parameters
- param0: { uuid: string }
Returns Promise<GetFileResult>
Async
- Defined in src/cloud/index.ts:5660

listDirectory

listDirectory(
param0: { onlyDirectories?: boolean; uuid: string },
): Promise<CloudItem[]>
Lists all files and directories in a directory.
Parameters
- param0: { onlyDirectories?: boolean; uuid: string }
Returns Promise<CloudItem[]>
Date
3/14/2024 - 5:21:55 AM

Async
- Defined in src/cloud/index.ts:205

listDirectorySharedIn

listDirectorySharedIn(param0: { uuid: string }): Promise<CloudItemShared[]>
List shared in files and directories based on parent.
Parameters
- param0: { uuid: string }
Returns Promise<CloudItemShared[]>
Date
2/15/2024 - 1:16:49 AM

Async
- Defined in src/cloud/index.ts:298

listDirectorySharedOut

listDirectorySharedOut(
param0: { receiverId?: number; uuid: string },
): Promise<CloudItemShared[]>
List shared out files and directories based on parent.
Parameters
- param0: { receiverId?: number; uuid: string }
Returns Promise<CloudItemShared[]>
Date
2/15/2024 - 1:16:32 AM

Async
- Defined in src/cloud/index.ts:398

listFavorites

listFavorites(): Promise<CloudItem[]>
List all favorite files and directories.

Returns Promise<CloudItem[]>
Date
2/15/2024 - 8:59:52 PM

Async
- Defined in src/cloud/index.ts:678

listPublicLinks

listPublicLinks(): Promise<CloudItem[]>
List all public linked files and directories.

Returns Promise<CloudItem[]>
Date
2/15/2024 - 9:01:01 PM

Async
- Defined in src/cloud/index.ts:767

listRecents

listRecents(): Promise<CloudItem[]>
List all recently uploaded files.

Returns Promise<CloudItem[]>
Date
2/15/2024 - 1:16:20 AM

Async
- Defined in src/cloud/index.ts:528

listTrash

listTrash(): Promise<CloudItem[]>
List all files and directories inside the trash.

Returns Promise<CloudItem[]>
Date
2/15/2024 - 8:59:04 PM

Async
- Defined in src/cloud/index.ts:588

moveDirectory

moveDirectory(
    param0: {
        metadata: FolderMetadata;
        overwriteIfExists?: boolean;
        to: string;
        uuid: string;
    },
): Promise<void>
Move a directory.
Parameters
- param0: {
      metadata: FolderMetadata;
      overwriteIfExists?: boolean;
      to: string;
      uuid: string;
  }
Returns Promise<void>
Async
- Defined in src/cloud/index.ts:1409

moveFile

moveFile(
    param0: {
        metadata: FileMetadata;
        overwriteIfExists?: boolean;
        to: string;
        uuid: string;
    },
): Promise<void>
Move a file.
Parameters
- param0: {
      metadata: FileMetadata;
      overwriteIfExists?: boolean;
      to: string;
      uuid: string;
  }
Returns Promise<void>
Async
- Defined in src/cloud/index.ts:1345

publicLinkStatus

publicLinkStatus(
__namedParameters: { type: "file"; uuid: string },
): Promise<FileLinkStatusResponse>
Parameters
- __namedParameters: { type: "file"; uuid: string }
Returns Promise<FileLinkStatusResponse>
- Defined in src/cloud/index.ts:2175
publicLinkStatus(
__namedParameters: { type: "directory"; uuid: string },
): Promise<DirLinkStatusResponse>
Parameters
- __namedParameters: { type: "directory"; uuid: string }
Returns Promise<DirLinkStatusResponse>
- Defined in src/cloud/index.ts:2176

queryGlobalSearch

queryGlobalSearch(input: string): Promise<SearchFindItemDecrypted[]>
Query the global search database.
Parameters
- input: string
Returns Promise<SearchFindItemDecrypted[]>
Async
- Defined in src/cloud/index.ts:5756

rebuildGlobalSearchIndex

rebuildGlobalSearchIndex(
    params?: {
        onProgress?: RebuildGlobalSearchIndexProgressCallback;
        onProgressId?: string;
    },
): Promise<void>
Completely rebuild the global search index. Can be expensive when the user stores a lot of items!
Parameters
- Optionalparams: { onProgress?: RebuildGlobalSearchIndexProgressCallback; onProgressId?: string }
Returns Promise<void>
Async
- Defined in src/cloud/index.ts:5847

removeSharedItem

removeSharedItem(param0: { uuid: string }): Promise<void>
Stop receiving a shared item.
Parameters
- param0: { uuid: string }
Returns Promise<void>
Date
2/19/2024 - 4:38:36 AM

Async
- Defined in src/cloud/index.ts:2509

renameDirectory

renameDirectory(
param0: { name: string; overwriteIfExists?: boolean; uuid: string },
): Promise<void>
Rename a directory.
Parameters
- param0: { name: string; overwriteIfExists?: boolean; uuid: string }
Returns Promise<void>
Async
- Defined in src/cloud/index.ts:1229

renameFile

renameFile(
    param0: {
        metadata: FileMetadata;
        name: string;
        overwriteIfExists?: boolean;
        uuid: string;
    },
): Promise<void>
Rename a file.
Parameters
- param0: {
      metadata: FileMetadata;
      name: string;
      overwriteIfExists?: boolean;
      uuid: string;
  }
Returns Promise<void>
Async
- Defined in src/cloud/index.ts:1105

restoreDirectory

restoreDirectory(param0: { uuid: string }): Promise<void>
Restore a directory from the trash.
Parameters
- param0: { uuid: string }
Returns Promise<void>
Date
2/15/2024 - 11:43:29 PM

Async
- Defined in src/cloud/index.ts:1734

restoreFile

restoreFile(param0: { uuid: string }): Promise<void>
Restore a file from the trash.
Parameters
- param0: { uuid: string }
Returns Promise<void>
Date
2/15/2024 - 11:43:21 PM

Async
- Defined in src/cloud/index.ts:1712

restoreFileVersion

restoreFileVersion(param0: { currentUUID: string; uuid: string }): Promise<void>
Restore a file version.
Parameters
- param0: { currentUUID: string; uuid: string }
Returns Promise<void>
Date
2/15/2024 - 11:44:51 PM

Async
- Defined in src/cloud/index.ts:1757

shareItemsToUser

shareItemsToUser(
    param0: {
        directories: { metadata: FolderMetadata; parent: string; uuid: string }[];
        email: string;
        files: { metadata: FileMetadata; parent: string; uuid: string }[];
        onProgress?: ProgressWithTotalCallback;
    },
): Promise<void>
Share a file or a directory (and all it's children) to a user.
Parameters
- param0: {
      directories: { metadata: FolderMetadata; parent: string; uuid: string }[];
      email: string;
      files: { metadata: FileMetadata; parent: string; uuid: string }[];
      onProgress?: ProgressWithTotalCallback;
  }
Returns Promise<void>
Date
2/19/2024 - 4:35:03 AM

Async
- Defined in src/cloud/index.ts:2533

stopSharingItem

stopSharingItem(param0: { receiverId: number; uuid: string }): Promise<void>
Stop sharing an item with another user.
Parameters
- param0: { receiverId: number; uuid: string }
Returns Promise<void>
Date
2/19/2024 - 4:38:21 AM

Async
- Defined in src/cloud/index.ts:2492

trashDirectory

trashDirectory(param0: { uuid: string }): Promise<void>
Send a directory to the trash bin.
Parameters
- param0: { uuid: string }
Returns Promise<void>
Date
2/15/2024 - 2:07:13 AM

Async
- Defined in src/cloud/index.ts:1488

trashFile

trashFile(param0: { uuid: string }): Promise<void>
Send a file to the trash bin.
Parameters
- param0: { uuid: string }
Returns Promise<void>
Date
2/15/2024 - 2:07:13 AM

Async
- Defined in src/cloud/index.ts:1466

uploadDirectoryFromWeb

uploadDirectoryFromWeb(
    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;
    },
): Promise<void>
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>
Async
- Defined in src/cloud/index.ts:5365

uploadLocalDirectory

uploadLocalDirectory(
    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;
    },
): 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>
Async
- Defined in src/cloud/index.ts:5118

uploadLocalFile

uploadLocalFile(
    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;
    },
): Promise<CloudItem>
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>
Async
- Defined in src/cloud/index.ts:4174

uploadLocalFileStream

uploadLocalFileStream(
    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>;
    },
): 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>
Async
- Defined in src/cloud/index.ts:4542

uploadWebFile

uploadWebFile(
    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;
    },
): 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>
Async
- Defined in src/cloud/index.ts:4778

Class Cloud

Date

Export

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Cloud

Properties

Readonlyutils

Methods

changeDirectoryColor

Parameters

Returns Promise<void>

Date

Async

checkIfItemIsSharedForRename

Parameters

Returns Promise<void>

Date

Async

checkIfItemParentIsShared

Parameters

Returns Promise<void>

Date

Async

createDirectory

Parameters

Returns Promise<string>

Async

deleteDirectory

Parameters

Returns Promise<void>

Date

Async

deleteFile

Parameters

Returns Promise<void>

Date

Async

directoryExists

Parameters

Returns Promise<DirExistsResponse>

Async

directoryPublicLinkContent

Parameters

Returns Promise<DirLinkContentDecryptedResponse>

Async

directoryPublicLinkInfo

Parameters

Returns Promise<DirLinkInfoDecryptedResponse>

Async

directorySize

Parameters

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

Date

Async

directorySizePublicLink

Parameters

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

Date

Async

directoryUUIDToPath

Parameters

Returns Promise<string>

Async

disablePublicLink

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

downloadDirectoryToLocal

Parameters

Returns Promise<string>

Async

downloadFileToLocal

Parameters

`Readonly`utils