Constructor
new TelephonyConversation()
- Since:
- 11.7.0
Members
(static) callState :String
Current call state of telephony conversation.
Type:
- String
(static) capabilities :TelephonyConversationCapabilities
List of capable actions that telephony conversation can perform.
Type:
(static) states :TelephonyConversationStates
List of different active/inactive conversation states.
Type:
Methods
(static) answerAudio(errorHandleropt)
Answers incoming telephony conversation with audio.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) answerVideo(errorHandleropt)
Answers incoming telephony conversation with video.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) completeTransfer(errorHandleropt)
Completes telephony conversation transfer that was previously initiated.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
- See:
-
- transferConversation
(static) end(errorHandleropt)
Ends telephony conversation/
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) hold(errorHandleropt)
Puts telephony conversation on hold.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) merge(conversation, errorHandleropt)
Merge two telephony conversations in conference conversation.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
conversation |
TelephonyConversation | Conversation that will be merged. | |
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) muteAudio(errorHandleropt)
Mute audio on the telephony conversation.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) muteVideo(errorHandleropt)
Mute video on the telephony conversation. When video is muted remote side will still receive video but it will
only see 'frozen' frame.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) reject(errorHandleropt)
Rejects(Immediate Divert) incoming telephony conversation.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) resume(errorHandleropt)
Resumes telephony conversation that was previously been put on hold.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) sendDTMF(dtmfDigit, errorHandleropt)
Send one or more DTMF characters.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
dtmfDigit |
String | DTMF characters that will be sent. | |
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) startRemoteCameraAction(action, errorHandleropt)
Starts remote camera action.
Once this method is called remote camera will continuously perform specified action. To stop specified
action TelephonyConversation.stopRemoteCameraAction needs to be called.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
action |
String | Action to will be started. For supported camera actions please see RemoteCameraAction | |
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) startScreenShare(errorHandleropt)
Starts sharing of the screen. If this function is called and no screen has been selected for sharing through
MultimediaController.selectMonitor(), default screen will be selected for sharing. Defaulted screen is the first
screen retrieved when monitors are being enumerated during plugin initialization or the previously set monitor
through MultimediaController.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
- See:
-
- MultimedaiController
(static) startVideo(errorHandleropt)
Start sending video to other participants.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) stopRemoteCameraAction(action, errorHandleropt)
Stops remote camera action previously started with TelephonyConversation.startRemoteCameraAction.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
action |
String | Action to will be stopped. For supported camera actions please see RemoteCameraAction | |
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) stopScreenShare(errorHandleropt)
Stops sharing of the screen.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) stopVideo(errorHandleropt)
Stop sending video to to other participants.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) transferConversation(number, errorHandleropt)
Initiates conversation transfer to another directory number. In order for transfer to be complete, successive call to
completeTransfer() must be made.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
number |
Number | Number to witch conversation will be transferred. | |
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
- See:
-
- completeTransfer
(static) unmuteAudio(errorHandleropt)
Unmute audio on the telephony conversation.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) unmuteVideo(errorHandleropt)
Unmute video on the telephony conversation.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0