API Method ReceiverPropertyKeyValueSet

This method sets the value of a given ReceiverPropertyKey.

Exceptions

The following GenRocket exceptions may be thrown by this method:

• If the runtime instance is currently running another Scenario.
• If the requested attributeName is not found.
• If the requested receiverName is not found.
• If the requested propertyKeyName is not found.

Runtime Method Signature

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

public void receiverPropertyKeyValueSet(String attributeName, String receiverName, String propertyKeyName, String value)

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

{
  "interfaceType": "Manual",
  "methodName": "receiverPropertyKeyValueSet",
  "parameters": {
    "attributeName": "",
    "receiverName": "",
    "propertyKeyName": "",
    "value": ""
  }
}

REST/Socket Payload Successful Payload Response

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

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