@secrecy/lib
Preparing search index...
<internal>
SecrecyCloudClient
Class SecrecyCloudClient
Index
Constructors
constructor
Methods
add
Data
To
History
check
Accesses
create
Folder
create
Public
Data
Link
data
Content
data
Contents
data
Metadata
delete
Data
deleted
Nodes
delete
Node
delete
Node
Cloud
Trash
delete
Nodes
delete
Node
Sharing
delete
Public
Data
Link
download
Data
From
Link
duplicate
Node
empty
Trash
get
Public
Data
Link
get
Public
Data
Links
leave
Node
Sharing
move
Nodes
node
node
Full
nodes
nodes
Full
nodes
Shared
With
Me
recover
Node
report
Data
save
In
Cloud
shared
Nodes
share
Node
update
Data
Storage
Type
update
Node
update
Public
Data
Link
upload
Data
upload
Data
In
Cloud
Constructors
constructor
new
SecrecyCloudClient
(
client
:
SecrecyClient
)
:
SecrecyCloudClient
Parameters
client
:
SecrecyClient
Returns
SecrecyCloudClient
Methods
add
Data
To
History
addDataToHistory
(
__namedParameters
:
{
dataId
:
string
;
nodeId
:
string
}
,
)
:
Promise
<
NodeFull
>
Parameters
__namedParameters
:
{
dataId
:
string
;
nodeId
:
string
}
Returns
Promise
<
NodeFull
>
check
Accesses
checkAccesses
(
input
:
Omit
<
RouterInputs
[
"cloud"
]
[
"checkAccesses"
]
,
"fromIdentityPubKey"
,
>
,
)
:
Promise
<
{}
|
{}
>
Parameters
input
:
Omit
<
RouterInputs
[
"cloud"
]
[
"checkAccesses"
]
,
"fromIdentityPubKey"
>
Returns
Promise
<
{}
|
{}
>
create
Folder
createFolder
(
__namedParameters
:
{
name
:
string
;
parentFolderId
?:
string
|
null
}
,
)
:
Promise
<
NodeFull
>
Parameters
__namedParameters
:
{
name
:
string
;
parentFolderId
?:
string
|
null
}
Returns
Promise
<
NodeFull
>
create
Public
Data
Link
createPublicDataLink
(
input
:
{}
&
{}
)
:
Promise
<
{}
>
Parameters
input
:
{}
&
{}
Returns
Promise
<
{}
>
data
Content
dataContent
(
__namedParameters
:
{
dataId
:
string
;
onDownloadProgress
?:
(
progress
:
Progress
)
=>
void
;
progressDecrypt
?:
ProgressCallback
;
signal
?:
AbortSignal
;
}
,
)
:
Promise
<
LocalData
>
Parameters
__namedParameters
:
{
dataId
:
string
;
onDownloadProgress
?:
(
progress
:
Progress
)
=>
void
;
progressDecrypt
?:
ProgressCallback
;
signal
?:
AbortSignal
;
}
Returns
Promise
<
LocalData
>
data
Contents
dataContents
(
__namedParameters
:
{
dataIds
:
string
[]
;
onDownloadProgress
?:
(
progress
:
Progress
)
=>
void
;
progressDecrypt
?:
ProgressCallback
;
signal
?:
AbortSignal
;
}
,
)
:
Promise
<
LocalData
[]
>
Parameters
__namedParameters
:
{
dataIds
:
string
[]
;
onDownloadProgress
?:
(
progress
:
Progress
)
=>
void
;
progressDecrypt
?:
ProgressCallback
;
signal
?:
AbortSignal
;
}
Returns
Promise
<
LocalData
[]
>
data
Metadata
dataMetadata
(
__namedParameters
:
{
id
:
string
}
)
:
Promise
<
DataMetadata
>
Parameters
__namedParameters
:
{
id
:
string
}
Returns
Promise
<
DataMetadata
>
delete
Data
deleteData
(
__namedParameters
:
{
dataId
:
string
;
nodeId
:
string
}
,
)
:
Promise
<
boolean
>
Parameters
__namedParameters
:
{
dataId
:
string
;
nodeId
:
string
}
Returns
Promise
<
boolean
>
deleted
Nodes
deletedNodes
()
:
Promise
<
Node
<
NodeBreadcrumbItem
,
Record
<
string
,
unknown
>
>
[]
>
Returns
Promise
<
Node
<
NodeBreadcrumbItem
,
Record
<
string
,
unknown
>
>
[]
>
delete
Node
deleteNode
(
__namedParameters
:
{
nodeId
:
string
}
)
:
Promise
<
boolean
>
Parameters
__namedParameters
:
{
nodeId
:
string
}
Returns
Promise
<
boolean
>
delete
Node
Cloud
Trash
deleteNodeCloudTrash
(
__namedParameters
:
{
ids
:
string
[]
}
)
:
Promise
<
boolean
>
Parameters
__namedParameters
:
{
ids
:
string
[]
}
Returns
Promise
<
boolean
>
delete
Nodes
deleteNodes
(
__namedParameters
:
{
nodeIds
:
string
[]
}
,
)
:
Promise
<
{
count
:
number
}
>
Parameters
__namedParameters
:
{
nodeIds
:
string
[]
}
Returns
Promise
<
{
count
:
number
}
>
delete
Node
Sharing
deleteNodeSharing
(
__namedParameters
:
{
destPubKey
:
string
;
nodeId
:
string
}
,
)
:
Promise
<
boolean
>
Parameters
__namedParameters
:
{
destPubKey
:
string
;
nodeId
:
string
}
Returns
Promise
<
boolean
>
delete
Public
Data
Link
deletePublicDataLink
(
input
:
{}
)
:
Promise
<
{}
>
Parameters
input
:
{}
Returns
Promise
<
{}
>
download
Data
From
Link
downloadDataFromLink
(
input
:
DownloadDataFromLinkOptions
,
)
:
Promise
<
Uint8Array
<
ArrayBuffer
>
>
Parameters
input
:
DownloadDataFromLinkOptions
Returns
Promise
<
Uint8Array
<
ArrayBuffer
>
>
duplicate
Node
duplicateNode
(
__namedParameters
:
{
folderId
?:
string
|
null
;
name
?:
string
|
null
;
nodeId
:
string
;
}
,
)
:
Promise
<
boolean
>
Parameters
__namedParameters
:
{
folderId
?:
string
|
null
;
name
?:
string
|
null
;
nodeId
:
string
}
Returns
Promise
<
boolean
>
empty
Trash
emptyTrash
()
:
Promise
<
boolean
>
Returns
Promise
<
boolean
>
get
Public
Data
Link
getPublicDataLink
(
input
:
{}
)
:
Promise
<
{}
>
Parameters
input
:
{}
Returns
Promise
<
{}
>
get
Public
Data
Links
getPublicDataLinks
(
input
:
{}
)
:
Promise
<
{}
[]
>
Parameters
input
:
{}
Returns
Promise
<
{}
[]
>
leave
Node
Sharing
leaveNodeSharing
(
__namedParameters
:
{
nodeId
:
string
;
sharedByPubKey
:
string
}
,
)
:
Promise
<
boolean
>
Parameters
__namedParameters
:
{
nodeId
:
string
;
sharedByPubKey
:
string
}
Returns
Promise
<
boolean
>
move
Nodes
moveNodes
(
__namedParameters
:
{
nodeIds
:
string
[]
;
parentNodeId
?:
string
|
null
}
,
)
:
Promise
<
boolean
>
Parameters
__namedParameters
:
{
nodeIds
:
string
[]
;
parentNodeId
?:
string
|
null
}
Returns
Promise
<
boolean
>
node
node
(
__namedParameters
?:
{
deleted
?:
boolean
|
null
;
id
?:
string
|
null
}
,
)
:
Promise
<
Node
<
NodeBreadcrumbItem
,
Record
<
string
,
unknown
>
>
>
Parameters
__namedParameters
:
{
deleted
?:
boolean
|
null
;
id
?:
string
|
null
}
= {}
Returns
Promise
<
Node
<
NodeBreadcrumbItem
,
Record
<
string
,
unknown
>
>
>
node
Full
nodeFull
(
__namedParameters
?:
{
deleted
?:
boolean
|
null
;
id
?:
string
|
null
}
,
)
:
Promise
<
NodeFull
>
Parameters
__namedParameters
:
{
deleted
?:
boolean
|
null
;
id
?:
string
|
null
}
= {}
Returns
Promise
<
NodeFull
>
nodes
nodes
(
__namedParameters
:
{
deleted
?:
boolean
|
null
;
ids
:
string
[]
}
,
)
:
Promise
<
{
errors
:
{
message
:
string
;
nodeId
:
string
}
[]
;
nodes
:
Node
<
NodeBreadcrumbItem
,
Record
<
string
,
unknown
>
>
[]
;
}
,
>
Parameters
__namedParameters
:
{
deleted
?:
boolean
|
null
;
ids
:
string
[]
}
Returns
Promise
<
{
errors
:
{
message
:
string
;
nodeId
:
string
}
[]
;
nodes
:
Node
<
NodeBreadcrumbItem
,
Record
<
string
,
unknown
>
>
[]
;
}
,
>
nodes
Full
nodesFull
(
__namedParameters
:
{
deleted
?:
boolean
|
null
;
ids
:
string
[]
}
,
)
:
Promise
<
{
errors
:
{
message
:
string
;
nodeId
:
string
}
[]
;
nodes
:
NodeFull
[]
}
,
>
Parameters
__namedParameters
:
{
deleted
?:
boolean
|
null
;
ids
:
string
[]
}
Returns
Promise
<
{
errors
:
{
message
:
string
;
nodeId
:
string
}
[]
;
nodes
:
NodeFull
[]
}
>
nodes
Shared
With
Me
nodesSharedWithMe
(
type
?:
"FILE"
|
"FOLDER"
,
)
:
Promise
<
Node
<
NodeBreadcrumbItem
,
Record
<
string
,
unknown
>
>
[]
>
Parameters
type
:
"FILE"
|
"FOLDER"
= 'FOLDER'
Returns
Promise
<
Node
<
NodeBreadcrumbItem
,
Record
<
string
,
unknown
>
>
[]
>
recover
Node
recoverNode
(
id
:
string
)
:
Promise
<
boolean
>
Parameters
id
:
string
Returns
Promise
<
boolean
>
report
Data
reportData
(
__namedParameters
:
Omit
<
RouterInputs
[
"cloud"
]
[
"reportData"
]
,
"encryptedDataKey"
,
>
,
)
:
Promise
<
{}
>
Parameters
__namedParameters
:
Omit
<
RouterInputs
[
"cloud"
]
[
"reportData"
]
,
"encryptedDataKey"
>
Returns
Promise
<
{}
>
save
In
Cloud
saveInCloud
(
__namedParameters
:
{
dataId
:
string
;
name
:
string
;
nodeId
?:
string
}
,
)
:
Promise
<
NodeFull
>
Parameters
__namedParameters
:
{
dataId
:
string
;
name
:
string
;
nodeId
?:
string
}
Returns
Promise
<
NodeFull
>
shared
Nodes
sharedNodes
()
:
Promise
<
Node
<
NodeBreadcrumbItem
,
Record
<
string
,
unknown
>
>
[]
>
Returns
Promise
<
Node
<
NodeBreadcrumbItem
,
Record
<
string
,
unknown
>
>
[]
>
share
Node
shareNode
(
accesses
:
(
{}
&
{}
&
{}
)
[]
|
{}
&
{}
&
{}
|
{}
&
{}
&
{}
|
{}
&
{}
&
{}
,
progress
?:
ProgressCallback
,
)
:
Promise
<
{}
|
{}
>
Parameters
accesses
: (
{}
&
{}
&
{}
)
[]
|
{}
&
{}
&
{}
|
{}
&
{}
&
{}
|
{}
&
{}
&
{}
Optional
progress
:
ProgressCallback
Returns
Promise
<
{}
|
{}
>
update
Data
Storage
Type
updateDataStorageType
(
input
:
{}
)
:
Promise
<
{}
>
Parameters
input
:
{}
Returns
Promise
<
{}
>
update
Node
updateNode
(
__namedParameters
:
{
deletedAt
?:
Date
|
null
;
isFavorite
?:
boolean
|
null
;
name
?:
string
|
null
;
nodeId
:
string
;
}
,
)
:
Promise
<
NodeFull
>
Parameters
__namedParameters
:
{
deletedAt
?:
Date
|
null
;
isFavorite
?:
boolean
|
null
;
name
?:
string
|
null
;
nodeId
:
string
;
}
Returns
Promise
<
NodeFull
>
update
Public
Data
Link
updatePublicDataLink
(
input
:
{}
&
{}
)
:
Promise
<
{}
>
Parameters
input
:
{}
&
{}
Returns
Promise
<
{}
>
upload
Data
uploadData
(
opts
:
UploadDataOptions
,
)
:
Promise
<
LocalData
&
{
sharing
:
{
encryptedDataKey
:
string
;
password
:
string
}
|
null
;
}
,
>
Parameters
opts
:
UploadDataOptions
Returns
Promise
<
LocalData
&
{
sharing
:
{
encryptedDataKey
:
string
;
password
:
string
}
|
null
;
}
,
>
upload
Data
In
Cloud
uploadDataInCloud
(
__namedParameters
:
{
data
:
Uint8Array
<
ArrayBuffer
>
|
File
;
encryptProgress
?:
ProgressCallback
;
name
:
string
;
nodeId
?:
string
;
signal
?:
AbortSignal
;
storageType
?:
"s3"
|
"cold"
|
"lite"
;
uploadProgress
?:
ProgressCallback
;
}
,
)
:
Promise
<
NodeFull
>
Parameters
__namedParameters
:
{
data
:
Uint8Array
<
ArrayBuffer
>
|
File
;
encryptProgress
?:
ProgressCallback
;
name
:
string
;
nodeId
?:
string
;
signal
?:
AbortSignal
;
storageType
?:
"s3"
|
"cold"
|
"lite"
;
uploadProgress
?:
ProgressCallback
;
}
Returns
Promise
<
NodeFull
>
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
add
Data
To
History
check
Accesses
create
Folder
create
Public
Data
Link
data
Content
data
Contents
data
Metadata
delete
Data
deleted
Nodes
delete
Node
delete
Node
Cloud
Trash
delete
Nodes
delete
Node
Sharing
delete
Public
Data
Link
download
Data
From
Link
duplicate
Node
empty
Trash
get
Public
Data
Link
get
Public
Data
Links
leave
Node
Sharing
move
Nodes
node
node
Full
nodes
nodes
Full
nodes
Shared
With
Me
recover
Node
report
Data
save
In
Cloud
shared
Nodes
share
Node
update
Data
Storage
Type
update
Node
update
Public
Data
Link
upload
Data
upload
Data
In
Cloud
@secrecy/lib
Loading...