Class ODataUpdateRequestConfig<EntityT>

Type parameters

EntityT: Entity

Hierarchy

ODataRequestConfig<EntityT>
- ODataUpdateRequestConfig

Implements

WithKeys

Index

Constructors

constructor

Properties

Accessors

customHeaders

Methods

Constructors

constructor

new ODataUpdateRequestConfig(service: string, entityName: string, entityConstructor: Constructable<EntityT>): ODataUpdateRequestConfig

Overrides ODataRequestConfig.constructor
- Defined in core/src/request-builder/request/odata-update-request-config.ts:15
Creates an instance of ODataRequest.

Parameters
- service: string
  
  Technical name of the service the entity belongs to
- entityName: string
  
  Technical name of the entity
- entityConstructor: Constructable<EntityT>
  
  Constructor type of the entity to create a configuration for
Returns ODataUpdateRequestConfig

Properties

customServicePath

customServicePath: string

entityConstructor

entityConstructor: Constructable<EntityT>

Constructor type of the entity to create a configuration for

entityName

entityName: string

Technical name of the entity

keys

keys: object

Type declaration

[key: string]: FieldType

method

method: RequestMethodType

HTTP method of the request

payload

payload: MapType<any>

service

service: string

Technical name of the service the entity belongs to

Accessors

customHeaders

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

Inherited from ODataRequestConfig.customHeaders
- Defined in core/src/request-builder/request/odata-request-config.ts:20
Returns MapType<string>
Inherited from ODataRequestConfig.customHeaders
- Defined in core/src/request-builder/request/odata-request-config.ts:15
Parameters
- headers: MapType<string>
Returns void

Methods

addCustomHeaders

addCustomHeaders(headers: MapType<string>): void

Inherited from ODataRequestConfig.addCustomHeaders
- Defined in core/src/request-builder/request/odata-request-config.ts:46
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

queryParameters

queryParameters(): object

Overrides ODataRequestConfig.queryParameters
- Defined in core/src/request-builder/request/odata-update-request-config.ts:31
Returns object
- [key: string]: any

resourcePath

resourcePath(): string

Overrides ODataRequestConfig.resourcePath
- Defined in core/src/request-builder/request/odata-update-request-config.ts:27
Returns string