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

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

import type { ILivechatRoom, IVisitor } from '../livechat';
import type { IUser } from '../users';
export interface IExtraRoomParams {
    source?: ILivechatRoom['source'];
    customFields?: {
        [key: string]: unknown;
    };
}
export interface ILivechatCreator {
    /**
     * Creates a room to connect the `visitor` to an `agent`.
     *
     * This method uses the Livechat routing method configured
     * in the server
     *
     * @param visitor The Livechat Visitor that started the conversation
     * @param agent The agent responsible for the room
     */
    createRoom(visitor: IVisitor, agent: IUser, extraParams?: IExtraRoomParams): Promise<ILivechatRoom>;
    /**
     * @deprecated Use `createAndReturnVisitor` instead.
     * Creates a Livechat visitor
     *
     * @param visitor Data of the visitor to be created
     */
    createVisitor(visitor: IVisitor): Promise<string>;
    /**
     * Creates a Livechat visitor
     *
     * @param visitor Data of the visitor to be created
     */
    createAndReturnVisitor(visitor: IVisitor): Promise<IVisitor | undefined>;
    /**
     * Creates a token to be used when
     * creating a new livechat visitor
     */
    createToken(): string;
}