OpenNMS.js - v2.6.2-SNAPSHOT
    Preparing search index...

    Class OnmsHTTPOptionsBuilder

    A builder for [[OnmsHTTPOptions]]. Create a new one with [[OnmsHTTPOptions.newBuilder]].

    Index

    Constructors

    Methods

    • A parameter to add or append to the request.

      If undefined is passed, that parameter will be reset to defaults. If the value is a string array, the existing value in the builder will be replaced. Otherwise, if the parameter already exists in the builder, the parameter will be converted to an array if necessary and this parameter will be added to it.

      Parameters

      • parameter: string

        the parameter name

      • Optionalvalue: string | number | boolean | string[]

        the value of the parameter to add (or undefined)

      Returns OnmsHTTPOptionsBuilder

    • A header to set in the request.

      If undefined is passed, that header will be reset to defaults.

      Parameters

      • header: string

        the header name

      • Optionalvalue: string | number | boolean

        the value of the header

      Returns OnmsHTTPOptionsBuilder