com::pcbsys::nirvana::nAdminAPI::nCustomHeader Class Reference

This Class represent a single custom header field which will be used by javascript. More...

#include <nCustomHeader.h>

Public Member Functions

std::string getKey ()
 The header key field. More...
 
std::string getUserAgents ()
 The user agents this applies to. More...
 
std::string getValue ()
 The header value. More...
 
 nCustomHeader (std::string key, std::string value, std::string userAgents)
 A custom header deceleration for javascript. More...
 
void setMyUserAgents (std::string myUserAgents)
 Sets the user agents this header field will apply to. More...
 
void setMyValue (std::string value)
 Sets the value for the header field. More...
 

Detailed Description

This Class represent a single custom header field which will be used by javascript.

Constructor & Destructor Documentation

com::pcbsys::nirvana::nAdminAPI::nCustomHeader::nCustomHeader ( std::string  key,
std::string  value,
std::string  userAgents 
)

A custom header deceleration for javascript.

Parameters
keythe header value
valuethe header value (optional)
userAgentsset this to '*' if you wish this to apply to all javascript communications or a comma separated list of specific user agents
Exceptions
nIllegalArgumentExceptionif the key is less than 1 character

Member Function Documentation

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
myUserAgentssets 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
valuethe value of the header field