The requested page is not available for the requested platform. You are viewing the content for Default platform.
All docs
V19.1
19.2 (preview)
19.1
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

IDocumentOperationResult Interface

Provides information about the result of preforming a custom document operation on the client side.

Declaration

interface IDocumentOperationResult

Properties

customData Property

Specifies custom data associated with the performed document operation.

Declaration

customData?: string

Property Value

Type Description
string

A string containing information associated with the document operation.

documentId Property

Specifies the document ID.

Declaration

documentId: string

Property Value

Type Description
string

A string that specifies the document ID.

message Property

Specifies the error message to display if performing a document operation fails.

Declaration

message?: string

Property Value

Type Description
string

A string specifying the text of the error message.

succeeded Property

Specifies whether a document operation has been successfully performed.

Declaration

succeeded: boolean

Property Value

Type Description
boolean

true, if the document operation has been successfully performed; otherwise, false.