Class OnmsHTTPOptions

Options to be used when making HTTP ReST calls.

Index

Constructors

Properties

data headers parameters server

Accessors

Methods

toJSON newBuilder

Constructors

constructor

new OnmsHTTPOptions(timeout?, server?, auth?, headers?, parameters?, data?): OnmsHTTPOptions
Construct a new OnmsHTTPOptions object.
Parameters
- Optionaltimeout: number
- Optionalserver: OnmsServer
- Optionalauth: OnmsAuthConfig
- Optionalheaders: IHash<string>
- Optionalparameters: IHash<string | string[]>
- Optionaldata: any
Returns OnmsHTTPOptions
- Defined in src/api/OnmsHTTPOptions.ts:321

Properties

`Readonly`data

data: any

HTTP data to be passed when POSTing

`Readonly`headers

headers: IHash<string> = ...

HTTP headers to be passed to the request.

`Readonly`parameters

parameters: IHash<string | string[]> = ...

HTTP parameters to be passed on the URL.

`Readonly`server

server: OnmsServer

The server to use instead of that provided by the HTTP implementation.

Accessors

auth

get auth(): OnmsAuthConfig
The authentication config that should be used.

Returns OnmsAuthConfig
- Defined in src/api/OnmsHTTPOptions.ts:278

timeout

get timeout(): number
How long to wait for ReST calls to time out.

Returns number
- Defined in src/api/OnmsHTTPOptions.ts:273

Methods

toJSON

toJSON(): object
Convert the options to a plain JSON object.

Returns object
- Defined in src/api/OnmsHTTPOptions.ts:343

`Static`newBuilder

newBuilder(options?): OnmsHTTPOptionsBuilder
Create a new builder for an [[OnmsHTTPOptions]] object.
Parameters
- Optionaloptions: OnmsHTTPOptions
  if an existing options object is passed, the builder will be pre-populated
Returns OnmsHTTPOptionsBuilder
- Defined in src/api/OnmsHTTPOptions.ts:268