Variable view

Type Declaration

• • (
        surfaceId?: any,
        options?: any,
    ): {
        received: Loose[];
        status: {
            audience: any;
            caepEnabled: boolean;
            enabled: boolean;
            held: number;
            id: any;
            inboxPath: any;
            internalReceivers: boolean;
            label: any;
            max: number;
            pushDelivery: boolean;
            realm: any;
            receivePath: any;
            riscEnabled: boolean;
            sees: any;
            ssfEnabled: boolean;
            stream: any;
            why: any[];
        };
    }

  • Returns everything a surface has as one document, { status, received }, which both the page's JSON form and GET /admin-api/signals answer with.

    Parameters

    • OptionalsurfaceId: any

      the surface's id

    • Optionaloptions: any

      person and withToken, as listFor() and describeEntry() take them

    Returns {
        received: Loose[];
        status: {
            audience: any;
            caepEnabled: boolean;
            enabled: boolean;
            held: number;
            id: any;
            inboxPath: any;
            internalReceivers: boolean;
            label: any;
            max: number;
            pushDelivery: boolean;
            realm: any;
            receivePath: any;
            riscEnabled: boolean;
            sees: any;
            ssfEnabled: boolean;
            stream: any;
            why: any[];
        };
    }

    the view