Class ToDeviceMessageQueue

Maintains a queue of outgoing to-device messages, sending them as soon as the homeserver is reachable.

Hierarchy

ToDeviceMessageQueue

Index

Constructors

Properties

client retryAttempts retryTimeout running sending

Methods

onResumedSync queueBatch sendBatch sendQueue start stop

Constructors

constructor

new ToDeviceMessageQueue(client: MatrixClient): ToDeviceMessageQueue
Parameters
- client: MatrixClient
Returns ToDeviceMessageQueue
- Defined in src/ToDeviceMessageQueue.ts:38

Properties

`Private` client

client: MatrixClient

`Private` retryAttempts

retryAttempts: number = 0

`Private` retryTimeout

retryTimeout: null | Timeout = null

`Private` running

running: boolean = true

`Private` sending

sending: boolean = false

Methods

`Private` onResumedSync

onResumedSync(state: null | SyncState, oldState: null | SyncState): void
Listen to sync state changes and automatically resend any pending events once syncing is resumed
Parameters
- state: null | SyncState
- oldState: null | SyncState
Returns void
- Defined in src/ToDeviceMessageQueue.ts:142

queueBatch

queueBatch(batch: ToDeviceBatch): Promise<void>
Parameters
- batch: ToDeviceBatch
Returns Promise<void>
- Defined in src/ToDeviceMessageQueue.ts:53

`Private` sendBatch

sendBatch(batch: IndexedToDeviceBatch): Promise<void>
Attempts to send a batch of to-device messages.
Parameters
- batch: IndexedToDeviceBatch
Returns Promise<void>
- Defined in src/ToDeviceMessageQueue.ts:125

sendQueue

sendQueue(): Promise<void>
Returns Promise<void>
- Defined in src/ToDeviceMessageQueue.ts:75

start

start(): void
Returns void
- Defined in src/ToDeviceMessageQueue.ts:40

stop

stop(): void
Returns void
- Defined in src/ToDeviceMessageQueue.ts:46

Generated using TypeDoc