serviceUserData Property (Document)

Summary

User data to be passed to the service with the next Documents Service call.

Syntax

JavaScript Syntax

Object.defineProperty(Document.prototype, 'serviceUserData', 
	get: function(), 
	set: function(value) 
)

TypeScript Syntax

serviceUserData: any;

Property Value

A JSON-compatible object. Default value is null.

Remarks

In some instances, a developer may want to send arbitrary data to the service with any request. This is allowed through ServiceUserData and ServiceUserData. When the ServiceUserData property is set, it will be passed to the service with the next Documents Service call. The Documents Service can be modified to use this userData.

ServiceUserData and ServiceUserData can be cleared after a successful service call. In the event that user data is returned as part of a response from the Documents Service, the data object is available as a second argument to any done callback function that is defined for the returned Promise.

If the object is not JSON-compatible (meaning, for example, it contains a looping structure through properties), the service call will produce an error and not run. Please note that if a user-data object containing a JavaScript function is to be passed to the Documents Service, it must be as a string.

Refer to Promises in the Documents Service Library for more information.

Requirements

Target Platforms

See Also