Skip to content

message.addObjectToJSON

Signature: message.addObjectToJSON(nodePath, childNode, value)

Returns: void

Add the specified childNode to the first node that matches nodePath.

Note

The value is of type 'Object' and not 'String' making this call type-aware.

Note

This method only applies to JSON-formatted messages.

Parameters

Type Name Description Default
String nodePath the node path (XPath, HPath, Column ID, etc.)
String childNode the name of the child node to add
Object value the value of the child node to add

Example

// Example of adding a JSON object to an existing JSON message.
message = qie.createJSONMessage(
    JSON.stringify(
        {
        "name":"David",
        "age":44
        }
    )
);
message.addObjectToJSON(
    '/',                // nodePath where child will be added
    'children',         // childNode name
    `[
        {
            "name":"Jenny",
            "age":14
        },
        {
            "name":"Ryan",
            "age":9
        }
    ]`                  // object value
);

// Resulting JSON:
// {
//    "name":"David",
//    "age":44,
//    "children":[
//       {"name":"Jenny","age":14},
//       {"name":"Ryan","age":9}
//    ]
// }