Interface ScriptRequest

HTTP Request.

Hierarchy

ScriptRequest

Properties

acceptableMediaTypes

acceptableMediaTypes: string

attributeNames

attributeNames: any[]

bodyAsString

bodyAsString: string

Get the body of this Request. If this request does not have a body, return the empty String.

clientCertificate

clientCertificate: null | ScriptCertificate

clientIpAddress

clientIpAddress: string

formParameterNames

formParameterNames: any[]

method

method: string

parameterNames

parameterNames: any[]

parsedBodyAsJson

parsedBodyAsJson: null | object

Get the body of this Request in JSON format. If the request doesn't contain a valid JSON body returns null

path

path: null | string

queryParameterNames

queryParameterNames: any[]

queryString

queryString: null | string

scheme

scheme: string

url

url: string

Methods

getAcceptableMediaTypes

getAcceptableMediaTypes(): string
Returns string
- Defined in typescript-definitions.ts:3491

getAttribute

getAttribute(name: null | string): any
Parameters
- name: null | string
Returns any
- Defined in typescript-definitions.ts:3499

getAttributeNames

getAttributeNames(): any[]
Returns any[]
- Defined in typescript-definitions.ts:3501

getBodyAsString

getBodyAsString(): string
Get the body of this Request. If this request does not have a body, return the empty String.

Returns string
- Defined in typescript-definitions.ts:3508

getClientCertificate

getClientCertificate(): null | ScriptCertificate
Returns null | ScriptCertificate
- Defined in typescript-definitions.ts:3515

getClientIpAddress

getClientIpAddress(): string
Returns string
- Defined in typescript-definitions.ts:3519

getCookie

getCookie(name: string): null | string
Parameters
- name: string
Returns null | string
- Defined in typescript-definitions.ts:3527

getEncryptedCookie

getEncryptedCookie(name: string): null | string
Parameters
- name: string
Returns null | string
- Defined in typescript-definitions.ts:3533

getFormParameter

getFormParameter(formParameterName: null | string): null | string
Parameters
- formParameterName: null | string
Returns null | string
- Defined in typescript-definitions.ts:3539

getFormParameterNames

getFormParameterNames(): any[]
Returns any[]
- Defined in typescript-definitions.ts:3541

getFormParameterValueOrError

getFormParameterValueOrError(parameterName: null | string): null | string
Get form parameter value of error if the parameter has more than one value.
Parameters
- parameterName: null | string
Returns null | string
- Defined in typescript-definitions.ts:3550
getFormParameterValueOrError(formParameterName: null | string, exceptionSupplier: any): null | string
Get form parameter value of error if the parameter has more than one value.
Parameters
- formParameterName: null | string
- exceptionSupplier: any
Returns null | string
- Defined in typescript-definitions.ts:3558

getFormParameterValues

getFormParameterValues(formParameterName: null | string): any[]
Parameters
- formParameterName: null | string
Returns any[]
- Defined in typescript-definitions.ts:3564

getHeader

getHeader(headerName: null | string): null | string
Parameters
- headerName: null | string
Returns null | string
- Defined in typescript-definitions.ts:3570

getHeaders

getHeaders(headerName: null | string): any[]
Parameters
- headerName: null | string
Returns any[]
- Defined in typescript-definitions.ts:3576

getMethod

getMethod(): string
Returns string
- Defined in typescript-definitions.ts:3578

getParameter

getParameter(parameterName: null | string): null | string
Parameters
- parameterName: null | string
Returns null | string
- Defined in typescript-definitions.ts:3586

getParameterNames

getParameterNames(): any[]
Returns any[]
- Defined in typescript-definitions.ts:3588

getParameterValueOrError

getParameterValueOrError(parameterName: null | string): null | string
Get form parameter value of error if the parameter has more than one value.
Parameters
- parameterName: null | string
Returns null | string
- Defined in typescript-definitions.ts:3597
getParameterValueOrError(parameterName: null | string, exceptionSupplier: any): null | string
Get form parameter value of error if the parameter has more than one value.
Parameters
- parameterName: null | string
- exceptionSupplier: any
Returns null | string
- Defined in typescript-definitions.ts:3605

getParameterValues

getParameterValues(parameterName: null | string): any[]
Parameters
- parameterName: null | string
Returns any[]
- Defined in typescript-definitions.ts:3611

getParsedBodyAsJson

getParsedBodyAsJson(): null | object
Get the body of this Request in JSON format. If the request doesn't contain a valid JSON body returns null

Returns null | object
- Defined in typescript-definitions.ts:3616

getPath

getPath(): null | string
Returns null | string
- Defined in typescript-definitions.ts:3623

getQueryParameter

getQueryParameter(queryParameterName: null | string): null | string
Parameters
- queryParameterName: null | string
Returns null | string
- Defined in typescript-definitions.ts:3631

getQueryParameterNames

getQueryParameterNames(): any[]
Returns any[]
- Defined in typescript-definitions.ts:3633

getQueryParameterValues

getQueryParameterValues(queryParameterName: null | string): any[]
Parameters
- queryParameterName: null | string
Returns any[]
- Defined in typescript-definitions.ts:3641

getQueryString

getQueryString(): null | string
Returns null | string
- Defined in typescript-definitions.ts:3643

getScheme

getScheme(): string
Returns string
- Defined in typescript-definitions.ts:3647

getSignedCookie

getSignedCookie(name: string): null | string
Parameters
- name: string
Returns null | string
- Defined in typescript-definitions.ts:3655

getUrl

getUrl(): string
Returns string
- Defined in typescript-definitions.ts:3657

isGetRequest

isGetRequest(): boolean
Returns boolean
- Defined in typescript-definitions.ts:3661

isPostRequest

isPostRequest(): boolean
Returns boolean
- Defined in typescript-definitions.ts:3663

Interface ScriptRequest

Hierarchy

Index

Properties

Methods

Properties

acceptableMediaTypes

attributeNames

bodyAsString

clientCertificate

clientIpAddress

formParameterNames

method

parameterNames

parsedBodyAsJson

path

queryParameterNames

queryString

scheme

url

Methods

getAcceptableMediaTypes

Returns string

getAttribute

Parameters

name: null | string

Returns any

getAttributeNames

Returns any[]

getBodyAsString

Returns string

getClientCertificate

Returns null | ScriptCertificate

getClientIpAddress

Returns string

getCookie

Parameters

name: string

Returns null | string

getEncryptedCookie

Parameters

name: string

Returns null | string

getFormParameter

Parameters

formParameterName: null | string

Returns null | string

getFormParameterNames

Returns any[]

getFormParameterValueOrError

Parameters

parameterName: null | string

Returns null | string

Parameters

formParameterName: null | string

exceptionSupplier: any

Returns null | string

getFormParameterValues

Parameters

formParameterName: null | string

Returns any[]

getHeader

Parameters

headerName: null | string

Returns null | string

getHeaders

Parameters

headerName: null | string

Returns any[]

getMethod

Returns string

getParameter

Parameters

parameterName: null | string

Returns null | string

getParameterNames

Returns any[]

getParameterValueOrError

Parameters

parameterName: null | string