Class MessageContentV5

Description

MessageContent ancestor used for the plaintext or simply formatted messages with plaintext subject.

Hierarchy

MessageContent
- MessageContentV5

Implements

IMessageContentV5

Index

Constructors

Properties

attachments content extraBytes extraJson recipientInfos sendingAgentName sendingAgentVersion subject version VERSION

Methods

toBytes fromBytes isValid simple

Constructors

constructor

new MessageContentV5(data: IMessageContentV5): MessageContentV5
Private constructor for instantiating MessageContentV5 instance c
Parameters
- data: IMessageContentV5
Returns MessageContentV5
Overrides MessageContent.constructor
- Defined in src/content/MessageContentV5.ts:55

Properties

attachments

attachments: MessageAttachment[]

content

content: YMF

extraBytes

extraBytes: Uint8Array

extraJson

extraJson: Record<string, any>

recipientInfos

recipientInfos: RecipientInfo[]

sendingAgentName

sendingAgentName: string

sendingAgentVersion

sendingAgentVersion: Semver

subject

subject: string

version

version: number

`Static` `Readonly` VERSION

VERSION: 5 = 0x05

Methods

toBytes

toBytes(): Uint8Array
Method used to get bytes representation of the message content

Returns Uint8Array
Overrides MessageContent.toBytes
- Defined in src/content/MessageContentV5.ts:91

`Static` fromBytes

fromBytes(bytes: Uint8Array): MessageContentV5
Factory method to extract MessageContentV5 data from raw bytes

Returns
Deserialized data
Parameters
- bytes: Uint8Array
  
  Bytes array
Returns MessageContentV5
- Defined in src/content/MessageContentV5.ts:147

`Static` isValid

isValid(bytes: Uint8Array): boolean
Parameters
- bytes: Uint8Array
Returns boolean
- Defined in src/content/MessageContentV5.ts:85

`Static` simple

simple(subject: string, content?: string): MessageContentV5
Parameters
- subject: string
- Optional content: string
Returns MessageContentV5
- Defined in src/content/MessageContentV5.ts:72

Generated using TypeDoc