Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MethodRequestBuilderBase<RequestConfigT>

Base class for all request builders.

typeparam

Type of the entity to create a request for

Type parameters

  • RequestConfigT: ODataRequestConfig = any

Hierarchy

Index

Constructors

constructor

Properties

requestConfig

requestConfig: RequestConfigT

Request configuration to initialize with

Methods

addCustomHeaders

  • addCustomHeaders(headers: Record<string, string>): this

addCustomQueryParameters

  • addCustomQueryParameters(queryParameters: Record<string, string>): this
  • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs denoting additional custom query parameters to be set in the request

    Returns this

    The request builder itself, to facilitate method chaining

build

relativeUrl

  • relativeUrl(): string

setCustomServicePath

  • setCustomServicePath(servicePath: string): this
  • Replace the default service path with the given custom path. In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/' and can be overwritten here.

    Parameters

    • servicePath: string

      Path to override the default with

    Returns this

    The request builder itself, to facilitate method chaining

url

withCustomHeaders

  • withCustomHeaders(headers: Record<string, string>): this

withCustomQueryParameters

  • withCustomQueryParameters(queryParameters: Record<string, string>): this

withCustomServicePath

  • withCustomServicePath(servicePath: string): this