Class DecodedMessage<ContentTypes>

Type parameters

ContentTypes = any

Hierarchy

DecodedMessage

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DecodedMessage<ContentTypes>(__namedParameters: Omit<DecodedMessage<ContentTypes>, "toBytes">): DecodedMessage<ContentTypes>

- Defined in Message.ts:237
Type parameters
- ContentTypes = any
Parameters
- __namedParameters: Omit<DecodedMessage<ContentTypes>, "toBytes">
Returns DecodedMessage<ContentTypes>

Properties

content

content: ContentTypes

contentBytes

contentBytes: Uint8Array

Optional contentFallback

contentFallback?: string

contentTopic

contentTopic: string

contentType

contentType: ContentTypeId

conversation

conversation: Conversation<ContentTypes>

Optional error

error?: Error

id

id: string

messageVersion

messageVersion: "v1" | "v2"

Optional recipientAddress

recipientAddress?: string

senderAddress

senderAddress: string

sent

sent: Date

Methods

toBytes

toBytes(): Uint8Array

- Defined in Message.ts:265
Returns Uint8Array

Static fromBytes

fromBytes<ContentTypes>(data: Uint8Array, client: Client<ContentTypes>): Promise<DecodedMessage<ContentTypes>>

- Defined in Message.ts:278
Type parameters
- ContentTypes
Parameters
- data: Uint8Array
- client: Client<ContentTypes>
Returns Promise<DecodedMessage<ContentTypes>>

Static fromV1Message

fromV1Message<ContentTypes>(message: MessageV1, content: ContentTypes, contentType: ContentTypeId, contentBytes: Uint8Array, contentTopic: string, conversation: Conversation<ContentTypes>, error?: Error, contentFallback?: string): DecodedMessage<ContentTypes>

- Defined in Message.ts:312
Type parameters
- ContentTypes
Parameters
- message: MessageV1
- content: ContentTypes
- contentType: ContentTypeId
- contentBytes: Uint8Array
- contentTopic: string
- conversation: Conversation<ContentTypes>
- Optional error: Error
- Optional contentFallback: string
Returns DecodedMessage<ContentTypes>

Static fromV2Message

fromV2Message<ContentTypes>(message: MessageV2, content: ContentTypes, contentType: ContentTypeId, contentTopic: string, contentBytes: Uint8Array, conversation: Conversation<ContentTypes>, senderAddress: string, error?: Error, contentFallback?: string): DecodedMessage<ContentTypes>

- Defined in Message.ts:342
Type parameters
- ContentTypes
Parameters
- message: MessageV2
- content: ContentTypes
- contentType: ContentTypeId
- contentTopic: string
- contentBytes: Uint8Array
- conversation: Conversation<ContentTypes>
- senderAddress: string
- Optional error: Error
- Optional contentFallback: string
Returns DecodedMessage<ContentTypes>

Generated using TypeDoc