Class ODataFunctionImportRequestConfig<DeSerializersT, ParametersT>Abstract

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

Constructors

constructor

Properties

customServicePath defaultHeaders defaultServicePath functionImportName method oDataUri parameterEncoder parameters payload

Accessors

appendedPaths customHeaders customQueryParameters customRequestConfiguration fetchCsrfToken timeout

Methods

addCustomHeaders addCustomQueryParameters addCustomRequestConfiguration appendPath prependDollarToQueryParameters queryParameters resourcePath

Constructors

constructor

  • Creates an instance of ODataFunctionImportRequestConfig.

    Type Parameters

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

    • ParametersT

    Parameters

    • method: RequestMethodType

      HTTP method for the request.

    • defaultServicePath: string

      Default 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>

Properties

customServicePath

customServicePath: string

Readonly defaultHeaders

defaultHeaders: Record<string, any>

Readonly defaultServicePath

defaultServicePath: string

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[]

customHeaders

  • get customHeaders(): Record<string, string>

  • Returns Record<string, string>

  • set customHeaders(headers: Record<string, string>): void

  • Parameters

    • headers: Record<string, string>

    Returns void

customQueryParameters

  • get customQueryParameters(): Record<string, string>

  • Returns Record<string, string>

  • set customQueryParameters(queryParameters: Record<string, string>): void

  • Parameters

    • queryParameters: Record<string, string>

    Returns void

customRequestConfiguration

  • get customRequestConfiguration(): Record<string, string>

  • Returns Record<string, string>

  • set customRequestConfiguration(requestConfiguration: Record<string, string>): void

  • Parameters

    • requestConfiguration: Record<string, string>

    Returns void

fetchCsrfToken

  • get fetchCsrfToken(): boolean

  • Returns boolean

  • set fetchCsrfToken(fetchCsrfToken: boolean): void

  • Parameters

    • fetchCsrfToken: boolean

    Returns void

timeout

  • get timeout(): undefined | number

  • Returns undefined | number

  • set timeout(timeout: undefined | number): void

  • Parameters

    • timeout: undefined | number

    Returns void

Methods

addCustomHeaders

  • 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

addCustomQueryParameters

  • 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

addCustomRequestConfiguration

  • 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

appendPath

  • Parameters

    • Rest ...path: string[]

    Returns void

Protected prependDollarToQueryParameters

  • Parameters

    • params: Record<string, any>

    Returns Record<string, any>

Abstract queryParameters

  • Internal

    Returns Record<string, any>

Abstract resourcePath

  • Internal

    Returns string

Settings

Member Visibility

Theme

Copyright Ⓒ 2023 SAP SE or an SAP affiliate company. All rights reserved.