asposewordscloud
Version:
Aspose.Words Cloud SDK for Node.js
1,014 lines • 90.6 kB
TypeScript
/// <reference types="node" />
/// <reference types="node" />
/// <reference types="node" />
import http = require("http");
import { Configuration } from "./internal/configuration";
import * as model from "./model/model";
import { BatchPartRequest } from "./model/batchPartRequest";
export * from "./model/model";
export * from "./model/batchPartRequest";
/**
* encryptor interface
*/
export interface Encryptor {
/**
* Encrypt string.
* @param data to encrypt.
*/
encrypt(data: string): Promise<string>;
}
/**
* Library for communicating with the Aspose.Words for Cloud API
*/
export declare class WordsApi implements Encryptor {
/**
* API configuration
*/
configuration: Configuration;
private encryptor;
/**
* @param clientId.
* @param clientSecret.
* @param baseUrl Base api Url.
* @param debugMode A value indicating whether debug mode. In debug mode all requests and responses are logged to console.
*/
constructor(clientId: string, clientSecret: string, baseUrl?: string, debugMode?: boolean);
/**
* Encrypt string.
* @param data to encrypt.
*/
encrypt(data: string): Promise<string>;
/**
* Accepts all revisions in the document.
* @param requestObj contains request parameters
*/
acceptAllRevisions(requestObj: model.AcceptAllRevisionsRequest): Promise<model.WordsIncomingMessage<model.RevisionsModificationResponse>>;
/**
* Accepts all revisions in the document.
* @param requestObj contains request parameters
*/
acceptAllRevisionsOnline(requestObj: model.AcceptAllRevisionsOnlineRequest): Promise<model.WordsIncomingMessage<model.AcceptAllRevisionsOnlineResponse>>;
/**
* Appends documents to the original document.
* @param requestObj contains request parameters
*/
appendDocument(requestObj: model.AppendDocumentRequest): Promise<model.WordsIncomingMessage<model.DocumentResponse>>;
/**
* Appends documents to the original document.
* @param requestObj contains request parameters
*/
appendDocumentOnline(requestObj: model.AppendDocumentOnlineRequest): Promise<model.WordsIncomingMessage<model.AppendDocumentOnlineResponse>>;
/**
* Applies a style to the document node.
* @param requestObj contains request parameters
*/
applyStyleToDocumentElement(requestObj: model.ApplyStyleToDocumentElementRequest): Promise<model.WordsIncomingMessage<model.WordsResponse>>;
/**
* Applies a style to the document node.
* @param requestObj contains request parameters
*/
applyStyleToDocumentElementOnline(requestObj: model.ApplyStyleToDocumentElementOnlineRequest): Promise<model.WordsIncomingMessage<model.ApplyStyleToDocumentElementOnlineResponse>>;
/**
* Executes the report generation process using the specified document template and the external data source in XML, JSON or CSV format.
* @param requestObj contains request parameters
*/
buildReport(requestObj: model.BuildReportRequest): Promise<model.WordsIncomingMessage<model.DocumentResponse>>;
/**
* Executes the report generation process online using the specified document template and the external data source in XML, JSON or CSV format.
* @param requestObj contains request parameters
*/
buildReportOnline(requestObj: model.BuildReportOnlineRequest): Promise<model.WordsIncomingMessage<Buffer>>;
/**
* Runs a multi-class text classification for the specified raw text.
* @param requestObj contains request parameters
*/
classify(requestObj: model.ClassifyRequest): Promise<model.WordsIncomingMessage<model.ClassificationResponse>>;
/**
* Runs a multi-class text classification for the document.
* @param requestObj contains request parameters
*/
classifyDocument(requestObj: model.ClassifyDocumentRequest): Promise<model.WordsIncomingMessage<model.ClassificationResponse>>;
/**
* Runs a multi-class text classification for the document.
* @param requestObj contains request parameters
*/
classifyDocumentOnline(requestObj: model.ClassifyDocumentOnlineRequest): Promise<model.WordsIncomingMessage<model.ClassificationResponse>>;
/**
* Compares two documents.
* @param requestObj contains request parameters
*/
compareDocument(requestObj: model.CompareDocumentRequest): Promise<model.WordsIncomingMessage<model.DocumentResponse>>;
/**
* Compares two documents.
* @param requestObj contains request parameters
*/
compareDocumentOnline(requestObj: model.CompareDocumentOnlineRequest): Promise<model.WordsIncomingMessage<model.CompareDocumentOnlineResponse>>;
/**
* Compress and resize images inside the document.
* The default settings allows to reduce the size of the document without any visible degradation of images quality.
* @param requestObj contains request parameters
*/
compressDocument(requestObj: model.CompressDocumentRequest): Promise<model.WordsIncomingMessage<model.CompressResponse>>;
/**
* Compress and resize images inside the document.
* The default settings allows to reduce the size of the document without any visible degradation of images quality.
* @param requestObj contains request parameters
*/
compressDocumentOnline(requestObj: model.CompressDocumentOnlineRequest): Promise<model.WordsIncomingMessage<model.CompressDocumentOnlineResponse>>;
/**
* Converts a document on a local drive to the specified format.
* @param requestObj contains request parameters
*/
convertDocument(requestObj: model.ConvertDocumentRequest): Promise<model.WordsIncomingMessage<Buffer>>;
/**
* Copy file.
* @param requestObj contains request parameters
*/
copyFile(requestObj: model.CopyFileRequest): Promise<http.IncomingMessage>;
/**
* Copy folder.
* @param requestObj contains request parameters
*/
copyFolder(requestObj: model.CopyFolderRequest): Promise<http.IncomingMessage>;
/**
* Makes a copy of the style in the document.
* @param requestObj contains request parameters
*/
copyStyle(requestObj: model.CopyStyleRequest): Promise<model.WordsIncomingMessage<model.StyleResponse>>;
/**
* Makes a copy of the style in the document.
* @param requestObj contains request parameters
*/
copyStyleOnline(requestObj: model.CopyStyleOnlineRequest): Promise<model.WordsIncomingMessage<model.CopyStyleOnlineResponse>>;
/**
* Copies styles from the origin document to the target document.
* @param requestObj contains request parameters
*/
copyStylesFromTemplate(requestObj: model.CopyStylesFromTemplateRequest): Promise<model.WordsIncomingMessage<model.WordsResponse>>;
/**
* Creates a new document in cloud storage in the format, determined by the file extension.
* Supported all save format extensions.
* @param requestObj contains request parameters
*/
createDocument(requestObj: model.CreateDocumentRequest): Promise<model.WordsIncomingMessage<model.DocumentResponse>>;
/**
* Create the folder.
* @param requestObj contains request parameters
*/
createFolder(requestObj: model.CreateFolderRequest): Promise<http.IncomingMessage>;
/**
* Adds a new or updates an existing document property.
* @param requestObj contains request parameters
*/
createOrUpdateDocumentProperty(requestObj: model.CreateOrUpdateDocumentPropertyRequest): Promise<model.WordsIncomingMessage<model.DocumentPropertyResponse>>;
/**
* Adds a new or updates an existing document property.
* @param requestObj contains request parameters
*/
createOrUpdateDocumentPropertyOnline(requestObj: model.CreateOrUpdateDocumentPropertyOnlineRequest): Promise<model.WordsIncomingMessage<model.CreateOrUpdateDocumentPropertyOnlineResponse>>;
/**
* Removes paragraph tab stops from the document node.
* @param requestObj contains request parameters
*/
deleteAllParagraphTabStops(requestObj: model.DeleteAllParagraphTabStopsRequest): Promise<model.WordsIncomingMessage<model.TabStopsResponse>>;
/**
* Removes paragraph tab stops from the document node.
* @param requestObj contains request parameters
*/
deleteAllParagraphTabStopsOnline(requestObj: model.DeleteAllParagraphTabStopsOnlineRequest): Promise<model.WordsIncomingMessage<model.DeleteAllParagraphTabStopsOnlineResponse>>;
/**
* Removes a bookmark from the document.
* @param requestObj contains request parameters
*/
deleteBookmark(requestObj: model.DeleteBookmarkRequest): Promise<http.IncomingMessage>;
/**
* Removes a bookmark from the document.
* @param requestObj contains request parameters
*/
deleteBookmarkOnline(requestObj: model.DeleteBookmarkOnlineRequest): Promise<model.WordsIncomingMessage<Map<string, Buffer>>>;
/**
* Removes all bookmarks from the document.
* @param requestObj contains request parameters
*/
deleteBookmarks(requestObj: model.DeleteBookmarksRequest): Promise<http.IncomingMessage>;
/**
* Removes all bookmarks from the document.
* @param requestObj contains request parameters
*/
deleteBookmarksOnline(requestObj: model.DeleteBookmarksOnlineRequest): Promise<model.WordsIncomingMessage<Map<string, Buffer>>>;
/**
* Removes a border from the document node.
* The 'nodePath' parameter should refer to a paragraph, a cell or a row.
* @param requestObj contains request parameters
*/
deleteBorder(requestObj: model.DeleteBorderRequest): Promise<model.WordsIncomingMessage<model.BorderResponse>>;
/**
* Removes a border from the document node.
* The 'nodePath' parameter should refer to a paragraph, a cell or a row.
* @param requestObj contains request parameters
*/
deleteBorderOnline(requestObj: model.DeleteBorderOnlineRequest): Promise<model.WordsIncomingMessage<model.DeleteBorderOnlineResponse>>;
/**
* Removes borders from the document node.
* The 'nodePath' parameter should refer to a paragraph, a cell or a row.
* @param requestObj contains request parameters
*/
deleteBorders(requestObj: model.DeleteBordersRequest): Promise<model.WordsIncomingMessage<model.BordersResponse>>;
/**
* Removes borders from the document node.
* The 'nodePath' parameter should refer to a paragraph, a cell or a row.
* @param requestObj contains request parameters
*/
deleteBordersOnline(requestObj: model.DeleteBordersOnlineRequest): Promise<model.WordsIncomingMessage<model.DeleteBordersOnlineResponse>>;
/**
* Removes a comment from the document.
* @param requestObj contains request parameters
*/
deleteComment(requestObj: model.DeleteCommentRequest): Promise<http.IncomingMessage>;
/**
* Removes a comment from the document.
* @param requestObj contains request parameters
*/
deleteCommentOnline(requestObj: model.DeleteCommentOnlineRequest): Promise<model.WordsIncomingMessage<Map<string, Buffer>>>;
/**
* Removes all comments from the document.
* @param requestObj contains request parameters
*/
deleteComments(requestObj: model.DeleteCommentsRequest): Promise<http.IncomingMessage>;
/**
* Removes all comments from the document.
* @param requestObj contains request parameters
*/
deleteCommentsOnline(requestObj: model.DeleteCommentsOnlineRequest): Promise<model.WordsIncomingMessage<Map<string, Buffer>>>;
/**
* Removes the custom xml part from the document.
* @param requestObj contains request parameters
*/
deleteCustomXmlPart(requestObj: model.DeleteCustomXmlPartRequest): Promise<http.IncomingMessage>;
/**
* Removes the custom xml part from the document.
* @param requestObj contains request parameters
*/
deleteCustomXmlPartOnline(requestObj: model.DeleteCustomXmlPartOnlineRequest): Promise<model.WordsIncomingMessage<Map<string, Buffer>>>;
/**
* Removes all custom xml parts from the document.
* @param requestObj contains request parameters
*/
deleteCustomXmlParts(requestObj: model.DeleteCustomXmlPartsRequest): Promise<http.IncomingMessage>;
/**
* Removes all custom xml parts from the document.
* @param requestObj contains request parameters
*/
deleteCustomXmlPartsOnline(requestObj: model.DeleteCustomXmlPartsOnlineRequest): Promise<model.WordsIncomingMessage<Map<string, Buffer>>>;
/**
* Removes a document property.
* @param requestObj contains request parameters
*/
deleteDocumentProperty(requestObj: model.DeleteDocumentPropertyRequest): Promise<http.IncomingMessage>;
/**
* Removes a document property.
* @param requestObj contains request parameters
*/
deleteDocumentPropertyOnline(requestObj: model.DeleteDocumentPropertyOnlineRequest): Promise<model.WordsIncomingMessage<Map<string, Buffer>>>;
/**
* Removes a DrawingObject from the document node.
* @param requestObj contains request parameters
*/
deleteDrawingObject(requestObj: model.DeleteDrawingObjectRequest): Promise<http.IncomingMessage>;
/**
* Removes a DrawingObject from the document node.
* @param requestObj contains request parameters
*/
deleteDrawingObjectOnline(requestObj: model.DeleteDrawingObjectOnlineRequest): Promise<model.WordsIncomingMessage<Map<string, Buffer>>>;
/**
* Removes a field from the document node.
* @param requestObj contains request parameters
*/
deleteField(requestObj: model.DeleteFieldRequest): Promise<http.IncomingMessage>;
/**
* Removes a field from the document node.
* @param requestObj contains request parameters
*/
deleteFieldOnline(requestObj: model.DeleteFieldOnlineRequest): Promise<model.WordsIncomingMessage<Map<string, Buffer>>>;
/**
* Removes fields from the document node.
* @param requestObj contains request parameters
*/
deleteFields(requestObj: model.DeleteFieldsRequest): Promise<http.IncomingMessage>;
/**
* Removes fields from the document node.
* @param requestObj contains request parameters
*/
deleteFieldsOnline(requestObj: model.DeleteFieldsOnlineRequest): Promise<model.WordsIncomingMessage<Map<string, Buffer>>>;
/**
* Delete file.
* @param requestObj contains request parameters
*/
deleteFile(requestObj: model.DeleteFileRequest): Promise<http.IncomingMessage>;
/**
* Delete folder.
* @param requestObj contains request parameters
*/
deleteFolder(requestObj: model.DeleteFolderRequest): Promise<http.IncomingMessage>;
/**
* Removes a footnote from the document node.
* @param requestObj contains request parameters
*/
deleteFootnote(requestObj: model.DeleteFootnoteRequest): Promise<http.IncomingMessage>;
/**
* Removes a footnote from the document node.
* @param requestObj contains request parameters
*/
deleteFootnoteOnline(requestObj: model.DeleteFootnoteOnlineRequest): Promise<model.WordsIncomingMessage<Map<string, Buffer>>>;
/**
* Removes a form field from the document node.
* @param requestObj contains request parameters
*/
deleteFormField(requestObj: model.DeleteFormFieldRequest): Promise<http.IncomingMessage>;
/**
* Removes a form field from the document node.
* @param requestObj contains request parameters
*/
deleteFormFieldOnline(requestObj: model.DeleteFormFieldOnlineRequest): Promise<model.WordsIncomingMessage<Map<string, Buffer>>>;
/**
* Removes a HeaderFooter object from the document section.
* @param requestObj contains request parameters
*/
deleteHeaderFooter(requestObj: model.DeleteHeaderFooterRequest): Promise<http.IncomingMessage>;
/**
* Removes a HeaderFooter object from the document section.
* @param requestObj contains request parameters
*/
deleteHeaderFooterOnline(requestObj: model.DeleteHeaderFooterOnlineRequest): Promise<model.WordsIncomingMessage<Map<string, Buffer>>>;
/**
* Removes HeaderFooter objects from the document section.
* @param requestObj contains request parameters
*/
deleteHeadersFooters(requestObj: model.DeleteHeadersFootersRequest): Promise<http.IncomingMessage>;
/**
* Removes HeaderFooter objects from the document section.
* @param requestObj contains request parameters
*/
deleteHeadersFootersOnline(requestObj: model.DeleteHeadersFootersOnlineRequest): Promise<model.WordsIncomingMessage<Map<string, Buffer>>>;
/**
* Removes macros from the document.
* @param requestObj contains request parameters
*/
deleteMacros(requestObj: model.DeleteMacrosRequest): Promise<http.IncomingMessage>;
/**
* Removes macros from the document.
* @param requestObj contains request parameters
*/
deleteMacrosOnline(requestObj: model.DeleteMacrosOnlineRequest): Promise<model.WordsIncomingMessage<Map<string, Buffer>>>;
/**
* Removes an OfficeMath object from the document node.
* @param requestObj contains request parameters
*/
deleteOfficeMathObject(requestObj: model.DeleteOfficeMathObjectRequest): Promise<http.IncomingMessage>;
/**
* Removes an OfficeMath object from the document node.
* @param requestObj contains request parameters
*/
deleteOfficeMathObjectOnline(requestObj: model.DeleteOfficeMathObjectOnlineRequest): Promise<model.WordsIncomingMessage<Map<string, Buffer>>>;
/**
* Removes all office math objects from the document.
* @param requestObj contains request parameters
*/
deleteOfficeMathObjects(requestObj: model.DeleteOfficeMathObjectsRequest): Promise<http.IncomingMessage>;
/**
* Removes all office math objects from the document.
* @param requestObj contains request parameters
*/
deleteOfficeMathObjectsOnline(requestObj: model.DeleteOfficeMathObjectsOnlineRequest): Promise<model.WordsIncomingMessage<Map<string, Buffer>>>;
/**
* Removes a paragraph from the document node.
* @param requestObj contains request parameters
*/
deleteParagraph(requestObj: model.DeleteParagraphRequest): Promise<http.IncomingMessage>;
/**
* Removes the formatting properties of a paragraph list from the document node.
* @param requestObj contains request parameters
*/
deleteParagraphListFormat(requestObj: model.DeleteParagraphListFormatRequest): Promise<model.WordsIncomingMessage<model.ParagraphListFormatResponse>>;
/**
* Removes the formatting properties of a paragraph list from the document node.
* @param requestObj contains request parameters
*/
deleteParagraphListFormatOnline(requestObj: model.DeleteParagraphListFormatOnlineRequest): Promise<model.WordsIncomingMessage<model.DeleteParagraphListFormatOnlineResponse>>;
/**
* Removes a paragraph from the document node.
* @param requestObj contains request parameters
*/
deleteParagraphOnline(requestObj: model.DeleteParagraphOnlineRequest): Promise<model.WordsIncomingMessage<Map<string, Buffer>>>;
/**
* Removes a paragraph tab stop from the document node.
* @param requestObj contains request parameters
*/
deleteParagraphTabStop(requestObj: model.DeleteParagraphTabStopRequest): Promise<model.WordsIncomingMessage<model.TabStopsResponse>>;
/**
* Removes a paragraph tab stop from the document node.
* @param requestObj contains request parameters
*/
deleteParagraphTabStopOnline(requestObj: model.DeleteParagraphTabStopOnlineRequest): Promise<model.WordsIncomingMessage<model.DeleteParagraphTabStopOnlineResponse>>;
/**
* Removes a Run object from the paragraph.
* @param requestObj contains request parameters
*/
deleteRun(requestObj: model.DeleteRunRequest): Promise<http.IncomingMessage>;
/**
* Removes a Run object from the paragraph.
* @param requestObj contains request parameters
*/
deleteRunOnline(requestObj: model.DeleteRunOnlineRequest): Promise<model.WordsIncomingMessage<Map<string, Buffer>>>;
/**
* Removes a section from the document.
* @param requestObj contains request parameters
*/
deleteSection(requestObj: model.DeleteSectionRequest): Promise<http.IncomingMessage>;
/**
* Removes a section from the document.
* @param requestObj contains request parameters
*/
deleteSectionOnline(requestObj: model.DeleteSectionOnlineRequest): Promise<model.WordsIncomingMessage<Map<string, Buffer>>>;
/**
* Removes a StructuredDocumentTag (SDT) from the document node.
* @param requestObj contains request parameters
*/
deleteStructuredDocumentTag(requestObj: model.DeleteStructuredDocumentTagRequest): Promise<http.IncomingMessage>;
/**
* Removes a StructuredDocumentTag (SDT) from the document node.
* @param requestObj contains request parameters
*/
deleteStructuredDocumentTagOnline(requestObj: model.DeleteStructuredDocumentTagOnlineRequest): Promise<model.WordsIncomingMessage<Map<string, Buffer>>>;
/**
* Removes a table from the document node.
* @param requestObj contains request parameters
*/
deleteTable(requestObj: model.DeleteTableRequest): Promise<http.IncomingMessage>;
/**
* Removes a cell from the table row.
* @param requestObj contains request parameters
*/
deleteTableCell(requestObj: model.DeleteTableCellRequest): Promise<http.IncomingMessage>;
/**
* Removes a cell from the table row.
* @param requestObj contains request parameters
*/
deleteTableCellOnline(requestObj: model.DeleteTableCellOnlineRequest): Promise<model.WordsIncomingMessage<Map<string, Buffer>>>;
/**
* Removes a table from the document node.
* @param requestObj contains request parameters
*/
deleteTableOnline(requestObj: model.DeleteTableOnlineRequest): Promise<model.WordsIncomingMessage<Map<string, Buffer>>>;
/**
* Removes a row from the table.
* @param requestObj contains request parameters
*/
deleteTableRow(requestObj: model.DeleteTableRowRequest): Promise<http.IncomingMessage>;
/**
* Removes a row from the table.
* @param requestObj contains request parameters
*/
deleteTableRowOnline(requestObj: model.DeleteTableRowOnlineRequest): Promise<model.WordsIncomingMessage<Map<string, Buffer>>>;
/**
* Removes a watermark from the document.
* @param requestObj contains request parameters
*/
deleteWatermark(requestObj: model.DeleteWatermarkRequest): Promise<model.WordsIncomingMessage<model.DocumentResponse>>;
/**
* Removes a watermark from the document.
* @param requestObj contains request parameters
*/
deleteWatermarkOnline(requestObj: model.DeleteWatermarkOnlineRequest): Promise<model.WordsIncomingMessage<model.DeleteWatermarkOnlineResponse>>;
/**
* Download file.
* @param requestObj contains request parameters
*/
downloadFile(requestObj: model.DownloadFileRequest): Promise<model.WordsIncomingMessage<Buffer>>;
/**
* Executes a Mail Merge operation.
* @param requestObj contains request parameters
*/
executeMailMerge(requestObj: model.ExecuteMailMergeRequest): Promise<model.WordsIncomingMessage<model.DocumentResponse>>;
/**
* Executes a Mail Merge operation online.
* @param requestObj contains request parameters
*/
executeMailMergeOnline(requestObj: model.ExecuteMailMergeOnlineRequest): Promise<model.WordsIncomingMessage<Buffer>>;
/**
* Get all information about revisions.
* @param requestObj contains request parameters
*/
getAllRevisions(requestObj: model.GetAllRevisionsRequest): Promise<model.WordsIncomingMessage<model.RevisionsResponse>>;
/**
* Get all information about revisions.
* @param requestObj contains request parameters
*/
getAllRevisionsOnline(requestObj: model.GetAllRevisionsOnlineRequest): Promise<model.WordsIncomingMessage<model.RevisionsResponse>>;
/**
* Reads available fonts from the document.
* @param requestObj contains request parameters
*/
getAvailableFonts(requestObj: model.GetAvailableFontsRequest): Promise<model.WordsIncomingMessage<model.AvailableFontsResponse>>;
/**
* Reads a bookmark, specified by name, from the document.
* @param requestObj contains request parameters
*/
getBookmarkByName(requestObj: model.GetBookmarkByNameRequest): Promise<model.WordsIncomingMessage<model.BookmarkResponse>>;
/**
* Reads a bookmark, specified by name, from the document.
* @param requestObj contains request parameters
*/
getBookmarkByNameOnline(requestObj: model.GetBookmarkByNameOnlineRequest): Promise<model.WordsIncomingMessage<model.BookmarkResponse>>;
/**
* Reads bookmarks from the document.
* @param requestObj contains request parameters
*/
getBookmarks(requestObj: model.GetBookmarksRequest): Promise<model.WordsIncomingMessage<model.BookmarksResponse>>;
/**
* Reads bookmarks from the document.
* @param requestObj contains request parameters
*/
getBookmarksOnline(requestObj: model.GetBookmarksOnlineRequest): Promise<model.WordsIncomingMessage<model.BookmarksResponse>>;
/**
* Reads a border from the document node.
* The 'nodePath' parameter should refer to a paragraph, a cell or a row.
* @param requestObj contains request parameters
*/
getBorder(requestObj: model.GetBorderRequest): Promise<model.WordsIncomingMessage<model.BorderResponse>>;
/**
* Reads a border from the document node.
* The 'nodePath' parameter should refer to a paragraph, a cell or a row.
* @param requestObj contains request parameters
*/
getBorderOnline(requestObj: model.GetBorderOnlineRequest): Promise<model.WordsIncomingMessage<model.BorderResponse>>;
/**
* Reads borders from the document node.
* @param requestObj contains request parameters
*/
getBorders(requestObj: model.GetBordersRequest): Promise<model.WordsIncomingMessage<model.BordersResponse>>;
/**
* Reads borders from the document node.
* @param requestObj contains request parameters
*/
getBordersOnline(requestObj: model.GetBordersOnlineRequest): Promise<model.WordsIncomingMessage<model.BordersResponse>>;
/**
* Reads a comment from the document.
* @param requestObj contains request parameters
*/
getComment(requestObj: model.GetCommentRequest): Promise<model.WordsIncomingMessage<model.CommentResponse>>;
/**
* Reads a comment from the document.
* @param requestObj contains request parameters
*/
getCommentOnline(requestObj: model.GetCommentOnlineRequest): Promise<model.WordsIncomingMessage<model.CommentResponse>>;
/**
* Reads comments from the document.
* @param requestObj contains request parameters
*/
getComments(requestObj: model.GetCommentsRequest): Promise<model.WordsIncomingMessage<model.CommentsResponse>>;
/**
* Reads comments from the document.
* @param requestObj contains request parameters
*/
getCommentsOnline(requestObj: model.GetCommentsOnlineRequest): Promise<model.WordsIncomingMessage<model.CommentsResponse>>;
/**
* Reads the custom xml part from the document.
* @param requestObj contains request parameters
*/
getCustomXmlPart(requestObj: model.GetCustomXmlPartRequest): Promise<model.WordsIncomingMessage<model.CustomXmlPartResponse>>;
/**
* Reads the custom xml part from the document.
* @param requestObj contains request parameters
*/
getCustomXmlPartOnline(requestObj: model.GetCustomXmlPartOnlineRequest): Promise<model.WordsIncomingMessage<model.CustomXmlPartResponse>>;
/**
* Reads custom xml parts from the document.
* @param requestObj contains request parameters
*/
getCustomXmlParts(requestObj: model.GetCustomXmlPartsRequest): Promise<model.WordsIncomingMessage<model.CustomXmlPartsResponse>>;
/**
* Reads custom xml parts from the document.
* @param requestObj contains request parameters
*/
getCustomXmlPartsOnline(requestObj: model.GetCustomXmlPartsOnlineRequest): Promise<model.WordsIncomingMessage<model.CustomXmlPartsResponse>>;
/**
* Reads common information from the document.
* @param requestObj contains request parameters
*/
getDocument(requestObj: model.GetDocumentRequest): Promise<model.WordsIncomingMessage<model.DocumentResponse>>;
/**
* Reads a DrawingObject from the document node.
* @param requestObj contains request parameters
*/
getDocumentDrawingObjectByIndex(requestObj: model.GetDocumentDrawingObjectByIndexRequest): Promise<model.WordsIncomingMessage<model.DrawingObjectResponse>>;
/**
* Reads a DrawingObject from the document node.
* @param requestObj contains request parameters
*/
getDocumentDrawingObjectByIndexOnline(requestObj: model.GetDocumentDrawingObjectByIndexOnlineRequest): Promise<model.WordsIncomingMessage<model.DrawingObjectResponse>>;
/**
* Reads image data of a DrawingObject from the document node.
* @param requestObj contains request parameters
*/
getDocumentDrawingObjectImageData(requestObj: model.GetDocumentDrawingObjectImageDataRequest): Promise<model.WordsIncomingMessage<Buffer>>;
/**
* Reads image data of a DrawingObject from the document node.
* @param requestObj contains request parameters
*/
getDocumentDrawingObjectImageDataOnline(requestObj: model.GetDocumentDrawingObjectImageDataOnlineRequest): Promise<model.WordsIncomingMessage<Buffer>>;
/**
* Reads OLE data of a DrawingObject from the document node.
* @param requestObj contains request parameters
*/
getDocumentDrawingObjectOleData(requestObj: model.GetDocumentDrawingObjectOleDataRequest): Promise<model.WordsIncomingMessage<Buffer>>;
/**
* Reads OLE data of a DrawingObject from the document node.
* @param requestObj contains request parameters
*/
getDocumentDrawingObjectOleDataOnline(requestObj: model.GetDocumentDrawingObjectOleDataOnlineRequest): Promise<model.WordsIncomingMessage<Buffer>>;
/**
* Reads DrawingObjects from the document node.
* @param requestObj contains request parameters
*/
getDocumentDrawingObjects(requestObj: model.GetDocumentDrawingObjectsRequest): Promise<model.WordsIncomingMessage<model.DrawingObjectsResponse>>;
/**
* Reads DrawingObjects from the document node.
* @param requestObj contains request parameters
*/
getDocumentDrawingObjectsOnline(requestObj: model.GetDocumentDrawingObjectsOnlineRequest): Promise<model.WordsIncomingMessage<model.DrawingObjectsResponse>>;
/**
* Reads merge field names from the document.
* @param requestObj contains request parameters
*/
getDocumentFieldNames(requestObj: model.GetDocumentFieldNamesRequest): Promise<model.WordsIncomingMessage<model.FieldNamesResponse>>;
/**
* Reads merge field names from the document.
* @param requestObj contains request parameters
*/
getDocumentFieldNamesOnline(requestObj: model.GetDocumentFieldNamesOnlineRequest): Promise<model.WordsIncomingMessage<model.FieldNamesResponse>>;
/**
* Reads a hyperlink from the document.
* @param requestObj contains request parameters
*/
getDocumentHyperlinkByIndex(requestObj: model.GetDocumentHyperlinkByIndexRequest): Promise<model.WordsIncomingMessage<model.HyperlinkResponse>>;
/**
* Reads a hyperlink from the document.
* @param requestObj contains request parameters
*/
getDocumentHyperlinkByIndexOnline(requestObj: model.GetDocumentHyperlinkByIndexOnlineRequest): Promise<model.WordsIncomingMessage<model.HyperlinkResponse>>;
/**
* Reads hyperlinks from the document.
* @param requestObj contains request parameters
*/
getDocumentHyperlinks(requestObj: model.GetDocumentHyperlinksRequest): Promise<model.WordsIncomingMessage<model.HyperlinksResponse>>;
/**
* Reads hyperlinks from the document.
* @param requestObj contains request parameters
*/
getDocumentHyperlinksOnline(requestObj: model.GetDocumentHyperlinksOnlineRequest): Promise<model.WordsIncomingMessage<model.HyperlinksResponse>>;
/**
* Reads document properties.
* @param requestObj contains request parameters
*/
getDocumentProperties(requestObj: model.GetDocumentPropertiesRequest): Promise<model.WordsIncomingMessage<model.DocumentPropertiesResponse>>;
/**
* Reads document properties.
* @param requestObj contains request parameters
*/
getDocumentPropertiesOnline(requestObj: model.GetDocumentPropertiesOnlineRequest): Promise<model.WordsIncomingMessage<model.DocumentPropertiesResponse>>;
/**
* Reads a document property.
* @param requestObj contains request parameters
*/
getDocumentProperty(requestObj: model.GetDocumentPropertyRequest): Promise<model.WordsIncomingMessage<model.DocumentPropertyResponse>>;
/**
* Reads a document property.
* @param requestObj contains request parameters
*/
getDocumentPropertyOnline(requestObj: model.GetDocumentPropertyOnlineRequest): Promise<model.WordsIncomingMessage<model.DocumentPropertyResponse>>;
/**
* Reads protection properties from the document.
* @param requestObj contains request parameters
*/
getDocumentProtection(requestObj: model.GetDocumentProtectionRequest): Promise<model.WordsIncomingMessage<model.ProtectionDataResponse>>;
/**
* Reads protection properties from the document.
* @param requestObj contains request parameters
*/
getDocumentProtectionOnline(requestObj: model.GetDocumentProtectionOnlineRequest): Promise<model.WordsIncomingMessage<model.ProtectionDataResponse>>;
/**
* Reads document statistics.
* @param requestObj contains request parameters
*/
getDocumentStatistics(requestObj: model.GetDocumentStatisticsRequest): Promise<model.WordsIncomingMessage<model.StatDataResponse>>;
/**
* Reads document statistics.
* @param requestObj contains request parameters
*/
getDocumentStatisticsOnline(requestObj: model.GetDocumentStatisticsOnlineRequest): Promise<model.WordsIncomingMessage<model.StatDataResponse>>;
/**
* Converts a document in cloud storage to the specified format.
* @param requestObj contains request parameters
*/
getDocumentWithFormat(requestObj: model.GetDocumentWithFormatRequest): Promise<model.WordsIncomingMessage<Buffer>>;
/**
* Reads a field from the document node.
* @param requestObj contains request parameters
*/
getField(requestObj: model.GetFieldRequest): Promise<model.WordsIncomingMessage<model.FieldResponse>>;
/**
* Reads a field from the document node.
* @param requestObj contains request parameters
*/
getFieldOnline(requestObj: model.GetFieldOnlineRequest): Promise<model.WordsIncomingMessage<model.FieldResponse>>;
/**
* Reads fields from the document node.
* @param requestObj contains request parameters
*/
getFields(requestObj: model.GetFieldsRequest): Promise<model.WordsIncomingMessage<model.FieldsResponse>>;
/**
* Reads fields from the document node.
* @param requestObj contains request parameters
*/
getFieldsOnline(requestObj: model.GetFieldsOnlineRequest): Promise<model.WordsIncomingMessage<model.FieldsResponse>>;
/**
* Get all files and folders within a folder.
* @param requestObj contains request parameters
*/
getFilesList(requestObj: model.GetFilesListRequest): Promise<model.WordsIncomingMessage<model.FilesList>>;
/**
* Reads a footnote from the document node.
* @param requestObj contains request parameters
*/
getFootnote(requestObj: model.GetFootnoteRequest): Promise<model.WordsIncomingMessage<model.FootnoteResponse>>;
/**
* Reads a footnote from the document node.
* @param requestObj contains request parameters
*/
getFootnoteOnline(requestObj: model.GetFootnoteOnlineRequest): Promise<model.WordsIncomingMessage<model.FootnoteResponse>>;
/**
* Reads footnotes from the document node.
* @param requestObj contains request parameters
*/
getFootnotes(requestObj: model.GetFootnotesRequest): Promise<model.WordsIncomingMessage<model.FootnotesResponse>>;
/**
* Reads footnotes from the document node.
* @param requestObj contains request parameters
*/
getFootnotesOnline(requestObj: model.GetFootnotesOnlineRequest): Promise<model.WordsIncomingMessage<model.FootnotesResponse>>;
/**
* Reads a form field from the document node.
* @param requestObj contains request parameters
*/
getFormField(requestObj: model.GetFormFieldRequest): Promise<model.WordsIncomingMessage<model.FormFieldResponse>>;
/**
* Reads a form field from the document node.
* @param requestObj contains request parameters
*/
getFormFieldOnline(requestObj: model.GetFormFieldOnlineRequest): Promise<model.WordsIncomingMessage<model.FormFieldResponse>>;
/**
* Reads form fields from the document node.
* @param requestObj contains request parameters
*/
getFormFields(requestObj: model.GetFormFieldsRequest): Promise<model.WordsIncomingMessage<model.FormFieldsResponse>>;
/**
* Reads form fields from the document node.
* @param requestObj contains request parameters
*/
getFormFieldsOnline(requestObj: model.GetFormFieldsOnlineRequest): Promise<model.WordsIncomingMessage<model.FormFieldsResponse>>;
/**
* Reads a HeaderFooter object from the document.
* @param requestObj contains request parameters
*/
getHeaderFooter(requestObj: model.GetHeaderFooterRequest): Promise<model.WordsIncomingMessage<model.HeaderFooterResponse>>;
/**
* Reads a HeaderFooter object from the document section.
* @param requestObj contains request parameters
*/
getHeaderFooterOfSection(requestObj: model.GetHeaderFooterOfSectionRequest): Promise<model.WordsIncomingMessage<model.HeaderFooterResponse>>;
/**
* Reads a HeaderFooter object from the document section.
* @param requestObj contains request parameters
*/
getHeaderFooterOfSectionOnline(requestObj: model.GetHeaderFooterOfSectionOnlineRequest): Promise<model.WordsIncomingMessage<model.HeaderFooterResponse>>;
/**
* Reads a HeaderFooter object from the document.
* @param requestObj contains request parameters
*/
getHeaderFooterOnline(requestObj: model.GetHeaderFooterOnlineRequest): Promise<model.WordsIncomingMessage<model.HeaderFooterResponse>>;
/**
* Reads HeaderFooter objects from the document section.
* @param requestObj contains request parameters
*/
getHeaderFooters(requestObj: model.GetHeaderFootersRequest): Promise<model.WordsIncomingMessage<model.HeaderFootersResponse>>;
/**
* Reads HeaderFooter objects from the document section.
* @param requestObj contains request parameters
*/
getHeaderFootersOnline(requestObj: model.GetHeaderFootersOnlineRequest): Promise<model.WordsIncomingMessage<model.HeaderFootersResponse>>;
/**
* Returns application info.
* @param requestObj contains request parameters
*/
getInfo(requestObj: model.GetInfoRequest): Promise<model.WordsIncomingMessage<model.InfoResponse>>;
/**
* Reads a list from the document.
* @param requestObj contains request parameters
*/
getList(requestObj: model.GetListRequest): Promise<model.WordsIncomingMessage<model.ListResponse>>;
/**
* Reads a list from the document.
* @param requestObj contains request parameters
*/
getListOnline(requestObj: model.GetListOnlineRequest): Promise<model.WordsIncomingMessage<model.ListResponse>>;
/**
* Reads lists from the document.
* @param requestObj contains request parameters
*/
getLists(requestObj: model.GetListsRequest): Promise<model.WordsIncomingMessage<model.ListsResponse>>;
/**
* Reads lists from the document.
* @param requestObj contains request parameters
*/
getListsOnline(requestObj: model.GetListsOnlineRequest): Promise<model.WordsIncomingMessage<model.ListsResponse>>;
/**
* Reads an OfficeMath object from the document node.
* @param requestObj contains request parameters
*/
getOfficeMathObject(requestObj: model.GetOfficeMathObjectRequest): Promise<model.WordsIncomingMessage<model.OfficeMathObjectResponse>>;
/**
* Reads an OfficeMath object from the document node.
* @param requestObj contains request parameters
*/
getOfficeMathObjectOnline(requestObj: model.GetOfficeMathObjectOnlineRequest): Promise<model.WordsIncomingMessage<model.OfficeMathObjectResponse>>;
/**
* Reads OfficeMath objects from the document node.
* @param requestObj contains request parameters
*/
getOfficeMathObjects(requestObj: model.GetOfficeMathObjectsRequest): Promise<model.WordsIncomingMessage<model.OfficeMathObjectsResponse>>;
/**
* Reads OfficeMath objects from the document node.
* @param requestObj contains request parameters
*/
getOfficeMathObjectsOnline(requestObj: model.GetOfficeMathObjectsOnlineRequest): Promise<model.WordsIncomingMessage<model.OfficeMathObjectsResponse>>;
/**
* Reads a paragraph from the document node.
* @param requestObj contains request parameters
*/
getParagraph(requestObj: model.GetParagraphRequest): Promise<model.WordsIncomingMessage<model.ParagraphResponse>>;
/**
* Reads the formatting properties of a paragraph from the document node.
* @param requestObj contains request parameters
*/
getParagraphFormat(requestObj: model.GetParagraphFormatRequest): Promise<model.WordsIncomingMessage<model.ParagraphFormatResponse>>;
/**
* Reads the formatting properties of a paragraph from the document node.
* @param requestObj contains request parameters
*/
getParagraphFormatOnline(requestObj: model.GetParagraphFormatOnlineRequest): Promise<model.WordsIncomingMessage<model.ParagraphFormatResponse>>;
/**
* Reads the formatting properties of a paragraph list from the document node.
* @param requestObj contains request parameters
*/
getParagraphListFormat(requestObj: model.GetParagraphListFormatRequest): Promise<model.WordsIncomingMessage<model.ParagraphListFormatResponse>>;
/**
* Reads the formatting properties of a paragraph list from the document node.
* @param requestObj contains request parameters
*/
getParagraphListFormatOnline(requestObj: model.GetParagraphListFormatOnlineRequest): Promise<model.WordsIncomingMessage<model.ParagraphListFormatResponse>>;
/**
* Reads a paragraph from the document node.
* @param requestObj contains request parameters
*/
getParagraphOnline(requestObj: model.GetParagraphOnlineRequest): Promise<model.WordsIncomingMessage<model.ParagraphResponse>>;
/**
* Reads paragraphs from the document node.
* @param requestObj contains request parameters
*/
getParagraphs(requestObj: model.GetParagraphsRequest): Promise<model.WordsIncomingMessage<model.ParagraphLinkCollectionResponse>>;
/**
* Reads paragraphs from the document node.
* @param requestObj contains request parameters
*/
getParagraphsOnline(requestObj: model.GetParagraphsOnlineRequest): Promise<model.WordsIncomingMessage<model.ParagraphLinkCollectionResponse>>;
/**
* Reads paragraph tab stops from the document node.
* @param requestObj contains request parameters
*/
getParagraphTabStops(requestObj: model.GetParagraphTabStopsRequest): Promise<model.WordsIncomingMessage<model.TabStopsResponse>>;
/**
* Reads paragraph tab stops from the document node.
* @param requestObj contains request parameters
*/
getParagraphTabStopsOnline(requestObj: model.GetParagraphTabStopsOnlineRequest): Promise<model.WordsIncomingMessage<model.TabStopsResponse>>;
/**
* Get assymetric public key.
* @param requestObj contains request parameters
*/
getPublicKey(requestObj: model.GetPublicKeyRequest): Promise<model.WordsIncomingMessage<model.PublicKeyResponse>>;
/**
* Reads range text from the document.
* @param requestObj contains request parameters
*/
getRangeText(requestObj: model.GetRangeTextRequest): Promise<model.WordsIncomingMessage<model.RangeTextResponse>>;
/**
* Reads range text from the document.
* @param requestObj contains request parameters
*/
getRangeTextOnline(requestObj: model.GetRangeTextOnlineRequest): Promise<model.WordsIncomingMessage<model.RangeTextResponse>>;
/**
* Reads a Run object from the paragraph.
* @param requestObj contains request parameters
*/
getRun(requestObj: model.GetRunRequest): Promise<model.WordsIncomingMessage<model.RunResponse>>;
/**
* Reads the font properties of a Run object from the paragraph.
* @param requestObj contains request parameters
*/
getRunFont(requestObj: model.GetRunFontRequest): Promise<model.WordsIncomingMessage<model.FontResponse>>;
/**
* Reads the font properties of a Run object from the paragraph.
* @param requestObj contains request parameters
*/
getRunFontOnline(requestObj: model.GetRunFontOnlineRequest): Promise<model.WordsIncomingMessage<model.FontResponse>>;
/**
* Reads a Run object from the paragraph.
* @param requestObj contains request parameters
*/
getRunOnline(requestObj: model.GetRunOnlineRequest): Promise<model.WordsIncomingMessage<model.RunResponse>>;
/**
* Reads Run objects from the paragraph.
* @param requestObj contains request parameters
*/
getRuns(requestObj: model.GetRunsRequest): Promise<model.WordsIncomingMessage<model.RunsResponse>>;
/**
* Reads Run objects from the paragraph.
* @param requestObj contains request parameters
*/
getRunsOnline(requestObj: model.GetRunsOnlineRequest): Promise<model.WordsIncomingMessage<model.RunsResponse>>;
/**
* Reads a section from the document.
* @param requestObj contains request parameters
*/
getSection(requestObj: model.GetSectionRequest): Promise<model.WordsIncomingMessage<model.SectionResponse>>;
/**
* Reads a section from the document.
* @param requestObj contains request parameters
*/
getSectionOnline(requestObj: model.GetSectionOnlineRequest): Promise<model.WordsIncomingMessage<model.SectionResponse>>;
/**
* Reads the page setup of a section from the document.
* @param requestObj contains request parameters
*/
getSectionPageSetup(requestObj: model.GetSectionPageSetupRequest): Promise<model.WordsIncomingMessage<model.SectionPageSetupResponse>>;
/**
* Reads the page setup of a section from the document.
* @param requestObj contains request parameters
*/
getSectionPageSetupOnline(requestObj: model.GetSectionPageSetupOnlineRequest): Promise<model.WordsIncomingMessage<model.SectionPageSetupResponse>>;
/**
* Reads sections from the document.
* @param requestObj contains request parameters
*/
getSections(requestObj: model.GetSectionsRequest): Promise<model.WordsIncomingMessage<model.SectionLinkCollectionResponse>>;
/**
* Reads sections from the document.
* @param requestObj contains request parameters
*/
getSectionsOnline(requestObj: model.GetSectionsOnlineRequest): Promise<model.WordsIncomingMessage<model.SectionLinkCollectionResponse>>;
/**
* Gets signatures from the document.
* @param requestObj contains request parameters
*/
getSignatures(requestObj: model.GetSignaturesRequest): Promise<model.WordsIncomingMessage<model.SignatureCollectionResponse>>;
/**
* Gets signatures from the document.
* @param requestObj contains request parameters
*/
getSignaturesOnline(requestObj: model.GetSignaturesOnlineRequest): Promise<model.WordsIncomingMessage<model.SignatureCollectionResponse>>;
/**
* Reads a StructuredDocumentTag (SDT) from the document node.
* @param requestObj contains request parameters
*/
getStructuredDocumentTag(requestObj: model.GetStructuredDocumentTagRequest): Promise<model.WordsIncomingMessage<model.StructuredDocumentTagResponse>>;
/**
* Reads a StructuredDocumentTag (SDT) from the document node.
* @param requestObj contains request parameters
*/
getStructuredDocumentTagOnline(requestObj: model.GetStructuredDocumentTagOnlineRequest): Promise<model.WordsIncomingMessage<model.StructuredDocumentTagResponse>>;
/**
* Reads StructuredDocumentTags (SDT) from the document node.
* @param requestObj contains request parameters
*/
getStructuredDocumentTags(requestObj: model.GetStructuredDocumentTagsRequest): Promise<model.WordsIncomingMessage<model.StructuredDocumentTagsResponse>>;
/**
* Reads StructuredDocumentTags (SDT) from the document node.
* @param requestObj contains request parameters
*/
getStructuredDocumentTagsOnline(requestObj: model.GetStructuredDocumentTagsOnlineRequest): Promise<model.WordsIncomingMessage<model.StructuredDocumentTagsResponse>>;
/**
* Reads a style from the document.
* @param requestObj contains request parameters
*/
getStyl