@becomes/cms-cloud-client/b-types/socket/main.d.ts

SDK for accessing BCMS Cloud API

import type { InstanceServerStats } from '@bcms-cloud/instance';
import type { Module } from '@becomes/purple-cheetah/types';
import { SocketEventType, SocketInstanceLogEventType } from './models';
export declare class SocketManager {
    static emit: {
        redirect(data: {
            uri: string;
            userId: string;
        }): void;
        org(data: {
            type: SocketEventType;
            orgId: string;
            users: string[];
        }): void;
        instance(data: {
            type: SocketEventType;
            orgId: string;
            instanceId: string;
            users: string[];
        }): void;
        instanceFJE(data: {
            type: SocketEventType;
            orgId: string;
            instanceId: string;
            fjeId: string;
            users: string[];
        }): void;
        instanceAdditionalFile(data: {
            type: SocketEventType;
            orgId: string;
            instanceId: string;
            afId: string;
            users: string[];
        }): void;
        feature(data: {
            type: SocketEventType;
            id: string;
            users: string[];
        }): void;
        limit(data: {
            type: SocketEventType;
            id: string;
            users: string[];
        }): void;
        invitation(data: {
            type: SocketEventType;
            orgId: string;
            instanceId: string;
            invitationId: string;
            users: string[];
        }): void;
        refresh(data: {
            userId: string;
            rewriteOrgRoute?: {
                fromNameEncoded: string;
                toNameEncoded: string;
            };
            rewriteInstanceRoute?: {
                fromNameEncoded: string;
                toNameEncoded: string;
            };
        }): void;
        user(data: {
            type: SocketEventType;
            userId: string;
            users: string[];
        }): void;
        checkoutComplete(data: {
            type: SocketEventType;
            userId: string;
            checkoutId: string;
        }): void;
        instanceLog(data: {
            type: SocketInstanceLogEventType;
            chunk: string;
            instanceId: string;
            orgId: string;
            users: string[];
        }): void;
        instanceStats(data: {
            instanceId: string;
            orgId: string;
            stats: InstanceServerStats;
            users: string[];
        }): void;
    };
}
export declare function createSocketManager(): Module;