Type Alias SendEventParams

Options for sending an event.

type SendEventParams = {
    eventObject: Partial<IEvent>;
    queryDict?: QueryDict;
    roomId: string;
    threadId: string | null;
    txnId?: string;
}

Index

Properties

eventObject queryDict? roomId threadId txnId?

Properties

eventObject

eventObject: Partial<IEvent>

An object with the partial structure of an event, to which event_id, user_id, room_id and origin_server_ts will be added.

`Optional`queryDict

queryDict?: QueryDict

Optional query parameters for the send request.

roomId

roomId: string

The room to send the event to.

threadId

threadId: string | null

The thread to send the event in, or null for the main timeline.

`Optional`txnId

txnId?: string

Optional transaction ID. Generated if omitted.