Documentation

Class: ReceivedCallInvitation

ReceivedCallInvitation

ReceivedCallInvitation

Defines an invitation received by this client for a call

new ReceivedCallInvitation()

Fires:

Extends

Methods

<static> getAvailableEvents()

Returns available events for this class

Returns:
Type
Array.<string>

accept(stream, options)

Accepts this invitation & notifies sender, returns Call object through Promise

Parameters:
Name Type Description
stream Stream

Optional, if set, the stream will be published for this call
options AnswerOptions
Overrides:
Returns:

accepted call in promise

Type
Promise.<Call>

decline()

Declines the call invitation & notifies sender

Overrides:
Returns:
Type
Void

getCall()

Returns associated conversation

Returns:
Type
Call

getCallType()

Returns call type

Returns:
Type
String

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

isRecorded()

Returns whether call is recorded or not

Returns:
Type
boolean

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

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