WordsApi

Contents
[ ]

ApiError

Represents an API error.

This class is used in WordsApiErrorResponse.

The following properties are defined:

Property Type Description
Code string Gets or sets the API error code.
DateTime DateTime Gets or sets the server DateTime.
Description string Gets or sets the error description.
Message string Gets or sets the error message.

Provides information on the Words API resource link.

This class is inherited from Link and used in Bookmark, Bookmarks, Border, BordersCollection, Comment, CommentLink, CommentsCollection, CustomXmlPart, CustomXmlPartInsert, CustomXmlPartLink, CustomXmlPartsCollection, CustomXmlPartUpdate, DocumentProperties, DocumentProperty, DrawingObject, DrawingObjectCollection, DrawingObjectLink, Field, FieldCollection, FieldLink, FieldNames, Font, Footnote, FootnoteCollection, FootnoteLink, FormField, FormFieldCheckbox, FormFieldCollection, FormFieldDropDown, FormFieldTextInput, HeaderFooter, HeaderFooterLink, HeaderFooterLinkCollection, Hyperlink, Hyperlinks, LinkElement, ListFormat, ListInfo, ListLevel, ListLevels, Lists, NodeLink, OfficeMathLink, OfficeMathObject, OfficeMathObjectsCollection, PageSetup, Paragraph, ParagraphFormat, ParagraphFormatBase, ParagraphFormatUpdate, ParagraphLink, ParagraphLinkCollection, Run, RunLink, Runs, SearchResultsCollection, Section, SectionLink, SectionLinkCollection, Style, Table, TableCell, TableCellFormat, TableLink, TableLinkCollection, TableProperties, TableRow, TableRowFormat.

The following properties are defined:

Property Type Description
Href string Gets or sets the “href” attribute with the link’s IRI. atom:link elements MUST have an href attribute, whose value MUST be a IRI reference.
Rel string Gets or sets the option that controls whether atom:link elements MAY have a “rel” attribute that indicates the link relation type. If the “rel” attribute is not present, the link element MUST be interpreted as if the link relation type is “alternate”.
Title string Gets or sets the “title” attribute, that conveys human-readable information about the link. The content of the “title” attribute is Language-Sensitive.
Type string Gets or sets the “type” attribute. The “type” attribute’s value is an advisory media type: it is a hint about the type of the representation that is expected to be returned when the value of the href attribute is dereferenced. Note that the type attribute does not override the actual media type returned with the representation.

WordsApiErrorResponse

Represents a REST response with an error.

The following properties are defined:

Property Type Description
RequestId string Gets or sets the request Id.
Error ApiError Gets or sets the API error.

ApiException

Represents an API exception.

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

  • ApiException(int errorCode, string message)

, where:

Argument Type Description
errorCode int The error code.
message string The message.

Properties

A single ErrorCode property is defined:

Property Type Description
ErrorCode int Error code.

Configuration

Represents a set of configuration settings.

The following properties are defined:

Property Type Description
ApiBaseUrl string Aspose.Words for Cloud API base URL.
ClientId string Gets or sets the client id.
ClientSecret string Gets or sets the client secret.
Timeout int Gets or sets a request timeout in seconds. Default is 100 seconds.
Modulus string Gets or sets RSA encryptor modulus as base64 string.
Exponent string Gets or sets RSA encryptor expoenent as base64 string.
AuthType AuthType Authentication type. Default is OAuth 2.0

WordsApi

Aspose.Words for Cloud API.

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

  • WordsApi(string clientId, string clientSecret)

, where:

Argument Type Description
clientId string The client id.
clientSecret string The client secret.

Methods

AuthType

This class is used in Configuration.