Class ODataGetAllRequestConfig<EntityT, DeSerializersT>

OData getAll request configuration for an entity type.

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor

Properties

basePath defaultBasePath defaultHeaders entityApi expands filter method orderBy parameterEncoder payload selects skip top

Accessors

appendedPaths customHeaders customQueryParameters customRequestConfiguration fetchCsrfToken middlewares

Methods

addCustomHeaders addCustomQueryParameters addCustomRequestConfiguration appendPath prependDollarToQueryParameters queryParameters resourcePath

Constructors

constructor

Properties

basePath

basePath: string

Readonly defaultBasePath

defaultBasePath: string

Readonly defaultHeaders

defaultHeaders: Record<string, any>

Readonly entityApi

entityApi: EntityApi<EntityT, DeSerializersT>

expands

expands: Expandable<EntityT, DeSerializersT, EntityApi<EntityBase, DeSerializersT>>[]

filter

filter: Filterable<EntityT, DeSerializersT>

Filter the results based on conditions.

method

method: RequestMethodType

orderBy

orderBy: Orderable<EntityT>[]

Order the results in, e.g., asc or desc order.

Readonly parameterEncoder

parameterEncoder: ParameterEncoder

payload

payload: string | Record<string, any>

selects

selects: Selectable<EntityT, DeSerializersT>[]

Select a list of fields on the schema property of the entity api.

skip

skip: number

Skip a number of results in the requested set.

top

top: number

Limit the number of results to the given number.

Accessors

appendedPaths

  • get appendedPaths(): string[]

  • Returns string[]

customHeaders

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

  • Returns Record<string, string>

  • set customHeaders(headers): void

  • Parameters

    • headers: Record<string, string>

    Returns void

customQueryParameters

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

  • Returns Record<string, string>

  • set customQueryParameters(queryParameters): void

  • Parameters

    • queryParameters: Record<string, string>

    Returns void

customRequestConfiguration

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

  • Returns Record<string, string>

  • set customRequestConfiguration(requestConfiguration): void

  • Parameters

    Returns void

fetchCsrfToken

  • get fetchCsrfToken(): boolean

  • Returns boolean

  • set fetchCsrfToken(fetchCsrfToken): void

  • Parameters

    • fetchCsrfToken: boolean

    Returns void

middlewares

  • get middlewares(): HttpMiddleware[]

  • Returns HttpMiddleware[]

  • set middlewares(middlewares): void

  • Parameters

    Returns void

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

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

addCustomRequestConfiguration

  • addCustomRequestConfiguration(requestConfiguration): 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

appendPath

  • appendPath(...path): void

  • Parameters

    • Rest ...path: string[]

    Returns void

Protected prependDollarToQueryParameters

  • prependDollarToQueryParameters(params): Record<string, any>

  • Parameters

    • params: Record<string, any>

    Returns Record<string, any>

queryParameters

  • queryParameters(): Record<string, any>
  • Internal

    Returns Record<string, any>

resourcePath

  • resourcePath(): string
  • Internal

    Returns string

Settings

Member Visibility

Theme

On This Page

constructorbasePathdefaultBasePathdefaultHeadersentityApiexpandsfiltermethodorderByparameterEncoderpayloadselectsskiptopappendedPathscustomHeaderscustomQueryParameterscustomRequestConfigurationfetchCsrfTokenmiddlewaresaddCustomHeadersaddCustomQueryParametersaddCustomRequestConfigurationappendPathprependDollarToQueryParametersqueryParametersresourcePath