Socket Handler - UNC-Project-Open-AAC/OS-DPI GitHub Wiki

Socket Handler

Allow communicating with an external service via a WebSocket. Each time an Action updates the named State variable the external service will receive the following in a UTF-8 JSON encoded message:

{
  method: string -- the name of the Method
  stateName: string -- the name of the trigger variable
  URL: string -- the URL of the service
  state: Object -- the current values of all the State variables
  content: Array of Objects -- any rows from the Content spreadsheet that were selected by the Filters
}

The service may send data back to OS-DPI with a UTF-8 JSON encoded message. Simple values in the JSON will be passed as Fields. Arrays of Objects will be prepended to the Content as new Rows of data.

Properties

State Name

The State variable that will trigger sending a message to the external process.

URL

The URL of the external process.

Components you may add

Backlinks