Skip to main content

Class: StreamMessage

An internal class representing a message in a stream. Applications see instances of the Message class.

Implements​

Constructors​

new StreamMessage()​

new StreamMessage(__namedParameters): StreamMessage

Parameters​

__namedParameters​

StreamMessageOptions

Returns​

StreamMessage

Properties​

content​

readonly content: Uint8Array

Implementation of​

StreamMessageOptions.content

contentType​

readonly contentType: ContentType

Implementation of​

StreamMessageOptions.contentType

encryptionType​

readonly encryptionType: EncryptionType

Implementation of​

StreamMessageOptions.encryptionType

groupKeyId?​

readonly optional groupKeyId: string

Implementation of​

StreamMessageOptions.groupKeyId

messageId​

readonly messageId: MessageID

Implementation of​

StreamMessageOptions.messageId

messageType​

readonly messageType: StreamMessageType

Implementation of​

StreamMessageOptions.messageType

newGroupKey?​

readonly optional newGroupKey: EncryptedGroupKey

Implementation of​

StreamMessageOptions.newGroupKey

prevMsgRef?​

readonly optional prevMsgRef: MessageRef

Implementation of​

StreamMessageOptions.prevMsgRef

signature​

readonly signature: Uint8Array

Implementation of​

StreamMessageOptions.signature

signatureType​

readonly signatureType: SignatureType

Implementation of​

StreamMessageOptions.signatureType

Methods​

getMessageRef()​

getMessageRef(): MessageRef

Returns​

MessageRef

getMsgChainId()​

getMsgChainId(): string

Returns​

string

getParsedContent()​

getParsedContent(): Record<string, unknown> | Uint8Array<ArrayBufferLike> | unknown[]

Returns​

Record<string, unknown> | Uint8Array<ArrayBufferLike> | unknown[]

getPublisherId()​

getPublisherId(): UserID

Returns​

UserID

getSequenceNumber()​

getSequenceNumber(): number

Returns​

number

getStreamId()​

getStreamId(): StreamID

Returns​

StreamID

getStreamPartID()​

getStreamPartID(): StreamPartID

Returns​

StreamPartID

getStreamPartition()​

getStreamPartition(): number

Returns​

number

getTimestamp()​

getTimestamp(): number

Returns​

number

isAESEncrypted()​

static isAESEncrypted(msg): msg is StreamMessageAESEncrypted

Parameters​

msg​

StreamMessage

Returns​

msg is StreamMessageAESEncrypted