This Class represent a single custom header field which will be used by javascript.
More...
#include <nCustomHeader.h>
This Class represent a single custom header field which will be used by javascript.
com::pcbsys::nirvana::nAdminAPI::nCustomHeader::nCustomHeader |
( |
std::string |
key, |
|
|
std::string |
value, |
|
|
std::string |
userAgents |
|
) |
| |
A custom header deceleration for javascript.
- Parameters
-
key | the header value |
value | the header value (optional) |
userAgents | set this to '*' if you wish this to apply to all javascript communications or a comma separated list of specific user agents |
- Exceptions
-
nIllegalArgumentException | if the key is less than 1 character |
std::string com::pcbsys::nirvana::nAdminAPI::nCustomHeader::getKey |
( |
| ) |
|
The header key field.
- Returns
- the header key
std::string com::pcbsys::nirvana::nAdminAPI::nCustomHeader::getUserAgents |
( |
| ) |
|
The user agents this applies to.
- Returns
- the user agents
std::string com::pcbsys::nirvana::nAdminAPI::nCustomHeader::getValue |
( |
| ) |
|
The header value.
- Returns
- the header value
void com::pcbsys::nirvana::nAdminAPI::nCustomHeader::setMyUserAgents |
( |
std::string |
myUserAgents | ) |
|
Sets the user agents this header field will apply to.
- Parameters
-
myUserAgents | sets the user agents this applies (* for all agents) |
void com::pcbsys::nirvana::nAdminAPI::nCustomHeader::setMyValue |
( |
std::string |
value | ) |
|
Sets the value for the header field.
- Parameters
-
value | the value of the header field |