Class SecrecyCloudClient

Constructors

constructor

new SecrecyCloudClient(client, keys, apiClient): SecrecyCloudClient
Parameters
- client: SecrecyClient
- keys: {
  privateKey: string;
  publicKey: string;
  }
  - privateKey: string
  - publicKey: string
- apiClient: DecoratedProcedureRecord<CreateRouterInner<RootConfig<{}>, {}>, {}>
Returns SecrecyCloudClient
- Defined in src/client/SecrecyCloudClient.ts:48

Methods

addDataToHistory

addDataToHistory(__namedParameters): Promise<NodeFull>
Parameters
- __namedParameters: {
  dataId: string;
  nodeId: string;
  }
  - dataId: string
  - nodeId: string
Returns Promise<NodeFull>
- Defined in src/client/SecrecyCloudClient.ts:54

createFolder

createFolder(__namedParameters): Promise<NodeFull>
Parameters
- __namedParameters: {
  name: string;
  parentFolderId?: null | string;
  }
  - name: string
  - OptionalparentFolderId?: null | string
Returns Promise<NodeFull>
- Defined in src/client/SecrecyCloudClient.ts:470

dataContent

dataContent(__namedParameters): Promise<Uint8Array>
Parameters
- __namedParameters: {
      dataId: string;
      onDownloadProgress?: ((progress: DownloadProgress) => void);
      progressDecrypt?: ProgressCallback;
      signal?: AbortSignal;
  }
  - dataId: string
  - OptionalonDownloadProgress?: ((progress: DownloadProgress) => void)
    - (progress): void
      Parameters
      progress: DownloadProgress
      Returns void
  - OptionalprogressDecrypt?: ProgressCallback
  - Optionalsignal?: AbortSignal
Returns Promise<Uint8Array>
- Defined in src/client/SecrecyCloudClient.ts:607

dataMetadata

dataMetadata(__namedParameters): Promise<DataMetadata>
Parameters
- __namedParameters: {
  id: string;
  }
  - id: string
Returns Promise<DataMetadata>
- Defined in src/client/SecrecyCloudClient.ts:526

deleteData

deleteData(__namedParameters): Promise<boolean>
Parameters
- __namedParameters: {
  dataId: string;
  nodeId: string;
  }
  - dataId: string
  - nodeId: string
Returns Promise<boolean>
- Defined in src/client/SecrecyCloudClient.ts:750

deletedNodes

deletedNodes(): Promise<Node<NodeBreadcrumbItem, Record<string, unknown>>[]>
Returns Promise<Node<NodeBreadcrumbItem, Record<string, unknown>>[]>
- Defined in src/client/SecrecyCloudClient.ts:382

deleteNode

deleteNode(__namedParameters): Promise<boolean>
Parameters
- __namedParameters: {
  nodeId: string;
  }
  - nodeId: string
Returns Promise<boolean>
- Defined in src/client/SecrecyCloudClient.ts:765

deleteNodeCloudTrash

deleteNodeCloudTrash(__namedParameters): Promise<boolean>
Parameters
- __namedParameters: {
  ids: string[];
  }
  - ids: string[]
Returns Promise<boolean>
- Defined in src/client/SecrecyCloudClient.ts:461

deleteNodeSharing

deleteNodeSharing(__namedParameters): Promise<boolean>
Parameters
- __namedParameters: {
  nodeId: string;
  userId: string;
  }
  - nodeId: string
  - userId: string
Returns Promise<boolean>
- Defined in src/client/SecrecyCloudClient.ts:412

duplicateNode

duplicateNode(__namedParameters): Promise<boolean>
Parameters
- __namedParameters: {
      folderId?: null | string;
      name?: null | string;
      nodeId: string;
  }
  - OptionalfolderId?: null | string
  - Optionalname?: null | string
  - nodeId: string
Returns Promise<boolean>
- Defined in src/client/SecrecyCloudClient.ts:427

emptyTrash

emptyTrash(): Promise<boolean>
Returns Promise<boolean>
- Defined in src/client/SecrecyCloudClient.ts:773

moveNodes

moveNodes(__namedParameters): Promise<boolean>
Parameters
- __namedParameters: {
  nodeIds: string[];
  parentNodeId?: null | string;
  }
  - nodeIds: string[]
  - OptionalparentNodeId?: null | string
Returns Promise<boolean>
- Defined in src/client/SecrecyCloudClient.ts:787

node

node(__namedParameters?): Promise<NodeFull>
Parameters
- __namedParameters: {
  deleted?: null | boolean;
  id?: null | string;
  } = {}
  - Optionaldeleted?: null | boolean
  - Optionalid?: null | string
Returns Promise<NodeFull>
- Defined in src/client/SecrecyCloudClient.ts:511

nodesSharedWithMe

nodesSharedWithMe(type?): Promise<Node<NodeBreadcrumbItem, Record<string, unknown>>[]>
Parameters
- type: "FILE" | "FOLDER" = 'FOLDER'
Returns Promise<Node<NodeBreadcrumbItem, Record<string, unknown>>[]>
- Defined in src/client/SecrecyCloudClient.ts:400

recoverNode

recoverNode(id): Promise<boolean>
Parameters
- id: string
Returns Promise<boolean>
- Defined in src/client/SecrecyCloudClient.ts:779

saveInCloud

saveInCloud(__namedParameters): Promise<NodeFull>
Parameters
- __namedParameters: {
      dataId: string;
      name: string;
      nodeId?: string;
  }
  - dataId: string
  - name: string
  - OptionalnodeId?: string
Returns Promise<NodeFull>
- Defined in src/client/SecrecyCloudClient.ts:802

sharedNodes

sharedNodes(): Promise<Node<NodeBreadcrumbItem, Record<string, unknown>>[]>
Returns Promise<Node<NodeBreadcrumbItem, Record<string, unknown>>[]>
- Defined in src/client/SecrecyCloudClient.ts:391

shareNode

shareNode(__namedParameters): Promise<boolean>
Parameters
- __namedParameters: {
      nodeId: string;
      rights: "admin" | "write" | "read";
      userId: string;
  }
  - nodeId: string
  - rights: "admin" | "write" | "read"
  - userId: string
Returns Promise<boolean>
- Defined in src/client/SecrecyCloudClient.ts:534

updateNode

updateNode(__namedParameters): Promise<NodeFull>
Parameters
- __namedParameters: {
      deletedAt?: null | Date;
      isFavorite?: null | boolean;
      name?: null | string;
      nodeId: string;
  }
  - OptionaldeletedAt?: null | Date
  - OptionalisFavorite?: null | boolean
  - Optionalname?: null | string
  - nodeId: string
Returns Promise<NodeFull>
- Defined in src/client/SecrecyCloudClient.ts:568

uploadData

uploadData(__namedParameters): Promise<string>
Parameters
- __namedParameters: {
      data: Uint8Array | File;
      encrypted?: boolean;
      encryptProgress?: ProgressCallback;
      signal?: AbortSignal;
      uploadProgress?: ProgressCallback;
  }
  - data: Uint8Array | File
  - Optionalencrypted?: boolean
  - OptionalencryptProgress?: ProgressCallback
  - Optionalsignal?: AbortSignal
  - OptionaluploadProgress?: ProgressCallback
Returns Promise<string>
- Defined in src/client/SecrecyCloudClient.ts:171

uploadDataInCloud

uploadDataInCloud(__namedParameters): Promise<NodeFull>
Parameters
- __namedParameters: {
      data: Uint8Array | File;
      encryptProgress?: ProgressCallback;
      isLite?: boolean;
      name: string;
      nodeId?: string;
      signal?: AbortSignal;
      uploadProgress?: ProgressCallback;
  }
  - data: Uint8Array | File
  - OptionalencryptProgress?: ProgressCallback
  - OptionalisLite?: boolean
  - name: string
  - OptionalnodeId?: string
  - Optionalsignal?: AbortSignal
  - OptionaluploadProgress?: ProgressCallback
Returns Promise<NodeFull>
- Defined in src/client/SecrecyCloudClient.ts:344

uploadLiteData

uploadLiteData(__namedParameters): Promise<string>
Parameters
- __namedParameters: {
      data: Uint8Array | File;
      encrypted?: boolean;
      encryptProgress?: ProgressCallback;
      signal?: AbortSignal;
      uploadProgress?: ProgressCallback;
  }
  - data: Uint8Array | File
  - Optionalencrypted?: boolean
  - OptionalencryptProgress?: ProgressCallback
  - Optionalsignal?: AbortSignal
  - OptionaluploadProgress?: ProgressCallback
Returns Promise<string>
- Defined in src/client/SecrecyCloudClient.ts:98

Class SecrecyCloudClient

Index

Constructors

Methods

Constructors

constructor

Parameters

privateKey: string

publicKey: string

Returns SecrecyCloudClient

Methods

addDataToHistory

Parameters

dataId: string

nodeId: string

Returns Promise<NodeFull>

createFolder

Parameters

name: string

OptionalparentFolderId?: null | string

Returns Promise<NodeFull>

dataContent

Parameters

dataId: string

OptionalonDownloadProgress?: ((progress: DownloadProgress) => void)

Parameters

Returns void

OptionalprogressDecrypt?: ProgressCallback

Optionalsignal?: AbortSignal

Returns Promise<Uint8Array>

dataMetadata

Parameters

id: string

Returns Promise<DataMetadata>

deleteData

Parameters

dataId: string

nodeId: string

Returns Promise<boolean>

deletedNodes

Returns Promise<Node<NodeBreadcrumbItem, Record<string, unknown>>[]>

deleteNode

Parameters

nodeId: string

Returns Promise<boolean>

deleteNodeCloudTrash

Parameters

ids: string[]

Returns Promise<boolean>

deleteNodeSharing

Parameters

nodeId: string

userId: string

Returns Promise<boolean>

duplicateNode

Parameters

OptionalfolderId?: null | string

Optionalname?: null | string

nodeId: string

Returns Promise<boolean>

emptyTrash

Returns Promise<boolean>

moveNodes

Parameters

nodeIds: string[]

OptionalparentNodeId?: null | string

Returns Promise<boolean>

node

Parameters

Optionaldeleted?: null | boolean

Optionalid?: null | string

Returns Promise<NodeFull>

nodesSharedWithMe

Parameters

Returns Promise<Node<NodeBreadcrumbItem, Record<string, unknown>>[]>

recoverNode

Parameters

Returns Promise<boolean>

saveInCloud

Parameters

`Optional`parentFolderId?: null | string

`Optional`onDownloadProgress?: ((progress: DownloadProgress) => void)

`Optional`progressDecrypt?: ProgressCallback

`Optional`signal?: AbortSignal

`Optional`folderId?: null | string

`Optional`name?: null | string

`Optional`parentNodeId?: null | string

`Optional`deleted?: null | boolean

`Optional`id?: null | string

`Optional`nodeId?: string

`Optional`deletedAt?: null | Date

`Optional`isFavorite?: null | boolean

`Optional`name?: null | string

`Optional`encrypted?: boolean

`Optional`encryptProgress?: ProgressCallback

`Optional`signal?: AbortSignal

`Optional`uploadProgress?: ProgressCallback

`Optional`encryptProgress?: ProgressCallback

`Optional`isLite?: boolean

`Optional`nodeId?: string

`Optional`signal?: AbortSignal

`Optional`uploadProgress?: ProgressCallback

`Optional`encrypted?: boolean

`Optional`encryptProgress?: ProgressCallback

`Optional`signal?: AbortSignal

`Optional`uploadProgress?: ProgressCallback