Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UpdateRequestBuilder<EntityT>

Create OData query to update an entity.

Type parameters

  • EntityT: Entity

    Type of the entity to be updated

Hierarchy

  • MethodRequestBuilderBase<ODataUpdateRequestConfig<EntityT>>
    • UpdateRequestBuilder

Implements

  • EntityIdentifiable<EntityT>

Index

Constructors

constructor

  • new UpdateRequestBuilder(_entityConstructor: Constructable<EntityT>, _entity: EntityT): UpdateRequestBuilder

Properties

Readonly _entity

_entity: EntityT

Entity to be updated

Readonly _entityConstructor

_entityConstructor: Constructable<EntityT>

Constructor type of the entity to be updated

requestConfig

requestConfig: ODataUpdateRequestConfig<EntityT>

Request configuration to initialize with

Methods

build

execute

ignoreVersionIdentifier

  • ignoreVersionIdentifier(): this

ignoredFields

  • ignoredFields(...fields: Selectable<EntityT>[]): this

prepare

  • prepare(): this

relativeUrl

  • relativeUrl(): string

replaceWholeEntityWithPut

  • replaceWholeEntityWithPut(): this
  • Explicitly configure 'PUT' as the method of the update request. By default, only the properties that have changed compared to the last known remote state are sent using 'PATCH', while with 'PUT', the whole entity is sent.

    Returns this

    The entity itself, to facilitate method chaining

requiredFields

  • requiredFields(...fields: Selectable<EntityT>[]): this

url

withCustomHeaders

  • withCustomHeaders(headers: MapType<string>): this

withCustomQueryParameters

  • withCustomQueryParameters(queryParameters: MapType<string>): this

withCustomServicePath

  • withCustomServicePath(servicePath: string): this

withCustomVersionIdentifier

  • withCustomVersionIdentifier(etag: string): this
  • Specifies a custom ETag version identifier of the entity to update.

    Parameters

    • etag: string

      Custom ETag version identifier to be sent in the header of the request

    Returns this

    The request itself to ease chaining while executing the request