addHeader

addHeader(key:   String;
          value: String): Integer updating;

The addHeader method of the JadeRestRequest class adds or modifies the header specified in the key parameter with the value specified in the value parameter. This method can also be used to remove an existing header, by setting the value parameter to null (that is, an empty string).

This method returns the:

• AddHeader_Success constant when the header was successfully added or modified.

• AddHeader_Forbidden constant when the header cannot be modified due to it being forbidden, as some HTTP headers cannot be modified programmatically. These are normally the headers that are set automatically during processing. The special forbidden headers that cannot be modified are listed at:

  https://developer.mozilla.org/en-US/docs/Glossary/Forbidden_header_name

2022.0.01 and higher