Class MethodRequestBuilderBase<RequestConfigT>

Base class for all request builders.

abstract
typeparam: Type of the entity to create a request for

Type parameters

RequestConfigT: ODataRequestConfig

Hierarchy

MethodRequestBuilderBase

Index

Constructors

constructor

Properties

requestConfig

Methods

Constructors

constructor

new MethodRequestBuilderBase(requestConfig: RequestConfigT): MethodRequestBuilderBase

- Defined in core/src/request-builder/request-builder-base.ts:17
Creates an instance of MethodRequestBuilderBase.

Parameters
- requestConfig: RequestConfigT
  
  Request configuration to initialize with
Returns MethodRequestBuilderBase

Properties

Protected requestConfig

requestConfig: RequestConfigT

Request configuration to initialize with

Methods

build

build(destination: Destination | DestinationNameAndJwt, options?: DestinationRetrievalOptions): Promise<ODataRequest<RequestConfigT>>

- Defined in core/src/request-builder/request-builder-base.ts:67
Build an ODataRequest that holds essential configuration for the service request and executes it.

Parameters
- destination: Destination | DestinationNameAndJwt
  
  Targeted destination on which the request is performed.
- Optional options: DestinationRetrievalOptions
  
  Options to employ when fetching destinations.
Returns Promise<ODataRequest<RequestConfigT>>

The OData request executor including the destination configuration.

url

url(destination: Destination | DestinationNameAndJwt, options?: DestinationRetrievalOptions): Promise<string>

- Defined in core/src/request-builder/request-builder-base.ts:32
Create the url based on configuration of the given builder.

Parameters
- destination: Destination | DestinationNameAndJwt
  
  Destination to execute the request against
- Optional options: DestinationRetrievalOptions
  
  Options to employ when fetching destinations.
Returns Promise<string>

Promise resolving to the url for the request

withCustomHeaders

withCustomHeaders(headers: MapType<string>): this

- Defined in core/src/request-builder/request-builder-base.ts:43
Add custom headers to the request.

Parameters
- headers: MapType<string>
  
  Key-value pairs denoting additional custom headers
Returns this

The request builder itself, to facilitate method chaining

withCustomServicePath

withCustomServicePath(servicePath: string): this

- Defined in core/src/request-builder/request-builder-base.ts:55
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