IncomingCallCommon interface
The incoming call common interface.
Properties
| call |
Containing code/subCode indicating how call ended. |
| caller |
Identifier of the caller. |
| custom |
Options sent as custom context. |
| id | Get the unique Id for this Call. |
| kind | Get the kind of incoming call oject. |
| transferor |
Transfer initiator in case of transfer/forward scenarios. |
Methods
| off("call |
Unsubscribe function for onCallEnded event. |
| off("caller |
Unsubscribe function for onCallEnded event. |
| off("transferor |
Unsubscribe function for onCallEnded event. |
| on("call |
Subscribe function for onCallEnded event. |
| on("caller |
Subscribe function for onCallEnded event. |
| on("transferor |
Subscribe function for onCallEnded event. |
| reject() | Reject this incoming Call. |
Property Details
callEndReason
Containing code/subCode indicating how call ended.
callEndReason?: CallEndReasonProperty Value
callerInfo
customContext
id
Get the unique Id for this Call.
id: stringProperty Value
string
kind
transferorInfo
Note
This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Transfer initiator in case of transfer/forward scenarios.
transferorInfo?: CallerInfoProperty Value
Method Details
off("callEnded", CallEndedEvent)
Unsubscribe function for onCallEnded event.
function off(event: "callEnded", listener: CallEndedEvent)Parameters
- event
-
"callEnded"
event name.
- listener
- CallEndedEvent
callback fn that was used to subscribe to this event.
off("callerInfoChanged", PropertyChangedEvent)
Note
This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Unsubscribe function for onCallEnded event.
function off(event: "callerInfoChanged", listener: PropertyChangedEvent)Parameters
- event
-
"callerInfoChanged"
event name.
- listener
- PropertyChangedEvent
callback fn that was used to subscribe to this event.
off("transferorInfoChanged", PropertyChangedEvent)
Note
This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Unsubscribe function for onCallEnded event.
function off(event: "transferorInfoChanged", listener: PropertyChangedEvent)Parameters
- event
-
"transferorInfoChanged"
event name.
- listener
- PropertyChangedEvent
callback fn that was used to subscribe to this event.
on("callEnded", CallEndedEvent)
Subscribe function for onCallEnded event.
function on(event: "callEnded", listener: CallEndedEvent)Parameters
- event
-
"callEnded"
event name.
- listener
- CallEndedEvent
callback fn that was used to subscribe to this event.
on("callerInfoChanged", PropertyChangedEvent)
Note
This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Subscribe function for onCallEnded event.
function on(event: "callerInfoChanged", listener: PropertyChangedEvent)Parameters
- event
-
"callerInfoChanged"
event name.
- listener
- PropertyChangedEvent
callback fn that was used to subscribe to this event.
on("transferorInfoChanged", PropertyChangedEvent)
Note
This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Subscribe function for onCallEnded event.
function on(event: "transferorInfoChanged", listener: PropertyChangedEvent)Parameters
- event
-
"transferorInfoChanged"
event name.
- listener
- PropertyChangedEvent
callback fn that was used to subscribe to this event.
reject()
Reject this incoming Call.
function reject(): Promise<void>Returns
Promise<void>