User data to be passed to the service with the next Document Service call.
Object.defineProperty(LEADDocument.prototype, 'serviceUserData',
get: function(),
set: function(value)
)
serviceUserData: any;
A JSON-compatible object. Default value is null.
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 Document Service call.
The Document 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 Document 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 Document Service, it must be as a
string.
Refer to Promises in the Document Service Library for more information.
Help Collections
Raster .NET | C API | C++ Class Library | HTML5 JavaScript
Document .NET | C API | C++ Class Library | HTML5 JavaScript
Medical .NET | C API | C++ Class Library | HTML5 JavaScript
Medical Web Viewer .NET
Multimedia
Direct Show .NET | C API | Filters
Media Foundation .NET | C API | Transforms
Supported Platforms
.NET, Java, Android, and iOS/macOS Assemblies
Imaging, Medical, and Document
C API/C++ Class Libraries
Imaging, Medical, and Document
HTML5 JavaScript Libraries
Imaging, Medical, and Document