Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Inviter

Hierarchy

  • SessionImpl
    • Inviter

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Inviter(options: any): Inviter

  • Parameters

    • options: any

    Returns Inviter

Properties

Protected _remoteIdentity

_remoteIdentity: IRemoteIdentity

Protected acceptedPromise

acceptedPromise: Promise<ISessionAccept>

audioConnected

audioConnected: Promise<void>

Protected Optional cancelled

cancelled: ISessionCancelled

holdState

holdState: boolean

id

id: string

Protected inviteOptions

inviteOptions: InviterInviteOptions

isIncoming

isIncoming: boolean

media

media: SessionMedia

saidBye

saidBye: boolean

Protected session

session: SIPInviter

stats

stats: SessionStats

status

status: SessionStatus = SessionStatus.TRYING

Protected Optional terminatedReason

terminatedReason: string

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

autoAnswer

autoAnswer:

endTime

endTime:

localStream

localStream:

phoneNumber

phoneNumber:

remoteIdentity

remoteIdentity:

remoteStream

remoteStream:

startTime

startTime:

Methods

accept

  • accept(): Promise<void>

accepted

addListener

  • addListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (args: any[]): void

        • Parameters

          • Rest args: any[]

          Returns void

    Returns this

attendedTransfer

  • attendedTransfer(target: SessionImpl): Promise<boolean>

  • Parameters

    • target: SessionImpl

    Returns Promise<boolean>

blindTransfer

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

bye

  • bye(): Promise<OutgoingByeRequest>

  • Returns Promise<OutgoingByeRequest>

cancel

  • cancel(): Promise<void>

dtmf

  • dtmf(tones: string, options: any): boolean

  • Parameters

    • tones: string
    • Optional options: any

    Returns boolean

emit

  • emit(event: string | symbol, args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

Protected extractRemoteIdentity

  • extractRemoteIdentity(): object

  • Returns object

freeze

getMaxListeners

  • getMaxListeners(): number

  • Returns number

hold

  • hold(): Promise<boolean>

invite

  • invite(): Promise<OutgoingInviteRequest>

  • Returns Promise<OutgoingInviteRequest>

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

Protected makeInviteOptions

  • makeInviteOptions(__namedParameters: object): object

  • Parameters

    • __namedParameters: object

    Returns object

off

  • off(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (args: any[]): void

        • Parameters

          • Rest args: any[]

          Returns void

    Returns this

on

  • on(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (args: any[]): void

        • Parameters

          • Rest args: any[]

          Returns void

    Returns this

once

  • once(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (args: any[]): void

        • Parameters

          • Rest args: any[]

          Returns void

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (args: any[]): void

        • Parameters

          • Rest args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (args: any[]): void

        • Parameters

          • Rest args: any[]

          Returns void

    Returns this

progressed

  • progressed(): Promise<void>

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

rebuildSessionDescriptionHandler

  • rebuildSessionDescriptionHandler(): void

  • Returns void

reinvite

  • reinvite(modifiers?: SessionDescriptionHandlerModifiers): Promise<void>

  • Parameters

    • Default value modifiers: SessionDescriptionHandlerModifiers = []

    Returns Promise<void>

reject

  • reject(): Promise<void>

  • Returns Promise<void>

removeAllListeners

  • removeAllListeners(event: string | symbol): this

  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (args: any[]): void

        • Parameters

          • Rest args: any[]

          Returns void

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

terminate

  • terminate(): Promise<OutgoingByeRequest>

terminated

  • terminated(): Promise<string | void>

tried

  • tried(): Promise<void>

unhold

  • unhold(): Promise<boolean>

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number

  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc