Config2_HttpHeaderManager

HTTP header manager for managing custom HTTP headers.

Instances of this class are obtained from:

Methods

MethodReturnsDescription
add() Config2_HttpHeader

Add a new HTTP header

.
get() Config2_HttpHeader

Get an HTTP header by field name

.
remove() void

Remove an HTTP header by field name

.
toArray() Array.<Config2_HttpHeader>

Get all HTTP headers

.

Method Details

add(fieldName, fieldValue) → {Config2_HttpHeader}

Description:

  • Add a new HTTP header

Parameters:
Name Type Description
fieldName String

Header field name
fieldValue String

Header field value
Returns:

Created header object

Type
Config2_HttpHeader

get(fieldName) → {Config2_HttpHeader|null}

Description:

  • Get an HTTP header by field name

Parameters:
Name Type Description
fieldName String

Header field name
Returns:

Header object or null if not found

Type
Config2_HttpHeader | null

remove(fieldName)

Description:

  • Remove an HTTP header by field name

Parameters:
Name Type Description
fieldName String

Header field name to remove

toArray() → {Array.<Config2_HttpHeader>}

Description:

  • Get all HTTP headers

Returns:

Array of all header objects

Type
Array.<Config2_HttpHeader>