Class ODataUpdateRequestConfig<EntityT, DeSerializersT>

OData update request configuration for an entity type.

Type Parameters

Hierarchy

Implements

Constructors

constructor

Properties

customServicePath defaultHeaders defaultServicePath eTag entityApi keys method parameterEncoder payload versionIdentifierIgnored

Accessors

appendedPaths customHeaders customQueryParameters customRequestConfiguration fetchCsrfToken timeout

Methods

addCustomHeaders addCustomQueryParameters addCustomRequestConfiguration appendPath prependDollarToQueryParameters queryParameters resourcePath updateWithPut

Constructors

constructor

  • Creates an instance of ODataUpdateRequestConfig.

    Type Parameters

    • EntityT extends EntityBase<EntityT>

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

    Parameters

    • entityApi: EntityApi<EntityT, DeSerializersT>

      Entity API for building and executing the request.

    • oDataUri: ODataUri<DeSerializersT>

      URI conversion functions.

    Returns ODataUpdateRequestConfig<EntityT, DeSerializersT>

Properties

customServicePath

customServicePath: string

Readonly defaultHeaders

defaultHeaders: Record<string, any>

Readonly defaultServicePath

defaultServicePath: string

eTag

eTag: string

Version identifier.

Readonly entityApi

entityApi: EntityApi<EntityT, DeSerializersT>

keys

keys: Record<string, any>

Map containing the key name and value.

method

method: RequestMethodType

Readonly parameterEncoder

parameterEncoder: ParameterEncoder

payload

payload: string | Record<string, any>

versionIdentifierIgnored

versionIdentifierIgnored: boolean

Ignore the version identifier if set to true.

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>

queryParameters

  • Internal

    Returns Record<string, any>

resourcePath

  • Internal

    Returns string

updateWithPut

  • Returns void

Settings

Member Visibility

Theme

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