Class StreamMessage<T>

Type Parameters

T = unknown

Hierarchy

StreamMessage

Constructors

constructor

new StreamMessage<T>(__namedParameters: StreamMessageOptions<T>): StreamMessage<T>
Type Parameters
- T = unknown
Parameters
- __namedParameters: StreamMessageOptions<T>
Returns StreamMessage<T>

Properties

contentType

contentType: JSON

encryptionType

encryptionType: EncryptionType

groupKeyId

groupKeyId: null | string

messageId

messageId: MessageID

messageType

messageType: StreamMessageType

newGroupKey

newGroupKey: null | EncryptedGroupKey

`Optional` parsedContent

parsedContent?: T

prevMsgRef

prevMsgRef: null | MessageRef

serializedContent

serializedContent: string

signature

signature: string

`Static` LATEST_VERSION

LATEST_VERSION: number

Methods

clone

clone(): StreamMessage<T>
Create a new StreamMessage identical to the passed-in streamMessage.

Returns StreamMessage<T>

getContent

getContent(): string
Returns string
getContent(parsedContent: false): string
Parameters
- parsedContent: false
Returns string
getContent(parsedContent: true): T
Parameters
- parsedContent: true
Returns T

getMessageID

getMessageID(): MessageID
Returns MessageID

getMessageRef

getMessageRef(): MessageRef
Returns MessageRef

getMsgChainId

getMsgChainId(): string
Returns string

getNewGroupKey

getNewGroupKey(): null | EncryptedGroupKey
Returns null | EncryptedGroupKey

getParsedContent

getParsedContent(): T
Lazily parses the content to JSON

Returns T

getPreviousMessageRef

getPreviousMessageRef(): null | MessageRef
Returns null | MessageRef

getPublisherId

getPublisherId(): EthereumAddress
Returns EthereumAddress

getSequenceNumber

getSequenceNumber(): number
Returns number

getSerializedContent

getSerializedContent(): string
Returns string

getStreamId

getStreamId(): StreamID
Returns StreamID

getStreamPartID

getStreamPartID(): StreamPartID
Returns StreamPartID

getStreamPartition

getStreamPartition(): number
Returns number

getTimestamp

getTimestamp(): number
Returns number

serialize

serialize(version?: number): string
Parameters
- Optional version: number
Returns string

`Static` deserialize

deserialize(msg: string | any[]): StreamMessage<unknown>
Takes a serialized representation (array or string) of a message, and returns a StreamMessage instance.
Parameters
- msg: string | any[]
Returns StreamMessage<unknown>

`Static` getSupportedVersions

getSupportedVersions(): number[]
Returns number[]

`Static` isAESEncrypted

isAESEncrypted<T>(msg: StreamMessage<T>): msg is StreamMessageAESEncrypted<T>
Type Parameters
- T = unknown
Parameters
- msg: StreamMessage<T>
Returns msg is StreamMessageAESEncrypted<T>

`Static` validateContentType

validateContentType(contentType: JSON): void
Parameters
- contentType: JSON
Returns void

`Static` validateEncryptionType

validateEncryptionType(encryptionType: EncryptionType): void
Parameters
- encryptionType: EncryptionType
Returns void

`Static` validateMessageType

validateMessageType(messageType: StreamMessageType): void
Parameters
- messageType: StreamMessageType
Returns void

`Static` validateSequence

validateSequence(__namedParameters: {
messageId: MessageID;
prevMsgRef?: null | MessageRef;
}): void
Parameters
- __namedParameters: {
  messageId: MessageID;
  prevMsgRef?: null | MessageRef;
  }
  - messageId: MessageID
  - Optional prevMsgRef?: null | MessageRef
Returns void

`Static` versionSupportsEncryption

versionSupportsEncryption(streamMessageVersion: number): boolean
Parameters
- streamMessageVersion: number
Returns boolean

Generated using TypeDoc