FAQ

CoPilot

API
Published: May 04, 2020
Edited: May 21, 2020

com.comcast.copilot_1

Description

This API provides controls for terminating and observing state transitions during a Copilot session.

Methods

terminate

Parameters:  none

Return Value:  none

Description:  terminates the Copilot session

getState

Parameters:  none

Return Value:  integer

Description:  reflecting the current Copilot state

 

Events

onStateChange
Payload: state: integer Description: A value representing the current Copilot state.

Valid states include:

  • 0: Uninitialized
  • 1: In Progress
  • 2: Terminating

After an existing copilot session is terminated, the state moves back to Uninitialized.

Note: The com.comcast.copilot_1 API is unable to detect the state change between the Uninitialized state and the In Progress state. It is also not capable of detecting the state change from the In Progress state to the Terminating or Unitialized states when CoPilot is terminated by the remote operator/co-pilot, but does report the appropriate states when initiated through the terminate method. However, the getState always returns the appropriate state. This is not a bug, but a current limitation of the system.

PHP Code Snippets Powered By : XYZScripts.com