Class OdataBoundFunctionImportRequestConfig<EntityT, DeSerializersT, ParametersT>

Function import 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

ODataFunctionImportRequestConfig<DeSerializersT, ParametersT>
- OdataBoundFunctionImportRequestConfig

Implements

WithKeys

Constructors

constructor

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

Properties

customServicePath

customServicePath: string

`Readonly` defaultHeaders

defaultHeaders: Record<string, any>

`Readonly` defaultServicePath

defaultServicePath: string

`Readonly` entityApi

entityApi: EntityApi<EntityT, DeSerializersT>

`Readonly` functionImportName

functionImportName: 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: FunctionImportParameters<ParametersT>

payload

payload: string | Record<string, any>

Accessors

appendedPaths

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

customHeaders

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

customQueryParameters

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

customRequestConfiguration

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

fetchCsrfToken

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

timeout

get timeout(): undefined | number
Returns undefined | number
Inherited from ODataFunctionImportRequestConfig.timeout
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:24
set timeout(timeout: undefined | number): void
Parameters
- timeout: undefined | number
Returns void
Inherited from ODataFunctionImportRequestConfig.timeout
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:23

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 ODataFunctionImportRequestConfig.addCustomHeaders
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:38

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 ODataFunctionImportRequestConfig.addCustomQueryParameters
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:43

addCustomRequestConfiguration

addCustomRequestConfiguration(requestConfiguration: Record<string, string>): void
Add custom request configuration to the request.
Parameters
- requestConfiguration: Record<string, string>
  
  Key-value pairs where the key is the name of a request configuration and the value is the respective value.
Returns void
Inherited from ODataFunctionImportRequestConfig.addCustomRequestConfiguration
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:48

appendPath

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

`Protected` prependDollarToQueryParameters

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

queryParameters

queryParameters(): Record<string, any>
Internal
Returns Record<string, any>
Overrides ODataFunctionImportRequestConfig.queryParameters
- Defined in packages/odata-v4/dist/request/odata-bound-function-import-request-config.d.ts:15

resourcePath

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

Class OdataBoundFunctionImportRequestConfig<EntityT, DeSerializersT, ParametersT>

Type Parameters

EntityT extends EntityBase

DeSerializersT extends DeSerializers

ParametersT

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

EntityT extends EntityBase<EntityT>

DeSerializersT extends DeSerializers<any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, DeSerializersT>

ParametersT

Parameters

method: RequestMethodType

entityApi: EntityApi<EntityT, DeSerializersT>

functionImportName: string

parameters: FunctionImportParameters<ParametersT>

oDataUri: ODataUri<DeSerializersT>

Returns OdataBoundFunctionImportRequestConfig<EntityT, DeSerializersT, ParametersT>

Properties

customServicePath

Readonly defaultHeaders

Readonly defaultServicePath

Readonly entityApi

Readonly functionImportName

keys

method

Readonly oDataUri

Readonly parameterEncoder

parameters

payload

Accessors

appendedPaths

Returns string[]

customHeaders

Returns Record<string, string>

Parameters

headers: Record<string, string>

Returns void

customQueryParameters

Returns Record<string, string>

Parameters

queryParameters: Record<string, string>

Returns void

customRequestConfiguration

Returns Record<string, string>

Parameters

requestConfiguration: Record<string, string>

Returns void

fetchCsrfToken

Returns boolean

Parameters

fetchCsrfToken: boolean

Returns void

timeout

Returns undefined | number

Parameters

timeout: undefined | number

Returns void

Methods

addCustomHeaders

Parameters

headers: Record<string, string>

Returns void

addCustomQueryParameters

Parameters

queryParameters: Record<string, string>

Returns void

addCustomRequestConfiguration

Parameters

requestConfiguration: Record<string, string>

Returns void

appendPath

Parameters

`Readonly` defaultHeaders

`Readonly` defaultServicePath

`Readonly` entityApi

`Readonly` functionImportName

`Readonly` oDataUri

`Readonly` parameterEncoder

`Rest` ...path: string[]

`Protected` prependDollarToQueryParameters