Client Control 2.6.0

The client control API gives the user the ability to apply different commands to connected clients (e.g. disconnect a client). These commands can be requested via the plugins control API. A controlling client can publish requests to $CONTROL/cedalo/client-control/v1 and the related response message will be published by the plugin on $CONTROL/cedalo/client-control/v1/response.

Note: Using this plugin requires a valid license. All commands will return an error if it is expired or could not be read.

Operations

  • PUB $CONTROL/cedalo/client-control/v1

    Accepts the following message:

    Request to apply a client actioncontrolRequest
    object
    uid: controlRequestPayload

    Examples

  • SUB $CONTROL/cedalo/client-control/v1/response

    Accepts the following message:

    Response to an executed client action requestcontrolResponse
    object
    uid: controlResponsePayload

    Examples

Messages

  • #1Request to apply a client actioncontrolRequest
    object
    uid: controlRequestPayload
  • #2Response to an executed client action requestcontrolResponse
    object
    uid: controlResponsePayload

Schemas

  • object
    uid: controlRequestPayload
  • object
    uid: controlResponsePayload
  • correlationData
    string
    uid: correlationData

    This is an optional value to be able to identify the relation between request and response. The plugin will add the provided value in the response message.

      Examples values:
    • "716cc776-d044-4772-b991-d9b55e2e034c"