API Version: Development

IPCortex.Types.Cmd

IMPORTANT: This is included here only for completeness - It is intended for use as a keevio only component.
The Cmd Class, used by the keevio side-channel

Properties

Name Type Description
type String Command type.
action String Command action.

Valid property values

Type Action Description
call kdial Side channel request to keevio to dial a call on the keevio phone line. Number is provided for verification.
call dial Side channel request to keevio to dial a call on the default line. Number is provided for verification.
call talk Side channel request to keevio answer/unhold a call. Call.id is provided for verification.
call hold Side channel request to keevio hold a call. Call.id is provided for verification.
call hangup Side channel request to keevio to hangup a call. Call.id is provided for verification.
room create Side channel request to keevio to open a room.
video start Side channel request to keevio to open a room then open videoChat.

Methods

cmd.accept([device|stream])

Kind: class method of IPCortex.Types.Cmd
Accept the remote command, passing back necessary additional information.
Parameter Type Description
device Device Device to allow a 'dial' on.
stream mediaStream mediaStream required when accepting a video start command.

cmd.reject()

Kind: class method of IPCortex.Types.Cmd
Reject the remote command.

cmd.addListener(event, callback)

Kind: class method of IPCortex.Types.Cmd
Add listener method, inherited from Api base class and common to all classes.
Parameter Type Description
event String Name of event, e.g. 'update'
callback Function Callback which is passed a reference to the updated Class object

cmd.removeListener(event, callback)

Kind: class method of IPCortex.Types.Cmd
Remove listener method, inherited from Api base class and common to all classes. event and callback must be identical to those used in addListener() in order for the remove to succeed.
Parameter Type Description
event String Name of event, e.g. 'update'
callback Function Callback which is passed a reference to the updated Class object

Events

  • new - A new cmd object is received.