Class ODataGetByKeyRequestConfig<EntityT, DeSerializersT>

OData getByKey request configuration for an entity type.

Type Parameters

EntityT extends EntityBase
Type of the entity to setup a request for
DeSerializersT extends DeSerializers

Hierarchy (View Summary)

ODataRequestConfig
- ODataGetByKeyRequestConfig

Implements

Constructors

constructor

new ODataGetByKeyRequestConfig<
    EntityT extends EntityBase,
    DeSerializersT extends
        DeSerializers<
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
        >,
>(
    entityApi: EntityApi<EntityT, DeSerializersT>,
    oDataUri: ODataUri<DeSerializersT>,
): ODataGetByKeyRequestConfig<EntityT, DeSerializersT>
Creates an instance of ODataGetByKeyRequestConfig.
Type Parameters
- EntityT extends EntityBase
- DeSerializersT extends DeSerializers<
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
      any,
  >
Parameters
- entityApi: EntityApi<EntityT, DeSerializersT>
  Entity API for building and executing the request.
- oDataUri: ODataUri<DeSerializersT>
  URI conversion functions.
Returns ODataGetByKeyRequestConfig<EntityT, DeSerializersT>
Overrides ODataRequestConfig.constructor
- Defined in packages/odata-common/dist/request/odata-get-by-key-request-config.d.ts:24

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

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>

selects

selects: Selectable<EntityT, DeSerializersT>[]

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

Accessors

appendedPaths

get appendedPaths(): string[]
Returns string[]
Inherited from ODataRequestConfig.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 ODataRequestConfig.customHeaders
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:33
set customHeaders(headers: Record<string, string>): void
Parameters
- headers: Record<string, string>
Returns void
Inherited from ODataRequestConfig.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 ODataRequestConfig.customQueryParameters
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:35
set customQueryParameters(queryParameters: Record<string, string>): void
Parameters
- queryParameters: Record<string, string>
Returns void
Inherited from ODataRequestConfig.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 ODataRequestConfig.customRequestConfiguration
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:37
set customRequestConfiguration(requestConfiguration: CustomRequestConfig): void
Parameters
- requestConfiguration: CustomRequestConfig
Returns void
Inherited from ODataRequestConfig.customRequestConfiguration
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:36

fetchCsrfToken

get fetchCsrfToken(): boolean
Returns boolean
Inherited from ODataRequestConfig.fetchCsrfToken
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:40
set fetchCsrfToken(fetchCsrfToken: boolean): void
Parameters
- fetchCsrfToken: boolean
Returns void
Inherited from ODataRequestConfig.fetchCsrfToken
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:39

middlewares

get middlewares(): HttpMiddleware[]
Returns HttpMiddleware[]
Inherited from ODataRequestConfig.middlewares
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:31
set middlewares(middlewares: HttpMiddleware[]): void
Parameters
- middlewares: HttpMiddleware[]
Returns void
Inherited from ODataRequestConfig.middlewares
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:30

Methods

addCustomHeaders

addCustomHeaders(headers: Record<string, string>): 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 ODataRequestConfig.addCustomHeaders
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:45

addCustomQueryParameters

addCustomQueryParameters(queryParameters: Record<string, string>): 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 ODataRequestConfig.addCustomQueryParameters
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:50

addCustomRequestConfiguration

addCustomRequestConfiguration(requestConfiguration: Record<string, any>): 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
Inherited from ODataRequestConfig.addCustomRequestConfiguration
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:55

appendPath

appendPath(...path: string[]): void
Parameters
- ...path: string[]
Returns void
Inherited from ODataRequestConfig.appendPath
- Defined in packages/odata-common/dist/request/odata-request-config.d.ts:56

`Protected`prependDollarToQueryParameters

prependDollarToQueryParameters(params: Record<string, any>): Record<string, any>
Parameters
- params: Record<string, any>
Returns Record<string, any>
Inherited from ODataRequestConfig.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 ODataRequestConfig.queryParameters
- Defined in packages/odata-common/dist/request/odata-get-by-key-request-config.d.ts:26

resourcePath

resourcePath(): string
Internal
Returns string
Overrides ODataRequestConfig.resourcePath
- Defined in packages/odata-common/dist/request/odata-get-by-key-request-config.d.ts:25

Class ODataGetByKeyRequestConfig<EntityT, DeSerializersT>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ODataGetByKeyRequestConfig<EntityT, DeSerializersT>

Properties

basePath

ReadonlydefaultBasePath

ReadonlydefaultHeaders

ReadonlyentityApi

expands

keys

method

ReadonlyparameterEncoder

payload

selects

Accessors

appendedPaths

Returns string[]

customHeaders

Returns Record<string, string>

Parameters

Returns void

customQueryParameters

Returns Record<string, string>

Parameters

Returns void

customRequestConfiguration

Returns Record<string, string>

Parameters

Returns void

fetchCsrfToken

Returns boolean

Parameters

Returns void

middlewares

Returns HttpMiddleware[]

Parameters

Returns void

Methods

addCustomHeaders

Parameters

Returns void

addCustomQueryParameters

Parameters

Returns void

addCustomRequestConfiguration

Parameters

Returns void

appendPath

Parameters

Returns void

ProtectedprependDollarToQueryParameters

Parameters

Returns Record<string, any>

queryParameters

Returns Record<string, any>

resourcePath

Returns string

Settings

On This Page

`Readonly`defaultBasePath

`Readonly`defaultHeaders

`Readonly`entityApi

`Readonly`parameterEncoder

`Protected`prependDollarToQueryParameters