Class RequestContext

Represents an HTTP request context

Index

Constructors

Methods

addCookie getAgent getBody getHeaders getHttpMethod getUrl setAgent setBody setHeaderParam setQueryParam setUrl

Constructors

constructor

new RequestContext(url, httpMethod): RequestContext
Creates the request context using a http method and request resource url
Parameters
- url: string
  url of the requested resource
- httpMethod: HttpMethod
  http method
Returns RequestContext
- Defined in codegen/communication_preferences/http/http.ts:66

Methods

addCookie

addCookie(name, value): void
Sets a cookie with the name and value. NO check for duplicate cookies is performed
Parameters
- name: string
- value: string
Returns void
- Defined in codegen/communication_preferences/http/http.ts:121

getAgent

getAgent(): undefined | Agent | Agent
Returns undefined | Agent | Agent
- Defined in codegen/communication_preferences/http/http.ts:136

getBody

getBody(): RequestBody
Returns RequestBody
- Defined in codegen/communication_preferences/http/http.ts:109

getHeaders

getHeaders(): {
[key: string]: string;
}
Returns {
[key: string]: string;
}
- [key: string]: string
- Defined in codegen/communication_preferences/http/http.ts:105

getHttpMethod

getHttpMethod(): HttpMethod
Returns HttpMethod
- Defined in codegen/communication_preferences/http/http.ts:101

getUrl

getUrl(): string
Returns string
- Defined in codegen/communication_preferences/http/http.ts:74

setAgent

setAgent(agent): void
Parameters
- agent: Agent | Agent
Returns void
- Defined in codegen/communication_preferences/http/http.ts:132

setBody

setBody(body): void
Sets the body of the http request either as a string or FormData

Note that setting a body on a HTTP GET, HEAD, DELETE, CONNECT or TRACE request is discouraged. https://httpwg.org/http-core/draft-ietf-httpbis-semantics-latest.html#rfc.section.7.3.1
Parameters
- body: RequestBody
  the body of the request
Returns void
- Defined in codegen/communication_preferences/http/http.ts:97

setHeaderParam

setHeaderParam(key, value): void
Parameters
- key: string
- value: string
Returns void
- Defined in codegen/communication_preferences/http/http.ts:128

setQueryParam

setQueryParam(name, value): void
Parameters
- name: string
- value: string
Returns void
- Defined in codegen/communication_preferences/http/http.ts:113

setUrl

setUrl(url): void
Replaces the url set in the constructor with this url.
Parameters
- url: string
Returns void
- Defined in codegen/communication_preferences/http/http.ts:84