Documentation

Class: ReceivedDataChannelInvitation

ReceivedDataChannelInvitation

ReceivedDataChannelInvitation

Defines an invitation received by this client for a call

new ReceivedDataChannelInvitation()

Fires:

Extends

Methods

<static> getAvailableEvents()

Returns available events for this class

Returns:
Type
Array.<string>

accept(options)

Accepts this invitation & notifies sender

Parameters:
Name Type Description
options object
Overrides:
Returns:

accepted DataChannel session in promise

Type
Promise.<DataChannel>

decline()

Declines this invitation & notifies sender

Overrides:
Returns:
Type
Void

getId()

Returns invitation id

Inherited From:
Overrides:
Returns:
Type
string

getReceiveTime()

Returns invitation receive time

Inherited From:
Overrides:
Returns:
Type
Date

getSender()

Returns invitation / request sender

Inherited From:
Overrides:
Returns:
Type
Contact

on(listener)

Adds a listener to a Observable event

Parameters:
Name Type Description
listener function
Inherited From:
Overrides:
Returns:

this instance for chaining

Type
Observable

removeListener(eventType, listener)

Remove existing listener to Observable event

Parameters:
Name Type Description
eventType String
listener function
Inherited From:
Overrides:
Returns:

this instance for chaining

Type
Observable

Events

expired

When the call invitation has expired (eg. caller cancelled call)

Type: Void
Deprecated:
  • Please note that this event is now deprecated as we have added a statusChange event

statusChange

Emitted invitation status change

Type: StatusChangeInfo
Inherited From:
Overrides: