Class ODataBoundFunctionRequestConfig<EntityT, DeSerializersT, ParametersT>

Function request configuration for an entity type.

Type Parameters

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

Hierarchy (view full)

ODataFunctionRequestConfig<DeSerializersT, ParametersT>
- ODataBoundFunctionRequestConfig

Implements

WithKeys

Constructors

constructor

new ODataBoundFunctionRequestConfig<EntityT, DeSerializersT, ParametersT>(method, entityApi, functionName, parameters, oDataUri): ODataBoundFunctionRequestConfig<EntityT, DeSerializersT, ParametersT>
Type Parameters
- EntityT extends EntityBase
- DeSerializersT extends DeSerializers<any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any>
- ParametersT
Parameters
- method: RequestMethodType
- entityApi: EntityApi<EntityT, DeSerializersT>
- functionName: string
- parameters: OperationParameters<ParametersT>
- oDataUri: ODataUri<DeSerializersT>
Returns ODataBoundFunctionRequestConfig<EntityT, DeSerializersT, ParametersT>
Overrides ODataFunctionRequestConfig.constructor
- Defined in packages/odata-v4/dist/request/odata-bound-function-request-config.d.ts:13

Properties

basePath

basePath: string

`Readonly`defaultBasePath

defaultBasePath: string

`Readonly`defaultHeaders

defaultHeaders: Record<string, any>

`Readonly`entityApi

entityApi: EntityApi<EntityT, DeSerializersT>

`Readonly`functionName

functionName: string

keys

keys: Record<string, any>

Map containing the key name and value.

method

method: RequestMethodType

`Readonly`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 ODataFunctionRequestConfig.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 ODataFunctionRequestConfig.customHeaders
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:33
set customHeaders(headers): void
Parameters
- headers: Record<string, string>
Returns void
Inherited from ODataFunctionRequestConfig.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 ODataFunctionRequestConfig.customQueryParameters
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:35
set customQueryParameters(queryParameters): void
Parameters
- queryParameters: Record<string, string>
Returns void
Inherited from ODataFunctionRequestConfig.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 ODataFunctionRequestConfig.customRequestConfiguration
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:37
set customRequestConfiguration(requestConfiguration): void
Parameters
- requestConfiguration: CustomRequestConfig
Returns void
Inherited from ODataFunctionRequestConfig.customRequestConfiguration
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:36

fetchCsrfToken

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

middlewares

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

Methods

addCustomHeaders

addCustomHeaders(headers): 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): 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): 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 Ⓒ 2024 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): void
Parameters
- Rest...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>
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-v4/dist/request/odata-bound-function-request-config.d.ts:15

resourcePath

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

Class ODataBoundFunctionRequestConfig<EntityT, DeSerializersT, ParametersT>

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ODataBoundFunctionRequestConfig<EntityT, DeSerializersT, ParametersT>

Properties

basePath

ReadonlydefaultBasePath

ReadonlydefaultHeaders

ReadonlyentityApi

ReadonlyfunctionName

keys

method

ReadonlyoDataUri

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`entityApi

`Readonly`functionName

`Readonly`oDataUri

`Readonly`parameterEncoder

`Protected`prependDollarToQueryParameters