Comment

	Request	Response	Model
Delete	DeleteCommentOnlineRequest	Dictionary
	DeleteCommentRequest	Task
	DeleteCommentsOnlineRequest	Dictionary
	DeleteCommentsRequest	Task
Get	GetCommentOnlineRequest	CommentResponse	Comment
	GetCommentRequest
	GetCommentsOnlineRequest	CommentsResponse	CommentsCollection
	GetCommentsRequest
Insert	InsertCommentOnlineRequest	InsertCommentOnlineResponse	CommentInsert
	InsertCommentRequest	CommentResponse	Comment CommentInsert
Update	UpdateCommentOnlineRequest	UpdateCommentOnlineResponse	CommentUpdate
	UpdateCommentRequest	CommentResponse	Comment CommentUpdate

Comment

Represents a dTO container with a comment.

This class is inherited from CommentLink and used in CommentResponse, CommentsCollection.

The following properties are defined:

Property	Type	Description
Link	WordsApiLink	Gets or sets the link to the document.
Author	string	Gets or sets the author name for a comment.
Content	StoryChildNodes	Gets or sets the content of the comment.
DateTime	DateTime	Gets or sets the date and time that the comment was made.
Initial	string	Gets or sets the initials of the user associated with a specific comment.
RangeEnd	DocumentPosition	Gets or sets the link to comment range end node.
RangeStart	DocumentPosition	Gets or sets the link to comment range start node.
Text	string	Gets or sets text of the comment.

CommentBase

Represents a comment.

The following properties are defined:

Property	Type	Description
Author	string	Gets or sets the author name for a comment.
DateTime	DateTime	Gets or sets the date and time that the comment was made.
Initial	string	Gets or sets the initials of the user associated with a specific comment.
RangeEnd	DocumentPosition	Gets or sets the link to comment range end node.
RangeStart	DocumentPosition	Gets or sets the link to comment range start node.
Text	string	Gets or sets text of the comment.

CommentInsert

Represents a comment insert.

This class is inherited from CommentBase and used in InsertCommentOnlineRequest, InsertCommentRequest.

The following properties are defined:

Property	Type	Description
Author	string	Gets or sets the author name for a comment.
DateTime	DateTime	Gets or sets the date and time that the comment was made.
Initial	string	Gets or sets the initials of the user associated with a specific comment.
RangeEnd	DocumentPosition	Gets or sets the link to comment range end node.
RangeStart	DocumentPosition	Gets or sets the link to comment range start node.
Text	string	Gets or sets text of the comment.

CommentLink

Represents a comment link.

A single Link property is defined:

Property	Type	Description
Link	WordsApiLink	Gets or sets the link to the document.

CommentsCollection

Represents a collection of comments.

This class is inherited from LinkElement and used in CommentsResponse.

The following properties are defined:

Property	Type	Description
Link	WordsApiLink	Gets or sets the link to the document.
CommentList	List<Comment>	Gets or sets the collection of comments.

CommentUpdate

Represents a comment update.

This class is inherited from CommentBase and used in UpdateCommentOnlineRequest, UpdateCommentRequest.

The following properties are defined:

Property	Type	Description
Author	string	Gets or sets the author name for a comment.
DateTime	DateTime	Gets or sets the date and time that the comment was made.
Initial	string	Gets or sets the initials of the user associated with a specific comment.
RangeEnd	DocumentPosition	Gets or sets the link to comment range end node.
RangeStart	DocumentPosition	Gets or sets the link to comment range start node.
Text	string	Gets or sets text of the comment.

CommentResponse

Represents a REST response with a comment.

This class is inherited from WordsResponse and used in WordsApi, InsertCommentOnlineResponse, UpdateCommentOnlineResponse.

The following properties are defined:

Property	Type	Description
RequestId	string	Gets or sets the request Id.
Comment	Comment	Gets or sets the comment.

CommentsResponse

Represents a REST response with a collection of comments.

This class is inherited from WordsResponse and used in WordsApi.

The following properties are defined:

Property	Type	Description
RequestId	string	Gets or sets the request Id.
Comments	CommentsCollection	Gets or sets the collection of comments.

DeleteCommentOnlineRequest

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

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

• DeleteCommentOnlineRequest()
• DeleteCommentOnlineRequest(Stream document, int commentIndex, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime)

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

Argument	Property	Type	Description
document	Document	Stream	The document.
commentIndex	CommentIndex	int	The index of the comment.
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.
revisionAuthor	RevisionAuthor	string	Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.
revisionDateTime	RevisionDateTime	string	The date and time to use for revisions.

DeleteCommentRequest

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

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

• DeleteCommentRequest()
• DeleteCommentRequest(string name, int commentIndex, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime)

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

Argument	Property	Type	Description
name	Name	string	The filename of the input document.
commentIndex	CommentIndex	int	The index of the comment.
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.
revisionAuthor	RevisionAuthor	string	Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.
revisionDateTime	RevisionDateTime	string	The date and time to use for revisions.

DeleteCommentsOnlineRequest

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

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

• DeleteCommentsOnlineRequest()
• DeleteCommentsOnlineRequest(Stream document, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime)

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.
revisionAuthor	RevisionAuthor	string	Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.
revisionDateTime	RevisionDateTime	string	The date and time to use for revisions.

DeleteCommentsRequest

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

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

• DeleteCommentsRequest()
• DeleteCommentsRequest(string name, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime)

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.
revisionAuthor	RevisionAuthor	string	Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.
revisionDateTime	RevisionDateTime	string	The date and time to use for revisions.

GetCommentOnlineRequest

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

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

• GetCommentOnlineRequest()
• GetCommentOnlineRequest(Stream document, int commentIndex, string loadEncoding, string password, string encryptedPassword)

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

Argument	Property	Type	Description
document	Document	Stream	The document.
commentIndex	CommentIndex	int	The index of the comment.
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.

GetCommentRequest

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

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

• GetCommentRequest()
• GetCommentRequest(string name, int commentIndex, string folder, string storage, string loadEncoding, string password, string encryptedPassword)

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

Argument	Property	Type	Description
name	Name	string	The filename of the input document.
commentIndex	CommentIndex	int	The index of the comment.
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.

GetCommentsOnlineRequest

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

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

• GetCommentsOnlineRequest()
• GetCommentsOnlineRequest(Stream document, string loadEncoding, string password, string encryptedPassword)

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.

GetCommentsRequest

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

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

• GetCommentsRequest()
• GetCommentsRequest(string name, string folder, string storage, string loadEncoding, string password, string encryptedPassword)

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.

InsertCommentOnlineRequest

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

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

• InsertCommentOnlineRequest()
• InsertCommentOnlineRequest(Stream document, CommentInsert comment, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime)

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

Argument	Property	Type	Description
document	Document	Stream	The document.
comment	Comment	CommentInsert	Comment data.
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.
revisionAuthor	RevisionAuthor	string	Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.
revisionDateTime	RevisionDateTime	string	The date and time to use for revisions.

InsertCommentOnlineResponse

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

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

• InsertCommentOnlineResponse(CommentResponse model, Dictionary<string,Stream> document)

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

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

InsertCommentRequest

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

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

• InsertCommentRequest()
• InsertCommentRequest(string name, CommentInsert comment, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime)

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

Argument	Property	Type	Description
name	Name	string	The filename of the input document.
comment	Comment	CommentInsert	Comment data.
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.
revisionAuthor	RevisionAuthor	string	Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.
revisionDateTime	RevisionDateTime	string	The date and time to use for revisions.

UpdateCommentOnlineRequest

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

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

• UpdateCommentOnlineRequest()
• UpdateCommentOnlineRequest(Stream document, int commentIndex, CommentUpdate comment, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime)

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

Argument	Property	Type	Description
document	Document	Stream	The document.
commentIndex	CommentIndex	int	The index of the comment.
comment	Comment	CommentUpdate	Comment data.
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.
revisionAuthor	RevisionAuthor	string	Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.
revisionDateTime	RevisionDateTime	string	The date and time to use for revisions.

UpdateCommentOnlineResponse

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

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

• UpdateCommentOnlineResponse(CommentResponse model, Dictionary<string,Stream> document)

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

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

UpdateCommentRequest

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

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

• UpdateCommentRequest()
• UpdateCommentRequest(string name, int commentIndex, CommentUpdate comment, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime)

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

Argument	Property	Type	Description
name	Name	string	The filename of the input document.
commentIndex	CommentIndex	int	The index of the comment.
comment	Comment	CommentUpdate	Comment data.
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.
revisionAuthor	RevisionAuthor	string	Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.
revisionDateTime	RevisionDateTime	string	The date and time to use for revisions.