@vector-im/matrix-bot-sdk/lib/SynchronousMatrixClient.js

TypeScript/JavaScript SDK for Matrix bots and appservices

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.SynchronousMatrixClient = void 0;
const MatrixClient_1 = require("./MatrixClient");
/**
 * A MatrixClient class that handles events in sync for the /sync loop, instead
 * of trying to push its way through the /sync loop as fast as possible. It is
 * intended that the consumer extend this class and override the onWhatever()
 * functions it needs. All of the onWhatever() functions have a default behaviour
 * of doing nothing.
 */
class SynchronousMatrixClient extends MatrixClient_1.MatrixClient {
    /**
     * Creates a new SynchronousMatrixClient. Note that this accepts a MatrixClient, though
     * much of the class's properties are not brought over. Always convert your MatrixClient
     * instance to a SynchronousMatrixClient as soon as possible to avoid diversion in which
     * properties are proxied over.
     * @param {MatrixClient} baseClient The client to wrap.
     */
    constructor(baseClient) {
        super(baseClient.homeserverUrl, baseClient.accessToken, baseClient.storageProvider);
    }
    async handleEvent(emitType, arg1, arg2) {
        if (emitType === 'account_data')
            await this.onAccountData(arg1);
        if (emitType === 'room.account_data')
            await this.onRoomAccountData(arg1, arg2);
        if (emitType === 'room.leave')
            await this.onRoomLeave(arg1, arg2);
        if (emitType === 'room.invite')
            await this.onRoomInvite(arg1, arg2);
        if (emitType === 'room.join')
            await this.onRoomJoin(arg1, arg2);
        if (emitType === 'room.archived')
            await this.onRoomArchived(arg1, arg2);
        if (emitType === 'room.upgraded')
            await this.onRoomUpgraded(arg1, arg2);
        if (emitType === 'room.message')
            await this.onRoomMessage(arg1, arg2);
        if (emitType === 'room.event')
            await this.onRoomEvent(arg1, arg2);
        // Still emit though for easier support of plugins.
        this.emit(emitType, arg1, arg2);
    }
    startSyncInternal() {
        return this.startSync(this.handleEvent.bind(this));
    }
    /**
     * Handles the `account_data` event raised by the client.
     * @param {any} event The account data event.
     * @returns {Promise<any>} Resolves when complete.
     */
    onAccountData(event) {
        return;
    }
    /**
     * Handles the `room.account_data` event raised by the client.
     * @param {string} roomId The Room ID the account data applies to.
     * @param {any} event The room account data event.
     * @returns {Promise<any>} Resolves when complete.
     */
    onRoomAccountData(roomId, event) {
        return;
    }
    /**
     * Handles the `room.leave` event raised by the client.
     * @param {string} roomId The Room ID the event happened in.
     * @param {any} event The event.
     * @returns {Promise<any>} Resolves when complete.
     */
    onRoomLeave(roomId, event) {
        return;
    }
    /**
     * Handles the `room.invite` event raised by the client.
     * @param {string} roomId The Room ID the event happened in.
     * @param {any} event The event.
     * @returns {Promise<any>} Resolves when complete.
     */
    onRoomInvite(roomId, event) {
        return;
    }
    /**
     * Handles the `room.join` event raised by the client.
     * @param {string} roomId The Room ID the event happened in.
     * @param {any} event The event.
     * @returns {Promise<any>} Resolves when complete.
     */
    onRoomJoin(roomId, event) {
        return;
    }
    /**
     * Handles the `room.message` event raised by the client.
     * @param {string} roomId The Room ID the event happened in.
     * @param {any} event The event.
     * @returns {Promise<any>} Resolves when complete.
     */
    onRoomMessage(roomId, event) {
        return;
    }
    /**
     * Handles the `room.archived` event raised by the client.
     * @param {string} roomId The Room ID the event happened in.
     * @param {any} event The event.
     * @returns {Promise<any>} Resolves when complete.
     */
    onRoomArchived(roomId, event) {
        return;
    }
    /**
     * Handles the `room.upgraded` event raised by the client.
     * @param {string} roomId The Room ID the event happened in.
     * @param {any} event The event.
     * @returns {Promise<any>} Resolves when complete.
     */
    onRoomUpgraded(roomId, event) {
        return;
    }
    /**
     * Handles the `room.event` event raised by the client.
     * @param {string} roomId The Room ID the event happened in.
     * @param {any} event The event.
     * @returns {Promise<any>} Resolves when complete.
     */
    onRoomEvent(roomId, event) {
        return;
    }
}
exports.SynchronousMatrixClient = SynchronousMatrixClient;
//# sourceMappingURL=SynchronousMatrixClient.js.map