Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISession

Hierarchy

  • ISession

Implemented by

Index

Properties

Methods

Properties

audioConnected

audioConnected: Promise<void>

autoAnswer

autoAnswer: boolean

endTime

endTime: any

holdState

holdState: boolean

id

id: string

isIncoming

isIncoming: boolean

localStream

localStream: MediaStream

media

media: SessionMedia

phoneNumber

phoneNumber: string

remoteIdentity

remoteIdentity: IRemoteIdentity

remoteStream

remoteStream: MediaStream

saidBye

saidBye: boolean

startTime

startTime: any

stats

stats: SessionStats

status

status: SessionStatus

Methods

accept

accepted

blindTransfer

  • blindTransfer(target: string): Promise<boolean>

  • Parameters

    • target: string

    Returns Promise<boolean>

bye

  • bye(): void

dtmf

  • dtmf(tones: string): void

hold

  • hold(): Promise<boolean>

on

  • on(event: "terminated", listener: function): this
  • on(event: "statusUpdate", listener: function): this
  • on(event: "callQualityUpdate", listener: function): this
  • on(event: "remoteIdentityUpdate", listener: function): this

  • Parameters

    • event: "terminated"
    • listener: function
        • (__namedParameters: object): void

        • Parameters

          • __namedParameters: object

          Returns void

    Returns this

  • Parameters

    • event: "statusUpdate"
    • listener: function
        • (session: object): void

        • Parameters

          • session: object

          Returns void

    Returns this

  • Parameters

    • event: "callQualityUpdate"
    • listener: function

        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "remoteIdentityUpdate"
    • listener: function

        • Parameters

          Returns void

    Returns this

reinvite

  • reinvite(): Promise<void>

reject

  • reject(rejectOptions: InvitationRejectOptions): Promise<void>

  • Parameters

    • Optional rejectOptions: InvitationRejectOptions

    Returns Promise<void>

terminate

  • terminate(): Promise<OutgoingByeRequest>

terminated

  • terminated(): Promise<string | void>

unhold

  • unhold(): Promise<boolean>

Generated using TypeDoc