Interface ICapabilities

interface ICapabilities {
    receiveEvent?: string[];
    receiveMessage?: true | string[];
    receiveState?: IStateEventRequest[];
    receiveToDevice?: string[];
    sendDelayedEvents?: boolean;
    sendEvent?: string[];
    sendMessage?: true | string[];
    sendState?: IStateEventRequest[];
    sendToDevice?: string[];
    turnServers?: boolean;
    updateDelayedEvents?: boolean;
}

Properties

receiveEvent? receiveMessage? receiveState? receiveToDevice? sendDelayedEvents? sendEvent? sendMessage? sendState? sendToDevice? turnServers? updateDelayedEvents?

Properties

OptionalreceiveEvent

receiveEvent?: string[]

Event types that this client expects to receive.

OptionalreceiveMessage

receiveMessage?: true | string[]

Message types that this client expects to receive, or true for all message types.

OptionalreceiveState

receiveState?: IStateEventRequest[]

Types of state events that this client expects to receive.

OptionalreceiveToDevice

receiveToDevice?: string[]

To-device event types that this client expects to receive.

Optional ExperimentalsendDelayedEvents

sendDelayedEvents?: boolean

Whether this client needs to be able to send delayed events. Part of MSC4140 & MSC4157

Default Value

false

OptionalsendEvent

sendEvent?: string[]

Event types that this client expects to send.

OptionalsendMessage

sendMessage?: true | string[]

Message types that this client expects to send, or true for all message types.

OptionalsendState

sendState?: IStateEventRequest[]

Types of state events that this client expects to send.

OptionalsendToDevice

sendToDevice?: string[]

To-device event types that this client expects to send.

OptionalturnServers

turnServers?: boolean

Whether this client needs access to TURN servers.

Default Value

false

Optional ExperimentalupdateDelayedEvents

updateDelayedEvents?: boolean

Whether this client needs to be able to update delayed events. Part of MSC4140 & MSC4157

Default Value

false

Settings

Member Visibility

On This Page

Properties