Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ODataFunctionImportRequestConfig<ParametersT>

OData function import request configuration for a set of parameters.

Type parameters

  • ParametersT

    Type of the original parameters object

Hierarchy

  • ODataRequestConfig
    • ODataFunctionImportRequestConfig

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Creates an instance of ODataFunctionImportRequestConfig.

    Parameters

    • method: RequestMethodType

      HTTP method for the request

    • defaultServicePath: string

      Default path of the service

    • parameters: FunctionImportParameters<ParametersT>

      Object containing the parameters with a value and additional meta information

    Returns ODataFunctionImportRequestConfig

Properties

customServicePath

customServicePath: string

defaultServicePath

defaultServicePath: string

default path of the according service

method

method: RequestMethodType

HTTP method of the request

parameters

parameters: FunctionImportParameters<ParametersT>

Object containing the parameters with a value and additional meta information

payload

payload: MapType<any>

Accessors

customHeaders

  • get customHeaders(): MapType<string>
  • set customHeaders(headers: MapType<string>): void

  • Returns MapType<string>

  • Parameters

    • headers: MapType<string>

    Returns void

Methods

addCustomHeaders

  • addCustomHeaders(headers: MapType<string>): void

  • Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.

    Parameters

    • headers: MapType<string>

      Key-value pairs where the key is the name of a header property and the value is the respective value

    Returns void

Protected prependDollarToQueryParameters

  • prependDollarToQueryParameters(params: MapType<any>): MapType<any>

  • Parameters

    • params: MapType<any>

    Returns MapType<any>

queryParameters

  • queryParameters(): MapType<any>

  • Returns MapType<any>

resourcePath

  • resourcePath(): string

  • Returns string