Description

This method adds a Receiver to 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.
  • If the requested canonicalName cannot be instantiated.
  • If the requested receiverName is a duplicate within the given Domain.


Runtime Method Signature

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


public void receiverAdd(String domainName, String canonicalName, String receiverName, Map<String, String> parameterMap)


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": "receiverAdd",
  "parameters": {
    "domainName": "",
    "canonicalName": "",
    "receiverName": "",
    "parameterMap": {
        "parameterName1": "",
        "parameterName2": "",
        "parameterName3": ""
    }
  }
}


REST/Socket Payload Successful Payload Response

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


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