Class Invitation

Hierarchy

SessionImpl
- Invitation

Implements

ISession

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new Invitation(options: any): Invitation

Overrides SessionImpl.__constructor
- Defined in invitation.ts:9
Parameters
- options: any
Returns Invitation

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: SIPInvitation

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>

Implementation of ISession.accept

Overrides SessionImpl.accept
- Defined in invitation.ts:24
Returns Promise<void>

accepted

accepted(): Promise<ISessionAccept>

Implementation of ISession.accepted

Overrides SessionImpl.accepted
- Defined in invitation.ts:39
Returns Promise<ISessionAccept>

addListener

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

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in /home/runner/work/WebphoneLib/WebphoneLib/node_modules/@types/node/events.d.ts:11
Parameters
- event: string | symbol
- listener: function
  - - (args: any[]): void
    - Parameters
      - Rest args: any[]
      Returns void
Returns this

attendedTransfer

attendedTransfer(target: SessionImpl): Promise<boolean>

Inherited from SessionImpl.attendedTransfer
- Defined in session.ts:332
Parameters
- target: SessionImpl
Returns Promise<boolean>

blindTransfer

blindTransfer(target: string): Promise<boolean>

Implementation of ISession.blindTransfer

Inherited from SessionImpl.blindTransfer
- Defined in session.ts:322
Parameters
- target: string
Returns Promise<boolean>

bye

bye(): Promise<OutgoingByeRequest>

Implementation of ISession.bye

Inherited from SessionImpl.bye
- Defined in session.ts:350
Returns Promise<OutgoingByeRequest>

cancel

cancel(): Promise<void>

- Defined in invitation.ts:51
Returns Promise<void>

dtmf

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

Inherited from SessionImpl.dtmf
- Defined in session.ts:357
Parameters
- tones: string
- Optional options: any
Returns boolean

emit

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

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in /home/runner/work/WebphoneLib/WebphoneLib/node_modules/@types/node/events.d.ts:23
Parameters
- event: string | symbol
- Rest args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in /home/runner/work/WebphoneLib/WebphoneLib/node_modules/@types/node/events.d.ts:24
Returns Array<string | symbol>

Protected extractRemoteIdentity

extractRemoteIdentity(): object

Inherited from SessionImpl.extractRemoteIdentity
- Defined in session.ts:470
Returns object

freeze

freeze(): ISession

Inherited from SessionImpl.freeze
- Defined in session.ts:382
Returns ISession

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in /home/runner/work/WebphoneLib/WebphoneLib/node_modules/@types/node/events.d.ts:20
Returns number

hold

hold(): Promise<boolean>

Implementation of ISession.hold

Inherited from SessionImpl.hold
- Defined in session.ts:314
Returns Promise<boolean>

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in /home/runner/work/WebphoneLib/WebphoneLib/node_modules/@types/node/events.d.ts:25
Parameters
- type: string | symbol
Returns number

listeners

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

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in /home/runner/work/WebphoneLib/WebphoneLib/node_modules/@types/node/events.d.ts:21
Parameters
- event: string | symbol
Returns Function[]

Protected makeInviteOptions

makeInviteOptions(__namedParameters: object): object

Inherited from SessionImpl.makeInviteOptions
- Defined in session.ts:421
Parameters
- __namedParameters: object
Returns object

off

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

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in /home/runner/work/WebphoneLib/WebphoneLib/node_modules/@types/node/events.d.ts:17
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

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in /home/runner/work/WebphoneLib/WebphoneLib/node_modules/@types/node/events.d.ts:12
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

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in /home/runner/work/WebphoneLib/WebphoneLib/node_modules/@types/node/events.d.ts:13
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

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in /home/runner/work/WebphoneLib/WebphoneLib/node_modules/@types/node/events.d.ts:14
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

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /home/runner/work/WebphoneLib/WebphoneLib/node_modules/@types/node/events.d.ts:15
Parameters
- event: string | symbol
- listener: function
  - - (args: any[]): void
    - Parameters
      - Rest args: any[]
      Returns void
Returns this

rawListeners

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

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in /home/runner/work/WebphoneLib/WebphoneLib/node_modules/@types/node/events.d.ts:22
Parameters
- event: string | symbol
Returns Function[]

rebuildSessionDescriptionHandler

rebuildSessionDescriptionHandler(): void

Inherited from SessionImpl.rebuildSessionDescriptionHandler
- Defined in session.ts:345
Returns void

reinvite

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

Inherited from SessionImpl.reinvite
- Defined in session.ts:299
Parameters
- Default value modifiers: SessionDescriptionHandlerModifiers = []
Returns Promise<void>

reject

reject(rejectOptions: InvitationRejectOptions): Promise<void>

Implementation of ISession.reject

Overrides SessionImpl.reject
- Defined in invitation.ts:43
Parameters
- Optional rejectOptions: InvitationRejectOptions
Returns Promise<void>

removeAllListeners

removeAllListeners(event: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in /home/runner/work/WebphoneLib/WebphoneLib/node_modules/@types/node/events.d.ts:18
Parameters
- Optional event: string | symbol
Returns this

removeListener

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

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in /home/runner/work/WebphoneLib/WebphoneLib/node_modules/@types/node/events.d.ts:16
Parameters
- event: string | symbol
- listener: function
  - - (args: any[]): void
    - Parameters
      - Rest args: any[]
      Returns void
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in /home/runner/work/WebphoneLib/WebphoneLib/node_modules/@types/node/events.d.ts:19
Parameters
- n: number
Returns this

terminate

terminate(): Promise<OutgoingByeRequest>

Implementation of ISession.terminate

Inherited from SessionImpl.terminate
- Defined in session.ts:291
Returns Promise<OutgoingByeRequest>

terminated

terminated(): Promise<string | void>

Implementation of ISession.terminated

Inherited from SessionImpl.terminated
- Defined in session.ts:295
Returns Promise<string | void>

tried

tried(): Promise<void>

- Defined in invitation.ts:47
Returns Promise<void>

unhold

unhold(): Promise<boolean>

Implementation of ISession.unhold

Inherited from SessionImpl.unhold
- Defined in session.ts:318
Returns Promise<boolean>

Static listenerCount

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

Inherited from EventEmitter.listenerCount
- Defined in /home/runner/work/WebphoneLib/WebphoneLib/node_modules/@types/node/events.d.ts:8
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc