@rocket.chat/apps-engine/definition/accessors/ILivechatUpdater.d.ts

The engine code for the Rocket.Chat Apps which manages, runs, translates, coordinates and all of that.

import type { ILivechatTransferData, IVisitor } from '../livechat';
import type { IRoom } from '../rooms';
import type { IUser } from '../users';
export interface ILivechatUpdater {
    /**
     * Transfer a Livechat visitor to another room
     *
     * @param visitor Visitor to be transferred
     * @param transferData The data to execute the transferring
     */
    transferVisitor(visitor: IVisitor, transferData: ILivechatTransferData): Promise<boolean>;
    /**
     * Closes a Livechat room
     *
     * @param room The room to be closed
     * @param comment The comment explaining the reason for closing the room
     * @param closer The user that closes the room
     */
    closeRoom(room: IRoom, comment: string, closer?: IUser): Promise<boolean>;
    /**
     * Set a livechat visitor's custom fields by its token
     * @param token The visitor's token
     * @param key The key in the custom fields
     * @param value The value to be set
     * @param overwrite Whether overwrite or not
     *
     * @returns Promise to whether success or not
     */
    setCustomFields(token: IVisitor['token'], key: string, value: string, overwrite: boolean): Promise<boolean>;
}