Skip to main content

FiletreeHelper

atlas.js v0.2.0

atlas.js / FiletreeHelper

Class: FiletreeHelper

Defined in: src/filetree-helper.ts:12

Constructors​

Constructor​

new FiletreeHelper(client): FiletreeHelper

Defined in: src/filetree-helper.ts:16

Parameters​

client​

AtlasClient

Returns​

FiletreeHelper

Properties​

accessKey?​

protected optional accessKey?: PrivateKey

Defined in: src/filetree-helper.ts:14

client​

protected client: AtlasClient

Defined in: src/filetree-helper.ts:13

Methods​

createDirectory()​

createDirectory(): Promise<EncodeObject>

Defined in: src/filetree-helper.ts:107

Returns​

Promise<EncodeObject>

createDrive()​

createDrive(metadata, encryption?): Promise<EncodeObject>

Defined in: src/filetree-helper.ts:56

Create a top-level drive node for the active account.

Parameters​

metadata​

IAtlasDriveInfo

encryption?​

EncryptionType = EncryptionType.ENCRYPTED

Returns​

Promise<EncodeObject>

createFile()​

createFile(file, dir): Promise<EncodeObject>

Defined in: src/filetree-helper.ts:87

Parameters​

file​

IQueuedFile

dir​

string

Returns​

Promise<EncodeObject>

extractAesKey()​

extractAesKey(permissions): Promise<IAesBundle>

Defined in: src/filetree-helper.ts:153

Decrypt the AES bundle granted to the connected wallet.

Parameters​

permissions​

string

Returns​

Promise<IAesBundle>

getTreeNode()​

getTreeNode(path, owner?): Promise<TreeNode>

Defined in: src/filetree-helper.ts:40

Parameters​

path​

string

owner?​

string = ...

Returns​

Promise<TreeNode>

getTreeNodeChildren()​

getTreeNodeChildren(path, owner?): Promise<TreeNode[]>

Defined in: src/filetree-helper.ts:25

Parameters​

path​

string

owner?​

string = ...

Returns​

Promise<TreeNode[]>

incrementDirectoryItemCount()​

incrementDirectoryItemCount(path, delta): Promise<EncodeObject>

Defined in: src/filetree-helper.ts:114

Build a replacement directory node with an adjusted child item count.

Parameters​

path​

string

delta​

number

Returns​

Promise<EncodeObject>

setAccessKey()​

setAccessKey(accessKey): Promise<void>

Defined in: src/filetree-helper.ts:20

Parameters​

accessKey​

PrivateKey

Returns​

Promise<void>