Class ODataFunctionImportRequestConfig<DeSerializersT, ParametersT>

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

ODataFunctionImportRequestConfig<DeSerializersT, ParametersT>
- ODataFunctionImportRequestConfig
  - OdataBoundFunctionImportRequestConfig

Constructors

constructor

new ODataFunctionImportRequestConfig<DeSerializersT, ParametersT>(method, defaultBasePath, functionImportName, parameters, oDataUri): ODataFunctionImportRequestConfig<DeSerializersT, ParametersT>
Creates an instance of ODataFunctionImportRequestConfig.
Type Parameters
- 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
  
  HTTP method for the request.
- defaultBasePath: string
  
  Default base path of the service.
- functionImportName: string
  
  The name of the function import.
- parameters: FunctionImportParameters<ParametersT>
  
  Object containing the parameters with a value and additional meta information.
- oDataUri: ODataUri<DeSerializersT>
  
  URI conversion functions.
Returns ODataFunctionImportRequestConfig<DeSerializersT, ParametersT>
Overrides ODataFunctionImportRequestConfig.constructor
- Defined in packages/odata-v4/dist/request/odata-function-import-request-config.d.ts:17

Properties

basePath

basePath: string

`Readonly` defaultBasePath

defaultBasePath: string

`Readonly` defaultHeaders

defaultHeaders: Record<string, any>

`Readonly` functionImportName

functionImportName: string

method

method: RequestMethodType

`Protected` 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 ODataFunctionImportRequestConfigBase.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 ODataFunctionImportRequestConfigBase.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 ODataFunctionImportRequestConfigBase.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 ODataFunctionImportRequestConfigBase.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 ODataFunctionImportRequestConfigBase.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 ODataFunctionImportRequestConfigBase.customRequestConfiguration
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:37
set customRequestConfiguration(requestConfiguration): void
Parameters
- requestConfiguration: Record<string, string>
Returns void
Inherited from ODataFunctionImportRequestConfigBase.customRequestConfiguration
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:36

fetchCsrfToken

get fetchCsrfToken(): boolean
Returns boolean
Inherited from ODataFunctionImportRequestConfigBase.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 ODataFunctionImportRequestConfigBase.fetchCsrfToken
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:39

middlewares

get middlewares(): HttpMiddleware[]
Returns HttpMiddleware[]
Inherited from ODataFunctionImportRequestConfigBase.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 ODataFunctionImportRequestConfigBase.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 ODataFunctionImportRequestConfig.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 ODataFunctionImportRequestConfig.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, 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:55

appendPath

appendPath(...path): void
Parameters
- Rest ...path: string[]
Returns void
Inherited from ODataFunctionImportRequestConfig.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 ODataFunctionImportRequestConfig.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 ODataFunctionImportRequestConfig.queryParameters
- Defined in packages/odata-v4/dist/request/odata-function-import-request-config.d.ts:19

resourcePath

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

Class ODataFunctionImportRequestConfig<DeSerializersT, ParametersT>

Type Parameters

DeSerializersT extends DeSerializers

ParametersT

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

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

defaultBasePath: string

functionImportName: string

parameters: FunctionImportParameters<ParametersT>

oDataUri: ODataUri<DeSerializersT>

Returns ODataFunctionImportRequestConfig<DeSerializersT, ParametersT>

Properties

basePath

Readonly defaultBasePath

Readonly defaultHeaders

Readonly functionImportName

method

Protected 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

middlewares

Returns HttpMiddleware[]

Parameters

middlewares: HttpMiddleware[]

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

Rest ...path: string[]

Returns void

Protected prependDollarToQueryParameters

Parameters

params: Record<string, any>

`Readonly` defaultBasePath

`Readonly` defaultHeaders

`Readonly` functionImportName

`Protected` oDataUri

`Readonly` parameterEncoder

`Rest` ...path: string[]

`Protected` prependDollarToQueryParameters