@avaya/infinity-agent-sdk - v1.0.0
    Preparing search index...

    Interface ViewerDetails

    Identity and state details of a viewer participant on an interaction. Carried by viewer event payloads.

    interface ViewerDetails {
        id: string;
        firstName?: string;
        lastName?: string;
        fullName?: string;
        email?: string;
        viewerType?: string;
        isAudio?: boolean;
        isMuted?: boolean;
        eliteSupervisorMode?: EliteSupervisorMode;
        externalAddress?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    id firstName? lastName? fullName? email? viewerType? isAudio? isMuted? eliteSupervisorMode? externalAddress?

    Properties

    id: string
    firstName?: string
    lastName?: string
    fullName?: string
    email?: string
    viewerType?: string

    Viewer category (e.g. "internal", "external", "eliteSupervisor"). undefined when the platform did not classify the viewer.

    isAudio?: boolean

    Whether the viewer has joined the audio call. undefined for interactions where audio does not apply (e.g. non-voice channels).

    isMuted?: boolean

    Whether the viewer's microphone is muted. undefined for interactions where audio does not apply (e.g. non-voice channels).

    eliteSupervisorMode?: EliteSupervisorMode

    Elite supervisor monitoring mode. Only set for Elite supervisor viewers (viewerType === "eliteSupervisor") that have joined audio. undefined otherwise.

    externalAddress?: string

    External (PSTN) address for non-internal viewers (e.g. a transferred-in external party joining as a viewer). undefined for internal agent viewers.

    Settings

    Member Visibility

    On This Page

    Properties