API Method ReceiversRemove

This method removes all Receivers from a given Domain.

Exceptions

The following GenRocket exceptions may be thrown by this method:

• If the runtime instance is currently running another Scenario.
• If the requested domainName is not found.

Runtime Method Signature

Use this method signature when directly accessing the GenRocket binary runtime.

public void receiversRemove(String domainName)

REST/Socket Payload Request

Use this API JSON request payload when making an API call to the GenRocket REST or Socket Engine.

{
  "interfaceType": "Manual",
  "methodName": "receiversRemove",
  "parameters": {
    "domainName": ""
  }
}

REST/Socket Payload Successful Payload Response

The API JSON response payload for this method will be empty.

{
  "responseType": "OK",
  "data": ""
}