Class ODataFunctionRequestConfig<DeSerializersT, ParametersT>

Function request configuration for an entity type.

Type Parameters

DeSerializersT extends DeSerializers
Type of the deserializer use on the request
ParametersT
Type of the parameter to setup a request with

Hierarchy (View Summary)

ODataFunctionRequestConfig<DeSerializersT, ParametersT>
- ODataFunctionRequestConfig

Constructors

constructor

new ODataFunctionRequestConfig<
    DeSerializersT extends
        DeSerializers<
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
        >,
    ParametersT,
>(
    method: RequestMethodType,
    defaultBasePath: string,
    functionName: string,
    parameters: OperationParameters<ParametersT>,
    oDataUri: ODataUri<DeSerializersT>,
): ODataFunctionRequestConfig<DeSerializersT, ParametersT>
Creates an instance of ODataFunctionRequestConfig.
Type Parameters
- DeSerializersT extends DeSerializers<
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
  >
- ParametersT
Parameters
- method: RequestMethodType
  HTTP method for the request.
- defaultBasePath: string
  Default base path of the service.
- functionName: string
  The name of the function.
- parameters: OperationParameters<ParametersT>
  Object containing the parameters with a value and additional meta information.
- oDataUri: ODataUri<DeSerializersT>
  URI conversion functions.
Returns ODataFunctionRequestConfig<DeSerializersT, ParametersT>
Overrides ODataFunctionRequestConfig.constructor
- Defined in packages/odata-v2/dist/request/odata-function-request-config.d.ts:18

Properties

basePath

basePath: string

`Readonly`defaultBasePath

defaultBasePath: string

`Readonly`defaultHeaders

defaultHeaders: Record<string, any>

`Readonly`functionName

functionName: string

method

method: RequestMethodType

`Protected`oDataUri

oDataUri: ODataUri<DeSerializersT>

`Readonly`parameterEncoder

parameterEncoder: ParameterEncoder

parameters

parameters: OperationParameters<ParametersT>

payload

payload: string | Record<string, any>

Accessors

appendedPaths

get appendedPaths(): string[]
Returns string[]
Inherited from ODataFunctionRequestConfigBase.appendedPaths
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:38

customHeaders

get customHeaders(): Record<string, string>
Returns Record<string, string>
Inherited from ODataFunctionRequestConfigBase.customHeaders
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:33
set customHeaders(headers: Record<string, string>): void
Parameters
- headers: Record<string, string>
Returns void
Inherited from ODataFunctionRequestConfigBase.customHeaders
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:32

customQueryParameters

get customQueryParameters(): Record<string, string>
Returns Record<string, string>
Inherited from ODataFunctionRequestConfigBase.customQueryParameters
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:35
set customQueryParameters(queryParameters: Record<string, string>): void
Parameters
- queryParameters: Record<string, string>
Returns void
Inherited from ODataFunctionRequestConfigBase.customQueryParameters
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:34

customRequestConfiguration

get customRequestConfiguration(): Record<string, string>
Returns Record<string, string>
Inherited from ODataFunctionRequestConfigBase.customRequestConfiguration
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:37
set customRequestConfiguration(requestConfiguration: CustomRequestConfig): void
Parameters
- requestConfiguration: CustomRequestConfig
Returns void
Inherited from ODataFunctionRequestConfigBase.customRequestConfiguration
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:36

fetchCsrfToken

get fetchCsrfToken(): boolean
Returns boolean
Inherited from ODataFunctionRequestConfigBase.fetchCsrfToken
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:40
set fetchCsrfToken(fetchCsrfToken: boolean): void
Parameters
- fetchCsrfToken: boolean
Returns void
Inherited from ODataFunctionRequestConfigBase.fetchCsrfToken
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:39

middlewares

get middlewares(): HttpMiddleware[]
Returns HttpMiddleware[]
Inherited from ODataFunctionRequestConfigBase.middlewares
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:31
set middlewares(middlewares: HttpMiddleware[]): void
Parameters
- middlewares: HttpMiddleware[]
Returns void
Inherited from ODataFunctionRequestConfigBase.middlewares
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:30

Methods

addCustomHeaders

addCustomHeaders(headers: Record<string, 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: Record<string, string>
  Key-value pairs where the key is the name of a header property and the value is the respective value.
Returns void
Inherited from ODataFunctionRequestConfig.addCustomHeaders
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:45

addCustomQueryParameters

addCustomQueryParameters(queryParameters: Record<string, string>): void
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
Parameters
- queryParameters: Record<string, string>
  Key-value pairs where the key is the name of a query parameter and the value is the respective value.
Returns void
Inherited from ODataFunctionRequestConfig.addCustomQueryParameters
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:50

addCustomRequestConfiguration

addCustomRequestConfiguration(requestConfiguration: Record<string, any>): void
Add custom request configuration to the request.
Parameters
- requestConfiguration: Record<string, any>
  Key-value pairs where the key is the name of a request configuration and the value is the respective value.
  
  Copyright Ⓒ 2025 SAP SE or an SAP affiliate company. All rights reserved.
Returns void
Inherited from ODataFunctionRequestConfig.addCustomRequestConfiguration
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:55

appendPath

appendPath(...path: string[]): void
Parameters
- ...path: string[]
Returns void
Inherited from ODataFunctionRequestConfig.appendPath
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:56

`Protected`prependDollarToQueryParameters

prependDollarToQueryParameters(params: Record<string, any>): Record<string, any>
Parameters
- params: Record<string, any>
Returns Record<string, any>
Inherited from ODataFunctionRequestConfig.prependDollarToQueryParameters
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:57

queryParameters

queryParameters(): Record<string, any>
Internal
Returns Record<string, any>
Overrides ODataFunctionRequestConfig.queryParameters
- Defined in packages/odata-v2/dist/request/odata-function-request-config.d.ts:20

resourcePath

resourcePath(): string
Internal
Returns string
Overrides ODataFunctionRequestConfig.resourcePath
- Defined in packages/odata-v2/dist/request/odata-function-request-config.d.ts:19

Class ODataFunctionRequestConfig<DeSerializersT, ParametersT>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ODataFunctionRequestConfig<DeSerializersT, ParametersT>

Properties

basePath

ReadonlydefaultBasePath

ReadonlydefaultHeaders

ReadonlyfunctionName

method

ProtectedoDataUri

ReadonlyparameterEncoder

parameters

payload

Accessors

appendedPaths

Returns string[]

customHeaders

Returns Record<string, string>

Parameters

Returns void

customQueryParameters

Returns Record<string, string>

Parameters

Returns void

customRequestConfiguration

Returns Record<string, string>

Parameters

Returns void

fetchCsrfToken

Returns boolean

Parameters

Returns void

middlewares

Returns HttpMiddleware[]

Parameters

Returns void

Methods

addCustomHeaders

Parameters

Returns void

addCustomQueryParameters

Parameters

Returns void

addCustomRequestConfiguration

Parameters

Returns void

appendPath

Parameters

Returns void

ProtectedprependDollarToQueryParameters

Parameters

Returns Record<string, any>

queryParameters

Returns Record<string, any>

resourcePath

Returns string

Settings

On This Page

`Readonly`defaultBasePath

`Readonly`defaultHeaders

`Readonly`functionName

`Protected`oDataUri

`Readonly`parameterEncoder

`Protected`prependDollarToQueryParameters