Class: Call

Methods

accept()

Accepts a call coming to the webclient.

Source:

• webphone.js, line 640

See:

• http://ozekiphone.com/accept-811.html

attachCamera(cam)

Attaches the video stream of a camera to the call.

Parameters:

Name	Type	Description
cam	Camera	The Camera object to be attached.

Source:

• webphone.js, line 765

See:

• http://ozekiphone.com/attachcamera-938.html

forward(target)

Forwards the call while not picked up.

Parameters:

Name	Type	Description
target	string	The target phone number.

Source:

• webphone.js, line 685

See:

• http://ozekiphone.com/forward-target-815.html

Throws:

Will throw an exception if the target was not specified.

getCallState() → {string}

Returns the callstate of the current call.

Source:

• webphone.js, line 730

See:

• http://ozekiphone.com/getcallstate-822.html

Returns:

The current state of the call.

Type

string

getOtherParty() → {string}

Returns the phone number of the other party.

Source:

• webphone.js, line 740

See:

• http://ozekiphone.com/getotherparty-823.html

Returns:

The phone number of the other party.

Type

string

hangUp()

Hangs up the call.

Source:

• webphone.js, line 650

See:

• http://ozekiphone.com/hangup-812.html

hold()

Holds the calls

Source:

• webphone.js, line 697

See:

• http://ozekiphone.com/hold-816.html

onCallStateChanged(callback)

This event occurs when the state of the call changes.

Parameters:

Name	Type	Description
callback	Call~callStateChangedCallback	the callback function to handle the call state change event.

Source:

• webphone.js, line 800

See:

• http://ozekiphone.com/oncallstatechanged-819.html

onMessageReceived(callback)

This event occurs when a message is received.

Parameters:

Name	Type	Description
callback	Call~messageReceivedCallback	the callback function to handle the message received.

Source:

• webphone.js, line 784

See:

• http://ozekiphone.com/onmessagereceived-821.html

reject()

Rejects a call coming to the webclient.

Source:

• webphone.js, line 660

See:

• http://ozekiphone.com/reject-813.html

sendMessage(message)

Sends a message to the other party.

Parameters:

Name	Type	Description
message	string	The message to be sent.

Source:

• webphone.js, line 717

See:

• http://ozekiphone.com/sendmessage-818.html

Throws:

Will throw an exception if no message is specified.

setRemoteDisplay(displayId)

Displays the video stream coming from the other party.

Parameters:

Name	Type	Argument	Default	Description
displayId	string	<optional>	'local'	The ID of the html element to where the camera stream will be shown.

Source:

• webphone.js, line 750

See:

• http://ozekiphone.com/setremotedisplay-937.html

start()

Starts the call.

Source:

• webphone.js, line 630

See:

• http://ozekiphone.com/start-810.html

transfer(target)

Transfers the call after its picked up.

Parameters:

Name	Type	Description
target	string	The target phone number.

Source:

• webphone.js, line 671

See:

• http://ozekiphone.com/transfer-target-814.html

Throws:

Will throw an exception if the target was not specified.

unHold()

Unholds the calls

Source:

• webphone.js, line 706

See:

• http://ozekiphone.com/unhold-817.html

Type Definitions

callStateChangedCallback(state)

This callback is used to handle call state changes.

Parameters:

Name	Type	Description
state	CallState	The state of the call.

Source:

• webphone.js, line 788

messageReceivedCallback(message)

This callback is used to handle message receiving.

Parameters:

Name	Type	Description
message	string	The message received.

Source:

• webphone.js, line 772