Options
All
  • Public
  • Public/Protected
  • All
Menu

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

  • new MethodRequestBuilder<RequestConfigT>(requestConfig: RequestConfigT): MethodRequestBuilder<RequestConfigT>
  • Creates an instance of MethodRequestBuilder.

    Type parameters

    • RequestConfigT: ODataRequestConfig<RequestConfigT> = any

    Parameters

    • requestConfig: RequestConfigT

      Request configuration to initialize with

    Returns MethodRequestBuilder<RequestConfigT>

Properties

requestConfig

requestConfig: RequestConfigT

Methods

addCustomHeaders

  • Add custom headers to the request. Existing headers will be overwritten.

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

    Returns MethodRequestBuilder<RequestConfigT>

    The request builder itself, to facilitate method chaining.

addCustomQueryParameters

  • addCustomQueryParameters(queryParameters: Record<string, string>): MethodRequestBuilder<RequestConfigT>
  • 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 MethodRequestBuilder<RequestConfigT>

    The request builder itself, to facilitate method chaining

build

relativeUrl

  • relativeUrl(): string
  • Create the relative url based on configuration of the given builder.

    Returns string

    The relative url for the request

setCustomServicePath

  • 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 MethodRequestBuilder<RequestConfigT>

    The request builder itself, to facilitate method chaining

url

withCustomHeaders

  • Add custom headers to the request.

    deprecated

    Since version 1.34.0 Use addCustomHeaders instead.

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers

    Returns MethodRequestBuilder<RequestConfigT>

    The request builder itself, to facilitate method chaining

withCustomQueryParameters

  • withCustomQueryParameters(queryParameters: Record<string, string>): MethodRequestBuilder<RequestConfigT>
  • Add custom query parameters to the request.

    deprecated

    Since version 1.34.0 Use addCustomQueryParameters instead.

    Parameters

    • queryParameters: Record<string, string>

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

    Returns MethodRequestBuilder<RequestConfigT>

    The request builder itself, to facilitate method chaining

withCustomServicePath

  • 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.

    deprecated

    Since version 1.34.0 Use setCustomServicePath instead.

    Parameters

    • servicePath: string

      Path to override the default with

    Returns MethodRequestBuilder<RequestConfigT>

    The request builder itself, to facilitate method chaining