OzWebClient class

The OzWebClient class contains methods for connecting the webclient to the Ozeki Phone System and disconnecting from it. The webclient class is the main communication interface between Ozeki Phone System and Javascript. It has a method for creating a call. There are also several events in it.

Properties

Property	Description
isReady	Tells whether the flash object and the WebClient is ready.
helper	A Helper class instance.
activeCalls	Contains the active calls the WebClient currently handles.
activeSessions	Contains the active sessions in Ozeki Phone System.
extensions	Contains information about the extensions and outside lines configured in Ozeki Phone System.
users	Contains information about the users configured in Ozeki Phone System.

Methods

Method	Description
OzWebClient.connect(serverAddress, token, properties)	Connects the webclient to Ozeki Phone System.
OzWebClient.createCall(dialedNumber, callType)	This is the constructor of a call object.
OzWebClient.checkWebphoneState(serverAddress, webphoneId, callback)	It is used to check if the webphone is available.
OzWebClient.disconnect()	Disconnects the webclient from Ozeki Phone System.
OzWebClient.getCallHistory(filters)	Initiates a call history query request to Ozeki Phone System. *
OzWebClient.setupCall(caller, callee)	Creates a call between two extensions configured in Ozeki Phone System.

* Can only be used if the connected webclient has the required privilege.

Events

Event	Description
OzWebClient.onCallHistoryInfoReceived	This event occurs when the result of the query initiated from the getCallHistory function has been received.
OzWebClient.onClientStateChanged	This event occurs when the state of the webclient changes.
OzWebClient.onConnectionStateChanged	This event occurs when the state of the connection changes.
OzWebClient.onErrorOccured	This event occurs if an error message has been received from Ozeki Phone System.
OzWebClient.onExtensionInfoReceived	This event occurs when the webclient receives information about an extension.
OzWebClient.onExtensionRemoved	This event occurs when the webclient receives information about an extension which has been removed.
OzWebClient.onIncomingCall	This event occurs when the webclient receives an incoming call.
OzWebClient.onSessionCreated	This event occurs if a new Session has been created e.g. a new session has started in Ozeki Phone System.
OzWebClient.onSessionClosed	This event occurs when an active session has been closed.
OzWebClient.onUserInfoReceived	This event occurs when the webclient receives information about a user.
OzWebClient.onUserRemoved	This event occurs when the webclient receives information about a user being removed from Ozeki Phone Sytem XE.
OzWebClient.onWebphoneStateReceived	This event occurs when the state of the webphone is received.

Enumerations

ConnectionState:

CONNECTION_CLOSED: "CONNECTION_CLOSED"
CONNECTION_FAILED: "CONNECTION_FAILED"
ACCESS_GRANTED: "ACCESS_GRANTED",
ACCESS_DENIED: "ACCESS_DENIED"

If you have any questions or need assistance, please contact us at info@ozekiphone.com