Options
All
  • Public
  • Public/Protected
  • All
Menu
deprecated

Since v1.21.0. Use superclass instead. OData create request configuration for an entity type.

Type parameters

  • EntityT: EntityBase

    Type of the entity to setup a request for

Hierarchy

Index

Constructors

constructor

  • Creates an instance of ODataRequest.

    Type parameters

    Parameters

    • _entityConstructor: Constructable<EntityT, unknown>

      Constructor type of the entity to create a configuration for

    Returns ODataCreateRequestConfigLegacy<EntityT>

Properties

Readonly _entityConstructor

_entityConstructor: Constructable<EntityT, unknown>

childField

childField: Link<EntityBase, EntityT>

Field that links the parent entity class to the child entity class.

customServicePath

customServicePath: string

Readonly defaultHeaders

defaultHeaders: Record<string, any>

Readonly defaultServicePath

defaultServicePath: string

method

parentKeys

parentKeys: Record<string, any>

Keys of the parent of the entity to create. Defined only when attempting to create child entities.

payload

payload: string | Record<string, any>

Accessors

contentType

  • get contentType(): any
  • deprecated

    Since v1.30.0. Use defaultHeaders instead.

    Returns any

customHeaders

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

  • Parameters

    • headers: Record<string, string>

    Returns any

customQueryParameters

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

  • Parameters

    • queryParameters: Record<string, string>

    Returns any

customRequestConfiguration

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

  • Parameters

    • requestConfiguration: Record<string, string>

    Returns any

fetchCsrfToken

  • get fetchCsrfToken(): boolean
  • set fetchCsrfToken(fetchCsrfToken: boolean): any
  • Returns boolean

  • Parameters

    • fetchCsrfToken: boolean

    Returns any

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

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

addCustomRequestConfiguration

  • addCustomRequestConfiguration(requestConfiguration: Record<string, string>): void
  • 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

Protected prependDollarToQueryParameters

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

queryParameters

  • queryParameters(): Record<string, any>

resourcePath

  • resourcePath(): string

Protected resourcePathAsChild

  • resourcePathAsChild(): string