Class ContentMessage

Hierarchy (View Summary)

Message
- ContentMessage

Index

Constructors

Properties

bloomFilter causalHistory channelId content lamportTimestamp messageId repairRequest retrievalHint? senderId

Methods

encode valueOf decode

Constructors

constructor

new ContentMessage(
    messageId: string,
    channelId: string,
    senderId: string,
    causalHistory: HistoryEntry[],
    lamportTimestamp: bigint,
    bloomFilter: undefined | Uint8Array<ArrayBufferLike>,
    content: Uint8Array<ArrayBufferLike>,
    repairRequest?: HistoryEntry[],
    retrievalHint?: Uint8Array<ArrayBufferLike>,
): ContentMessage
Parameters
- messageId: string
- channelId: string
- senderId: string
- causalHistory: HistoryEntry[]
- lamportTimestamp: bigint
- bloomFilter: undefined | Uint8Array<ArrayBufferLike>
- content: Uint8Array<ArrayBufferLike>
- repairRequest: HistoryEntry[] = []
- OptionalretrievalHint: Uint8Array<ArrayBufferLike>
  Not encoded, set after it is sent, used to include in follow-up messages
Returns ContentMessage
Overrides Message.constructor
- Defined in packages/sds/src/message_channel/message.ts:193

Properties

bloomFilter

bloomFilter: undefined | Uint8Array<ArrayBufferLike>

causalHistory

causalHistory: HistoryEntry[]

channelId

channelId: string

content

content: Uint8Array<ArrayBufferLike>

lamportTimestamp

lamportTimestamp: bigint

messageId

messageId: string

repairRequest

repairRequest: HistoryEntry[] = []

`Optional`retrievalHint

retrievalHint?: Uint8Array<ArrayBufferLike>

Not encoded, set after it is sent, used to include in follow-up messages

senderId

senderId: string

Methods

encode

encode(): Uint8Array
Returns Uint8Array
Inherited from Message.encode
- Defined in packages/sds/src/message_channel/message.ts:27

valueOf

valueOf(): string
Returns the primitive value of the specified object.

Returns string
- Defined in packages/sds/src/message_channel/message.ts:224

`Static`decode

decode(
data: Uint8Array,
): undefined | ContentMessage | SyncMessage | EphemeralMessage
Parameters
- data: Uint8Array
Returns undefined | ContentMessage | SyncMessage | EphemeralMessage
Inherited from Message.decode
- Defined in packages/sds/src/message_channel/message.ts:31