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

    Class Viewer

    Represents a viewer participating in an interaction, from the perspective of the interaction's owner. Returned by InteractionTrait.getViewers.

    for (const viewer of interaction.getViewers()) {
        if (viewer.canMute()) {
            await viewer.mute();
        } else if (viewer.canUnmute()) {
            await viewer.unmute();
        }
    }

    Implements

    Index

    Capability Guards

    canMute canUnmute canRemove canAssignOwner

    Identity

    id firstName? lastName? fullName? email? viewerType? externalAddress?

    Monitoring

    mute unmute remove assignOwner

    Status

    isAudio isMuted eliteSupervisorMode

    Capability Guards

    • Whether the current owner can mute this viewer right now.

      Returns boolean

    • Whether the current owner can unmute this viewer right now.

      Returns boolean

    • Whether the current owner can remove this viewer right now.

      Returns boolean

    • Whether this viewer can be promoted to owner of the interaction right now.

      Returns boolean

    Identity

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

    Monitoring

    • Mutes this viewer. Owner action. Check canMute before calling.

      Returns Promise<void>

      Promise that resolves when the server confirms the mute.

    • Unmutes this viewer. Owner action. Check canUnmute before calling.

      Returns Promise<void>

      Promise that resolves when the server confirms the unmute.

    • Removes this viewer from the interaction. Owner action. Check canRemove before calling.

      Returns Promise<void>

      Promise that resolves when the server confirms the removal.

    • Promotes this viewer to owner of the interaction. Check canAssignOwner before calling.

      Returns Promise<void>

      Promise that resolves when the server confirms the ownership change.

    Status

    • get isAudio(): boolean | undefined

      Returns boolean | undefined

    • get isMuted(): boolean | undefined

      Returns boolean | undefined

    Settings

    Member Visibility

    On This Page

    Capability Guards
    Identity
    Monitoring
    Status