IDocumentOperationResult Interface

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

Declaration

export 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.