Class Decrypt

Decrypt

Date

1/31/2024 - 6:36:57 PM

Export

Decrypt

Constructors

constructor

new Decrypt(sdk: FilenSDK): Decrypt
Parameters
- sdk: FilenSDK
Returns Decrypt
- Defined in src/crypto/decrypt.ts:30

Methods

chatConversationName

chatConversationName(param0: { key: string; name: string }): Promise<string>
Decrypt a chat conversation name.
Parameters
- param0: { key: string; name: string }
Returns Promise<string>
Date
2/20/2024 - 5:31:41 AM

Async
- Defined in src/crypto/decrypt.ts:930

chatKeyOwner

chatKeyOwner(param0: { key?: string; metadata: string }): Promise<string>
Decrypts a chat encryption (symmetric) key.
Parameters
- param0: { key?: string; metadata: string }
Returns Promise<string>
Async
- Defined in src/crypto/decrypt.ts:617

chatKeyParticipant

chatKeyParticipant(
param0: { metadata: string; privateKey: string },
): Promise<string>
Decrypts a chat encryption (symmetric) key.
Parameters
- param0: { metadata: string; privateKey: string }
Returns Promise<string>
Date
2/6/2024 - 12:54:25 AM

Async
- Defined in src/crypto/decrypt.ts:579

chatMessage

chatMessage(param0: { key: string; message: string }): Promise<string>
Decrypt a chat message
Parameters
- param0: { key: string; message: string }
Returns Promise<string>
Date
2/20/2024 - 5:34:42 AM

Async
- Defined in src/crypto/decrypt.ts:670

data

data(
param0: { data: Buffer; key: string; version: FileEncryptionVersion },
): Promise<Buffer>
Decrypt data.
Parameters
- param0: { data: Buffer; key: string; version: FileEncryptionVersion }
Returns Promise<Buffer>
Date
2/7/2024 - 1:50:58 AM

Async
- Defined in src/crypto/decrypt.ts:970

dataStream

dataStream(
    param0: {
        inputFile: string;
        key: string;
        outputFile?: string;
        version: FileEncryptionVersion;
    },
): Promise<string>
Decrypt a file/chunk using streams. Only available in a Node.JS environment.
Parameters
- param0: {
      inputFile: string;
      key: string;
      outputFile?: string;
      version: FileEncryptionVersion;
  }
Returns Promise<string>
Date
2/7/2024 - 1:38:12 AM

Async
- Defined in src/crypto/decrypt.ts:1191

event

event(param0: { event: UserEvent }): Promise<UserEvent>
Decrypt a user event.
Parameters
- param0: { event: UserEvent }
Returns Promise<UserEvent>
Async
- Defined in src/crypto/decrypt.ts:1391

fileMetadata

fileMetadata(param0: { key?: string; metadata: string }): Promise<FileMetadata>
Decrypt file metadata.
Parameters
- param0: { key?: string; metadata: string }
Returns Promise<FileMetadata>
Date
2/3/2024 - 1:54:51 AM

Async
- Defined in src/crypto/decrypt.ts:197

fileMetadataLink

fileMetadataLink(
param0: { linkKey: string; metadata: string },
): Promise<FileMetadata>
Decrypt file metadata inside a public link.
Parameters
- param0: { linkKey: string; metadata: string }
Returns Promise<FileMetadata>
Date
2/6/2024 - 3:05:42 AM

Async
- Defined in src/crypto/decrypt.ts:431

fileMetadataPrivate

fileMetadataPrivate(
param0: { key?: string; metadata: string },
): Promise<FileMetadata>
Decrypt file metadata using a private key.
Parameters
- param0: { key?: string; metadata: string }
Returns Promise<FileMetadata>
Date
2/3/2024 - 1:58:12 AM

Async
- Defined in src/crypto/decrypt.ts:321

folderLinkKey

folderLinkKey(param0: { key?: string; metadata: string }): Promise<string>
Decrypt a public link folder encryption key (using given key or master keys).
Parameters
- param0: { key?: string; metadata: string }
Returns Promise<string>
Date
2/6/2024 - 3:09:37 AM

Async
- Defined in src/crypto/decrypt.ts:537

folderMetadata

folderMetadata(
param0: { key?: string; metadata: string },
): Promise<FolderMetadata>
Decrypt folder metadata.
Parameters
- param0: { key?: string; metadata: string }
Returns Promise<FolderMetadata>
Date
2/3/2024 - 1:55:17 AM

Async
- Defined in src/crypto/decrypt.ts:263

folderMetadataLink

folderMetadataLink(
param0: { linkKey: string; metadata: string },
): Promise<FolderMetadata>
Decrypt folder metadata inside a public link.
Parameters
- param0: { linkKey: string; metadata: string }
Returns Promise<FolderMetadata>
Date
2/6/2024 - 3:07:06 AM

Async
- Defined in src/crypto/decrypt.ts:491

folderMetadataPrivate

folderMetadataPrivate(
param0: { key?: string; metadata: string },
): Promise<FolderMetadata>
Decrypt folder metadata using a private key.
Parameters
- param0: { key?: string; metadata: string }
Returns Promise<FolderMetadata>
Date
2/3/2024 - 1:58:05 AM

Async
- Defined in src/crypto/decrypt.ts:383

metadata

metadata(param0: { key: string; metadata: string }): Promise<string>
Decrypt a string with the given key.
Parameters
- param0: { key: string; metadata: string }
Returns Promise<string>
Date
1/31/2024 - 3:58:27 PM

Async
- Defined in src/crypto/decrypt.ts:45

metadataPrivate

metadataPrivate(
param0: { metadata: string; privateKey: string },
): Promise<string>
Decrypt metadata using the given private key.
Parameters
- param0: { metadata: string; privateKey: string }
Returns Promise<string>
Date
2/3/2024 - 1:50:10 AM

Async
- Defined in src/crypto/decrypt.ts:148

noteContent

noteContent(param0: { content: string; key: string }): Promise<string>
Decrypt note content using the note's symmetric encryption key.
Parameters
- param0: { content: string; key: string }
Returns Promise<string>
Date
2/6/2024 - 2:50:15 AM

Async
- Defined in src/crypto/decrypt.ts:779

noteKeyOwner

noteKeyOwner(param0: { key?: string; metadata: string }): Promise<string>
Decrypts the symmetric note encryption key with the given owner metadata.
Parameters
- param0: { key?: string; metadata: string }
Returns Promise<string>
Date
2/6/2024 - 1:01:59 AM

Async
- Defined in src/crypto/decrypt.ts:696

noteKeyParticipant

noteKeyParticipant(
param0: { metadata: string; privateKey: string },
): Promise<string>
Decrypt a symmetric note encryption key using participant metadata and their private key.
Parameters
- param0: { metadata: string; privateKey: string }
Returns Promise<string>
Date
2/6/2024 - 2:47:34 AM

Async
- Defined in src/crypto/decrypt.ts:740

notePreview

notePreview(param0: { key: string; preview: string }): Promise<string>
Decrypt a note's preview using the note's symmetric encryption key.
Parameters
- param0: { key: string; preview: string }
Returns Promise<string>
Date
2/6/2024 - 2:53:35 AM

Async
- Defined in src/crypto/decrypt.ts:844

noteTagName

noteTagName(param0: { key?: string; name: string }): Promise<string>
Decrypt a note tag name using the master keys or a given key.
Parameters
- param0: { key?: string; name: string }
Returns Promise<string>
Date
2/6/2024 - 2:56:38 AM

Async
- Defined in src/crypto/decrypt.ts:883

noteTitle

noteTitle(param0: { key: string; title: string }): Promise<string>
Decrypt a note's title using the note's symmetric encryption key.
Parameters
- param0: { key: string; title: string }
Returns Promise<string>
Date
2/6/2024 - 2:52:02 AM

Async
- Defined in src/crypto/decrypt.ts:805

Class Decrypt

Date

Export

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Decrypt

Methods

chatConversationName

Parameters

Returns Promise<string>

Date

Async

chatKeyOwner

Parameters

Returns Promise<string>

Async

chatKeyParticipant

Parameters

Returns Promise<string>

Date

Async

chatMessage

Parameters

Returns Promise<string>

Date

Async

data

Parameters

Returns Promise<Buffer>

Date

Async

dataStream

Parameters

Returns Promise<string>

Date

Async

event

Parameters

Returns Promise<UserEvent>

Async

fileMetadata

Parameters

Returns Promise<FileMetadata>

Date

Async

fileMetadataLink

Parameters

Returns Promise<FileMetadata>

Date

Async

fileMetadataPrivate

Parameters

Returns Promise<FileMetadata>

Date

Async

folderLinkKey

Parameters

Returns Promise<string>

Date

Async

folderMetadata

Parameters

Returns Promise<FolderMetadata>

Date

Async

folderMetadataLink

Parameters

Returns Promise<FolderMetadata>

Date

Async

folderMetadataPrivate

Parameters

Returns Promise<FolderMetadata>

Date

Async

metadata