Class MethodRequestBuilderBase<EntityT, RequestConfigT>

Base class for all request builders.

abstract

Type parameters

EntityT: Entity

Type of the entity to create a request for
RequestConfigT: ODataRequestConfig<EntityT>

Hierarchy

MethodRequestBuilderBase

Implements

EntityIdentifiable<EntityT>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new MethodRequestBuilderBase(entityConstructor: Constructable<EntityT>, requestConfig: RequestConfigT): MethodRequestBuilderBase

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

Parameters
- entityConstructor: Constructable<EntityT>
  
  Constructor type of the entity to create a request for
- requestConfig: RequestConfigT
  
  Request configuration to initialize with
Returns MethodRequestBuilderBase

Properties

entityConstructor

entityConstructor: Constructable<EntityT>

Constructor type of the entity to create a request for

Protected requestConfig

requestConfig: RequestConfigT

Request configuration to initialize with

Methods

build

build(destination: Destination | DestinationNameAndJwt): Promise<ODataRequest<EntityT, RequestConfigT>>

- Defined in core/src/request-builder/request-builder-base.ts:58
Parameters
- destination: Destination | DestinationNameAndJwt
Returns Promise<ODataRequest<EntityT, RequestConfigT>>

Protected getKeyFieldNames

getKeyFieldNames(): string[]

- Defined in core/src/request-builder/request-builder-base.ts:63
Returns string[]

url

url(destination: Destination | DestinationNameAndJwt): 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
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:42
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:53
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