Class Encrypt

Encrypt

Date

2/1/2024 - 2:44:28 AM

Export

Encrypt

Index

Constructors

Methods

chatConversationName chatMessage data dataStream metadata metadataPublic noteContent notePreview noteTagName noteTitle

Constructors

constructor

new Encrypt(sdk: FilenSDK): Encrypt
Creates an instance of Encrypt.
Parameters
- sdk: FilenSDK
Returns Encrypt
- Defined in src/crypto/encrypt.ts:33

Methods

chatConversationName

chatConversationName(param0: { key: string; name: string }): Promise<string>
Encrypt the conversation name using the conversation encryption key.
Parameters
- param0: { key: string; name: string }
Returns Promise<string>
Date
2/6/2024 - 3:03:45 AM

Async
- Defined in src/crypto/encrypt.ts:338

chatMessage

chatMessage(param0: { key: string; message: string }): Promise<string>
Encrypt a chat message using the conversation encryption key.
Parameters
- param0: { key: string; message: string }
Returns Promise<string>
Date
2/6/2024 - 3:01:09 AM

Async
- Defined in src/crypto/encrypt.ts:218

data

data(
    __namedParameters: {
        data: Buffer;
        key: string;
        version?: FileEncryptionVersion;
    },
): Promise<Buffer>
Parameters
- __namedParameters: { data: Buffer; key: string; version?: FileEncryptionVersion }
Returns Promise<Buffer>
- Defined in src/crypto/encrypt.ts:351

dataStream

dataStream(
    __namedParameters: {
        inputFile: string;
        key: string;
        outputFile?: string;
        version?: FileEncryptionVersion;
    },
): Promise<string>
Parameters
- __namedParameters: {
      inputFile: string;
      key: string;
      outputFile?: string;
      version?: FileEncryptionVersion;
  }
Returns Promise<string>
- Defined in src/crypto/encrypt.ts:480

metadata

metadata(
    param0: {
        key?: string;
        metadata: string;
        version?: MetadataEncryptionVersion;
    },
): Promise<string>
Encrypt metadata using the user's DEK or a provided key.
Parameters
- param0: { key?: string; metadata: string; version?: MetadataEncryptionVersion }
Returns Promise<string>
Async
- Defined in src/crypto/encrypt.ts:52

metadataPublic

metadataPublic(param0: { metadata: string; publicKey: string }): Promise<string>
Encrypts metadata using a public key.
Parameters
- param0: { metadata: string; publicKey: string }
Returns Promise<string>
Async
- Defined in src/crypto/encrypt.ts:173

noteContent

noteContent(param0: { content: string; key: string }): Promise<string>
Encrypt note content using the note's encryption key.
Parameters
- param0: { content: string; key: string }
Returns Promise<string>
Date
2/6/2024 - 3:02:23 AM

Async
- Defined in src/crypto/encrypt.ts:242

notePreview

notePreview(param0: { key: string; preview: string }): Promise<string>
Encrypt the note's preview using the note's encryption key.
Parameters
- param0: { key: string; preview: string }
Returns Promise<string>
Date
2/6/2024 - 3:02:56 AM

Async
- Defined in src/crypto/encrypt.ts:290

noteTagName

noteTagName(param0: { key?: string; name: string }): Promise<string>
Encrypt a tag's name using the given key.
Parameters
- param0: { key?: string; name: string }
Returns Promise<string>
Date
2/20/2024 - 3:21:12 AM

Async
- Defined in src/crypto/encrypt.ts:312

noteTitle

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

Async
- Defined in src/crypto/encrypt.ts:266