In This Topic ▼

headersObject Property

Summary

Gets or sets an object containing key-value pairs representing headers to add to a web-service call.

Syntax

TypeScript

JavaScript

Object.defineProperty(PrepareWebServiceCallEventArgs.prototype, 'headersObject', 
	get: function(), 
	set: function(value) 
)

headersObject: any;

Property Value

An object that contains zero or more properties, where each property is a key-value pair. These pairs represent the headers of a web service call. Keys are strings that represent the header names, and values are strings that represent the header content. This object is used to configure the HTTP headers sent in any web service request, facilitating the communication of additional information such as content types, authentication tokens, and other metadata required by the server.

Remarks

Below are three valid examples of the headersObject property:

{ }

{ 'Authorization': 'Bearer MY_BEARER_TOKEN' }

{ 
	'Content-Type': 'application/terry', 
    'Authorization': 'Bearer YOUR_TOKEN_HERE' 
}

Refer to PrepareWebServiceCall for more information.

Requirements

Target Platforms