@docsvision/webclient/System/IWebServicesConnection.d.ts

Type definitions for DocsVision WebClient scripts and extensions.

import { IWebServicesRequest } from '@docsvision/webclient/System/IWebServicesRequest';
/** Класс для взаимоедйствия с агентом веб-сервисов через веб-сокеты. {@see IWebServicesService} */
export interface IWebServicesConnection {
    /** Наименование роута плагина, с которым открыто соединение. */
    readonly plugin: string;
    /** Проверяет, что подключение открыто. */
    readonly isOpen: boolean;
    /** Отправляет запрос в агент. */
    send<T>(message: IWebServicesRequest<T>): void;
    /** Возвращает ответ агента, после его получения. */
    waitForMessage<T>(): Promise<T>;
    /** Закрывает соединение. */
    close(): void;
    /** Обработчик, вызываемый при закрытии соединения. */
    onCloseConnectionHandler: () => void;
}