ServiceError Object

Summary

Encapsulates error information from a failed call to the Documents Library Service.

Syntax

JavaScript Syntax

function lt.Documents.ServiceError

TypeScript Syntax

class lt.Documents.ServiceError()

Remarks

When a service call results in an error, the Promise object will trigger its fail handlers with the jQuery jqXHR (XML Http Response object) and two exception information strings. Within the jqXHR object is more detailed exception information for both the developer and user of the application. By using ParseError to create a new ServiceError object, those additional information objects are parsed from the jqXHR body and made available as properties.

Refer to Promises in the Documents Library Service for more information on jQuery jqXHR and service calls.

Requirements

Target Platforms