Class ODataBoundActionRequestConfig<EntityT, DeSerializersT, ParametersT>

Action 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)

Implements

Constructors

Properties

actionName: string
basePath: string
defaultBasePath: string
defaultHeaders: Record<string, any>
keys: Record<string, any>

Map containing the key name and value.

parameterEncoder: ParameterEncoder
payload: string | Record<string, any>

Accessors

  • get appendedPaths(): string[]
  • Returns string[]

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

  • set customHeaders(headers): void
  • Parameters

    • headers: Record<string, string>

    Returns void

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

  • set customQueryParameters(queryParameters): void
  • Parameters

    • queryParameters: Record<string, string>

    Returns void

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

  • set customRequestConfiguration(requestConfiguration): void
  • Parameters

    • requestConfiguration: Record<string, string>

    Returns void

  • get fetchCsrfToken(): boolean
  • Returns boolean

  • set fetchCsrfToken(fetchCsrfToken): void
  • Parameters

    • fetchCsrfToken: boolean

    Returns void

  • get middlewares(): HttpMiddleware[]
  • Returns HttpMiddleware[]

  • set middlewares(middlewares): void
  • Parameters

    Returns void

Methods

  • 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

  • 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

  • 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

  • Parameters

    • Rest ...path: string[]

    Returns void

  • Internal

    Returns Record<string, any>