Class MessageContentV3

Description

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

Hierarchy

MessageContent
- MessageContentV3

Implements

IMessageContentV3

Index

Constructors

Properties

content isPlain subject version VERSION

Methods

toBytes fromBytes isValid plain rich

Constructors

constructor

new MessageContentV3(data: IMessageContentV3): MessageContentV3
Private constructor for instantiating MessageContentV3 instance
Parameters
- data: IMessageContentV3
Returns MessageContentV3
Overrides MessageContent.constructor
- Defined in src/content/MessageContentV3.ts:31

Properties

content

content: string

isPlain

isPlain: boolean

subject

subject: string

version

version: number

`Static` `Readonly` VERSION

VERSION: 3 = 0x03

Methods

toBytes

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

Returns Uint8Array
Overrides MessageContent.toBytes
- Defined in src/content/MessageContentV3.ts:67

`Static` fromBytes

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

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

`Static` isValid

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

`Static` plain

plain(subject: string, text: string): MessageContentV3
Factory method for creating plaintext message content

Returns
MessageContentV3 instance
Parameters
- subject: string
  
  Message subject in plaintext
- text: string
  
  Message content in plaintext
Returns MessageContentV3
- Defined in src/content/MessageContentV3.ts:52

`Static` rich

rich(subject: string, text: any): MessageContentV3
Factory method for creating formatted message content

Returns
MessageContentV3 instance
Parameters
- subject: string
  
  Message subject in plaintext
- text: any
  
  Message content in serializeable object
Returns MessageContentV3
- Defined in src/content/MessageContentV3.ts:63

Generated using TypeDoc