Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ODataDeleteRequestConfig<EntityT>

OData delete request configuration for an entity type.

Type parameters

  • EntityT: EntityBase

    Type of the entity to setup a request for

Hierarchy

Implements

  • WithKeys
  • WithETag

Index

Constructors

constructor

Properties

customServicePath

customServicePath: string

Readonly defaultServicePath

defaultServicePath: string

default path of the according service

eTag

eTag: string

Readonly entityConstructor

entityConstructor: Constructable<EntityT>

Constructor type of the entity to create a configuration for

keys

keys: Record<string, FieldType>

method

HTTP method of the request

payload

payload: Record<string, any> | string

versionIdentifierIgnored

versionIdentifierIgnored: boolean = false

Accessors

contentType

  • get contentType(): any

customHeaders

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

customQueryParameters

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

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

Protected prependDollarToQueryParameters

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

queryParameters

  • queryParameters(): Record<string, any>

resourcePath

  • resourcePath(): string

Object literals

Readonly defaultHeaders

defaultHeaders: object

accept

accept: string = "application/json"

content-type

content-type: string = "application/json"