DocumentRevision

Contents
[ ]
Request Response Model
AcceptAll AcceptAllRevisionsOnlineRequest AcceptAllRevisionsOnlineResponse
AcceptAllRevisionsRequest RevisionsModificationResponse ModificationOperationResult
RejectAll RejectAllRevisionsOnlineRequest RejectAllRevisionsOnlineResponse
RejectAllRevisionsRequest RevisionsModificationResponse ModificationOperationResult

ModificationOperationResult

Represents a result of the operation which modifies the original document and saves the result.

This class is used in RevisionsModificationResponse.

The following properties are defined:

Property Type Description
Dest FileLink Gets or sets the link to the dest document (result of the modification operation) .
Source FileLink Gets or sets the link to the source document (source for the modification operation) .

AcceptAllRevisionsOnlineRequest

Represents a request model for WordsApi.AcceptAllRevisionsOnline() operation.

An object of the AcceptAllRevisionsOnlineRequest class is created by the following constructor methods:

  • AcceptAllRevisionsOnlineRequest()
  • AcceptAllRevisionsOnlineRequest(Stream document, string loadEncoding, string password, string encryptedPassword, string destFileName)

Each of those arguments initializes the corresponding self-titled property:

Argument Property Type Description
document Document Stream The document.
loadEncoding LoadEncoding string Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
password Password string Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API.
encryptedPassword EncryptedPassword string Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
destFileName DestFileName string Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.

AcceptAllRevisionsOnlineResponse

Represents a response model for WordsApi.AcceptAllRevisionsOnline() operation.

An object of the AcceptAllRevisionsOnlineResponse class is created by the following constructor methods:

Each of those arguments initializes the corresponding self-titled property:

Argument Property Type Description
model Model RevisionsModificationResponse The response model.
document Document Dictionary<string,Stream> The document after modification.

AcceptAllRevisionsRequest

Represents a request model for WordsApi.AcceptAllRevisions() operation.

An object of the AcceptAllRevisionsRequest class is created by the following constructor methods:

  • AcceptAllRevisionsRequest()
  • AcceptAllRevisionsRequest(string name, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string destFileName)

Each of those arguments initializes the corresponding self-titled property:

Argument Property Type Description
name Name string The filename of the input document.
folder Folder string Original document folder.
storage Storage string Original document storage.
loadEncoding LoadEncoding string Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
password Password string Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API.
encryptedPassword EncryptedPassword string Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
destFileName DestFileName string Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.

RejectAllRevisionsOnlineRequest

Represents a request model for WordsApi.RejectAllRevisionsOnline() operation.

An object of the RejectAllRevisionsOnlineRequest class is created by the following constructor methods:

  • RejectAllRevisionsOnlineRequest()
  • RejectAllRevisionsOnlineRequest(Stream document, string loadEncoding, string password, string encryptedPassword, string destFileName)

Each of those arguments initializes the corresponding self-titled property:

Argument Property Type Description
document Document Stream The document.
loadEncoding LoadEncoding string Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
password Password string Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API.
encryptedPassword EncryptedPassword string Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
destFileName DestFileName string Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.

RejectAllRevisionsOnlineResponse

Represents a response model for WordsApi.RejectAllRevisionsOnline() operation.

An object of the RejectAllRevisionsOnlineResponse class is created by the following constructor methods:

Each of those arguments initializes the corresponding self-titled property:

Argument Property Type Description
model Model RevisionsModificationResponse The response model.
document Document Dictionary<string,Stream> The document after modification.

RejectAllRevisionsRequest

Represents a request model for WordsApi.RejectAllRevisions() operation.

An object of the RejectAllRevisionsRequest class is created by the following constructor methods:

  • RejectAllRevisionsRequest()
  • RejectAllRevisionsRequest(string name, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string destFileName)

Each of those arguments initializes the corresponding self-titled property:

Argument Property Type Description
name Name string The filename of the input document.
folder Folder string Original document folder.
storage Storage string Original document storage.
loadEncoding LoadEncoding string Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
password Password string Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API.
encryptedPassword EncryptedPassword string Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
destFileName DestFileName string Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.

RevisionsModificationResponse

Represents a REST response with a result of the modification operations for the revisions collection (now these are acceptAll and rejectAll) .

This class is inherited from WordsResponse and used in WordsApi, AcceptAllRevisionsOnlineResponse, RejectAllRevisionsOnlineResponse.

The following properties are defined:

Property Type Description
RequestId string Gets or sets the request Id.
Result ModificationOperationResult Gets or sets the result of the modification operations for the revisions collection.