Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ODataUpdateRequestConfig<EntityT>

OData update request configuration for an entity type.

Type parameters

  • EntityT: Entity

    Type of the entity to setup a request for

Hierarchy

  • ODataRequestConfig
    • ODataUpdateRequestConfig

Implements

  • WithKeys

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Creates an instance of ODataUpdateRequestConfig.

    Parameters

    • _entityConstructor: Constructable<EntityT>

      Constructor type of the entity to create a configuration for

    Returns ODataUpdateRequestConfig

Properties

_entityConstructor

_entityConstructor: Constructable<EntityT>

Constructor type of the entity to create a configuration for

contentType

contentType: string

The content type of the request

customServicePath

customServicePath: string

defaultServicePath

defaultServicePath: string

default path of the according service

eTag

eTag: string

keys

keys: MapType<FieldType>

method

method: RequestMethodType

HTTP method of the request

payload

payload: MapType<any> | string

versionIdentifierIgnored

versionIdentifierIgnored: boolean = false

Accessors

customHeaders

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

  • Returns MapType<string>

  • Parameters

    • headers: MapType<string>

    Returns void

Methods

addCustomHeaders

  • addCustomHeaders(headers: MapType<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: MapType<string>

      Key-value pairs where the key is the name of a header property and the value is the respective value

    Returns void

Protected prependDollarToQueryParameters

  • prependDollarToQueryParameters(params: MapType<any>): MapType<any>

  • Parameters

    • params: MapType<any>

    Returns MapType<any>

queryParameters

  • queryParameters(): MapType<any>

  • Returns MapType<any>

resourcePath

  • resourcePath(): string

  • Returns string

updateWithPut

  • updateWithPut(): void

  • Returns void