KioCall Object

Functions

Type Signature
bool CallUser(string idName, int ringSecs = -1)
Calls a user by id (usually email address), and returns true on success.
bool CallKiosk(string idName, int ringSecs = -1)
Calls a kiosk, and returns true on success.
bool CallGroup(string idName, bool isConferenceCall = false, int ringSecs = -1)
Calls a group, and returns true on success.
bool CallList(EndpointName[] endpointNameArray, bool isConferenceCall = false, int ringSecs = -1)
Calls a list of EndpointNames, and returns true on success.
bool IsCallActive()
Returns true if a call is currently active.
void Leave()
Leaves the current call.
void EnableSelfView(bool on)
Turns self-view on and off.
bool IsReady()
Checks if KioCall is ready to make calls.
bool ShareScreen(bool on)
Turns screen sharing on and off, and returns true on success.
UserList GetUserList()
Returns a UserList object containing logged in endpoints.
bool IsUserAvailable(string name)
Returns true if the endpoint is able to receive a call.
bool IsKioskAvailable(string name)
Returns true if the endpoint is able to recieve a call.
bool IsGroupAvailable(string name)
Returns true if the endpoint is able to recieve a call.

Page Callbacks

Type Signature
function() OnKioCallStarted
function(reasonFlags) OnKioCallEnded
function(uid) OnKioCallUserJoined
function(isReady) OnKioCallReady
function(list) OnKioCallUpdateUserList
function(en) OnKioCallUpdateUserListEntry