Interface OutgoingRoomKeyRequest

Represents an outgoing room key request

interface OutgoingRoomKeyRequest {
    cancellationTxnId?: string;
    recipients: IRoomKeyRequestRecipient[];
    requestBody: IRoomKeyRequestBody;
    requestId: string;
    requestTxnId?: string;
    state: RoomKeyRequestState;
}

Properties

cancellationTxnId? recipients requestBody requestId requestTxnId? state

Properties

OptionalcancellationTxnId

cancellationTxnId?: string

Transaction id for the cancellation, if any

recipients

recipients: IRoomKeyRequestRecipient[]

List of recipients for the request

requestBody

requestBody: IRoomKeyRequestBody

Parameters for the request

requestId

requestId: string

Unique id for this request. Used for both an id within the request for later pairing with a cancellation, and for the transaction id when sending the to_device messages to our local server.

OptionalrequestTxnId

requestTxnId?: string

state

state: RoomKeyRequestState

current state of this request

Settings

Member Visibility

On This Page

Properties