Description
The ReceiverEnable method is used to enable or disable a Receiver.
Exceptions
The following GenRocket exceptions may be thrown by this method:
- If the runtime instance is currently running another Scenario
- Unable to find Domain with domainName
- Unable to find Receiver with receiverName within the given Domain
Runtime Method Signature: To Enable/Disable Receiver
Use this method signature when directly accessing the GenRocket Binary Runtime.
public void receiverEnable(String domainName, String receiverName, Boolean enable, String enableReference)
REST/Socket Payload Request
Use this API JSON request payload when making an API call to the GenRocket REST or Socket Engine.
{ "methodName": "receiverEnable", "parameters": { "domainName": "", "receiverName": "", "enable": true, // false to disable "enableReference": "" } }