message.addProlog¶
Signature: message.addProlog(prolog*)
Returns: void
Add the XML prolog or XML declaration.
Note
This method only applies to XML formatted messages.
Parameters¶
| Type | Name | Description | Default |
|---|---|---|---|
| String | prolog* | (optional) the prolog value to use or leave blank to use the default prolog <?xml version="1.0" encoding="UTF-8" standalone="no"?> | <?xml version="1.0" encoding="UTF-8" standalone="no"?> |
Example¶
// Given an XML message WITHOUT an XML prolog:
message = qie.createXMLMessage(
`
<person>
<name>Bob</name>
<age>52</age>
</person>
`
);
// Add the default XML prolog
message.addProlog();
// Resulting XML (default prolog is added):
// <?xml version="1.0" encoding="UTF-8" standalone="no"?>
// <person>
// <name>Bob</name>
// <age>52</age>
// </person>
// --------------------------------------------------
// Example using a custom XML prolog
// --------------------------------------------------
message.addProlog(
'<?xml version="1.0" encoding="UTF-8"?>'
);
// Resulting XML (custom prolog):
// <?xml version="1.0" encoding="UTF-8"?>
// <person>
// <name>Bob</name>
// <age>52</age>
// </person>