Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RequestObject

Describes the format of an outgoing REST request. See {@link geocortex.request}.

docs-hide-from-nav

Hierarchy

  • RequestObject

Index

Properties

Properties

Optional callbackParamName

callbackParamName: string

The JSONP callback name to wrap the request in. The remote endpoint must support JSONP.

Optional content

content: any

Arbitrary content to send. Usually the result of a call to {@link geocortex.encodeJson}.

Optional error

error: function

Callback to fire upon an successful response from the remote endpoint.

Type declaration

    • (error: Error): void

    • The error that occurred.

      Parameters

      • error: Error

      Returns void

Optional gcx

gcx: any

Optional handleAs

handleAs: string

Optional load

load: function

Callback to fire upon a successful response from the remote endpoint.

param

The response body.

Type declaration

    • (response: any): void

    • Parameters

      • response: any

      Returns void

Optional preventCache

preventCache: boolean

If true, a "cache-busting" URL parameter is added to the outgoing request in order to circumvent HTTP request caching. This is typically a timestamp.

Optional timeout

timeout: number

url

url: string

The URL to make the request to. Typically a RESTful endpoint.