Class EncryptedAttachment

Constructors

constructor

Properties

encryptedData hasMediaEncryptionInfoBeenConsumed mediaEncryptionInfo

Methods

[dispose] free

Constructors

constructor

  • new EncryptedAttachment(
        encrypted_data: Uint8Array,
        media_encryption_info: string,
    ): EncryptedAttachment

    Create a new encrypted attachment manually.

    It needs encrypted data, stored in an Uint8Array, and a media encryption information, as a JSON-encoded object.

    The media encryption information aren't stored as a string: they are parsed, validated and fully deserialized.

    See the specification to learn more.

    Parameters

    • encrypted_data: Uint8Array
    • media_encryption_info: string

    Returns EncryptedAttachment

Properties

ReadonlyencryptedData

encryptedData: Uint8Array

The actual encrypted data.

Warning: It returns a copy of the entire encrypted data; be nice with your memory.

ReadonlyhasMediaEncryptionInfoBeenConsumed

hasMediaEncryptionInfoBeenConsumed: boolean

Check whether the media encryption info has been consumed by Attachment.decrypt already.

ReadonlymediaEncryptionInfo

mediaEncryptionInfo: undefined | string

Return the media encryption info as a JSON-encoded object. The structure is fully valid.

If the media encryption info have been consumed already, it will return null.

Methods

[dispose]

  • "[dispose]"(): void

    Returns void

free

  • free(): void

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods