api

package
v2102.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 2, 2021 License: MIT Imports: 27 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CacheExpires

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient

type APIClient struct {

	// API Services
	WordsApi *WordsApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Aspose.Words for Cloud API Reference API v21.2 In most cases there should be only one, shared, APIClient.

func NewAPIClient

func NewAPIClient(cfg *models.Configuration) (client *APIClient, err error)

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

func (*APIClient) NewContextWithToken

func (c *APIClient) NewContextWithToken(ctx context.Context) (ctxWithToken context.Context, err error)

create context with token

type WordsApiService

type WordsApiService service

func CreateWordsApi

func CreateWordsApi(config *models.Configuration) (wordsApi *WordsApiService, ctxWithToken context.Context, err error)

func (*WordsApiService) AcceptAllRevisions

WordsApiService Accepts all revisions in the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.RevisionsModificationResponse

func (*WordsApiService) AppendDocument

WordsApiService Appends documents to the original document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.DocumentResponse

func (*WordsApiService) ApplyStyleToDocumentElement

WordsApiService Applies a style to the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.WordsResponse

func (*WordsApiService) Batch

func (a *WordsApiService) Batch(ctx context.Context, requests ...models.RequestInterface) ([]interface{}, *http.Response, error)
WordsApiService Batch request.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @requests to be called as one call.

@return array of results

func (*WordsApiService) BuildReport

WordsApiService Executes the report generation process using the specified document template and the external data source in XML, JSON or CSV format.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.DocumentResponse

func (*WordsApiService) Classify

WordsApiService Runs a multi-class text classification for the specified raw text.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.ClassificationResponse

func (*WordsApiService) ClassifyDocument

WordsApiService Runs a multi-class text classification for the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.ClassificationResponse

func (*WordsApiService) CompareDocument

WordsApiService Compares two documents.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.DocumentResponse

func (*WordsApiService) ConvertDocument

func (a *WordsApiService) ConvertDocument(ctx context.Context, data *models.ConvertDocumentRequest) (*http.Response, error)
WordsApiService Converts a document on a local drive to the specified format.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return http.Response.Body contains binary result data

func (*WordsApiService) CopyFile

WordsApiService Copy file.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return

func (*WordsApiService) CopyFolder

func (a *WordsApiService) CopyFolder(ctx context.Context, data *models.CopyFolderRequest) (*http.Response, error)
WordsApiService Copy folder.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return

func (*WordsApiService) CopyStyle

WordsApiService Makes a copy of the style in the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.StyleResponse

func (*WordsApiService) CreateDocument

WordsApiService Supported extensions: ".doc", ".docx", ".docm", ".dot", ".dotm", ".dotx", ".flatopc", ".fopc", ".flatopc_macro", ".fopc_macro", ".flatopc_template", ".fopc_template", ".flatopc_template_macro", ".fopc_template_macro", ".wordml", ".wml", ".rtf".
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.DocumentResponse

func (*WordsApiService) CreateFolder

func (a *WordsApiService) CreateFolder(ctx context.Context, data *models.CreateFolderRequest) (*http.Response, error)
WordsApiService Create the folder.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return

func (*WordsApiService) CreateOrUpdateDocumentProperty

WordsApiService Adds a new or updates an existing document property.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.DocumentPropertyResponse

func (*WordsApiService) DeleteAllParagraphTabStops

WordsApiService Removes paragraph tab stops from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.TabStopsResponse

func (*WordsApiService) DeleteBorder

WordsApiService The 'nodePath' parameter should refer to a paragraph, a cell or a row.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.BorderResponse

func (*WordsApiService) DeleteBorders

WordsApiService The 'nodePath' parameter should refer to a paragraph, a cell or a row.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.BordersResponse

func (*WordsApiService) DeleteComment

func (a *WordsApiService) DeleteComment(ctx context.Context, data *models.DeleteCommentRequest) (*http.Response, error)
WordsApiService Removes a comment from the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return

func (*WordsApiService) DeleteComments

func (a *WordsApiService) DeleteComments(ctx context.Context, data *models.DeleteCommentsRequest) (*http.Response, error)
WordsApiService Removes all comments from the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return

func (*WordsApiService) DeleteDocumentProperty

func (a *WordsApiService) DeleteDocumentProperty(ctx context.Context, data *models.DeleteDocumentPropertyRequest) (*http.Response, error)
WordsApiService Removes a document property.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return

func (*WordsApiService) DeleteDrawingObject

func (a *WordsApiService) DeleteDrawingObject(ctx context.Context, data *models.DeleteDrawingObjectRequest) (*http.Response, error)
WordsApiService Removes a DrawingObject from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return

func (*WordsApiService) DeleteField

func (a *WordsApiService) DeleteField(ctx context.Context, data *models.DeleteFieldRequest) (*http.Response, error)
WordsApiService Removes a field from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return

func (*WordsApiService) DeleteFields

func (a *WordsApiService) DeleteFields(ctx context.Context, data *models.DeleteFieldsRequest) (*http.Response, error)
WordsApiService Removes fields from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return

func (*WordsApiService) DeleteFile

func (a *WordsApiService) DeleteFile(ctx context.Context, data *models.DeleteFileRequest) (*http.Response, error)
WordsApiService Delete file.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return

func (*WordsApiService) DeleteFolder

func (a *WordsApiService) DeleteFolder(ctx context.Context, data *models.DeleteFolderRequest) (*http.Response, error)
WordsApiService Delete folder.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return

func (*WordsApiService) DeleteFootnote

func (a *WordsApiService) DeleteFootnote(ctx context.Context, data *models.DeleteFootnoteRequest) (*http.Response, error)
WordsApiService Removes a footnote from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return

func (*WordsApiService) DeleteFormField

func (a *WordsApiService) DeleteFormField(ctx context.Context, data *models.DeleteFormFieldRequest) (*http.Response, error)
WordsApiService Removes a form field from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return

func (*WordsApiService) DeleteHeaderFooter

func (a *WordsApiService) DeleteHeaderFooter(ctx context.Context, data *models.DeleteHeaderFooterRequest) (*http.Response, error)
WordsApiService Removes a HeaderFooter object from the document section.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return

func (*WordsApiService) DeleteHeadersFooters

func (a *WordsApiService) DeleteHeadersFooters(ctx context.Context, data *models.DeleteHeadersFootersRequest) (*http.Response, error)
WordsApiService Removes HeaderFooter objects from the document section.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return

func (*WordsApiService) DeleteMacros

func (a *WordsApiService) DeleteMacros(ctx context.Context, data *models.DeleteMacrosRequest) (*http.Response, error)
WordsApiService Removes macros from the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return

func (*WordsApiService) DeleteOfficeMathObject

func (a *WordsApiService) DeleteOfficeMathObject(ctx context.Context, data *models.DeleteOfficeMathObjectRequest) (*http.Response, error)
WordsApiService Removes an OfficeMath object from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return

func (*WordsApiService) DeleteParagraph

func (a *WordsApiService) DeleteParagraph(ctx context.Context, data *models.DeleteParagraphRequest) (*http.Response, error)
WordsApiService Removes a paragraph from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return

func (*WordsApiService) DeleteParagraphListFormat

WordsApiService Removes the formatting properties of a paragraph list from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.ParagraphListFormatResponse

func (*WordsApiService) DeleteParagraphTabStop

WordsApiService Removes a paragraph tab stop from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.TabStopsResponse

func (*WordsApiService) DeleteRun

WordsApiService Removes a Run object from the paragraph.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return

func (*WordsApiService) DeleteSection

func (a *WordsApiService) DeleteSection(ctx context.Context, data *models.DeleteSectionRequest) (*http.Response, error)
WordsApiService Removes a section from the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return

func (*WordsApiService) DeleteTable

func (a *WordsApiService) DeleteTable(ctx context.Context, data *models.DeleteTableRequest) (*http.Response, error)
WordsApiService Removes a table from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return

func (*WordsApiService) DeleteTableCell

func (a *WordsApiService) DeleteTableCell(ctx context.Context, data *models.DeleteTableCellRequest) (*http.Response, error)
WordsApiService Removes a cell from the table row.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return

func (*WordsApiService) DeleteTableRow

func (a *WordsApiService) DeleteTableRow(ctx context.Context, data *models.DeleteTableRowRequest) (*http.Response, error)
WordsApiService Removes a row from the table.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return

func (*WordsApiService) DeleteWatermark

WordsApiService Removes a watermark from the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.DocumentResponse

func (*WordsApiService) DownloadFile

func (a *WordsApiService) DownloadFile(ctx context.Context, data *models.DownloadFileRequest) (*http.Response, error)
WordsApiService Download file.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return http.Response.Body contains binary result data

func (*WordsApiService) ExecuteMailMerge

WordsApiService Executes a Mail Merge operation.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.DocumentResponse

func (*WordsApiService) GetAvailableFonts

WordsApiService Reads available fonts from the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.AvailableFontsResponse

func (*WordsApiService) GetBookmarkByName

WordsApiService Reads a bookmark, specified by name, from the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.BookmarkResponse

func (*WordsApiService) GetBookmarks

WordsApiService Reads bookmarks from the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.BookmarksResponse

func (*WordsApiService) GetBorder

WordsApiService The 'nodePath' parameter should refer to a paragraph, a cell or a row.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.BorderResponse

func (*WordsApiService) GetBorders

WordsApiService Reads borders from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.BordersResponse

func (*WordsApiService) GetComment

WordsApiService Reads a comment from the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.CommentResponse

func (*WordsApiService) GetComments

WordsApiService Reads comments from the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.CommentsResponse

func (*WordsApiService) GetDocument

WordsApiService Reads common information from the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.DocumentResponse

func (*WordsApiService) GetDocumentDrawingObjectByIndex

WordsApiService Reads a DrawingObject from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.DrawingObjectResponse

func (*WordsApiService) GetDocumentDrawingObjectImageData

func (a *WordsApiService) GetDocumentDrawingObjectImageData(ctx context.Context, data *models.GetDocumentDrawingObjectImageDataRequest) (*http.Response, error)
WordsApiService Reads image data of a DrawingObject from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return http.Response.Body contains binary result data

func (*WordsApiService) GetDocumentDrawingObjectOleData

func (a *WordsApiService) GetDocumentDrawingObjectOleData(ctx context.Context, data *models.GetDocumentDrawingObjectOleDataRequest) (*http.Response, error)
WordsApiService Reads OLE data of a DrawingObject from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return http.Response.Body contains binary result data

func (*WordsApiService) GetDocumentDrawingObjects

WordsApiService Reads DrawingObjects from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.DrawingObjectsResponse

func (*WordsApiService) GetDocumentFieldNames

WordsApiService Reads merge field names from the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.FieldNamesResponse

func (*WordsApiService) GetDocumentHyperlinkByIndex

WordsApiService Reads a hyperlink from the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.HyperlinkResponse

WordsApiService Reads hyperlinks from the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.HyperlinksResponse

func (*WordsApiService) GetDocumentProperties

WordsApiService Reads document properties.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.DocumentPropertiesResponse

func (*WordsApiService) GetDocumentProperty

WordsApiService Reads a document property.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.DocumentPropertyResponse

func (*WordsApiService) GetDocumentProtection

WordsApiService Reads protection properties from the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.ProtectionDataResponse

func (*WordsApiService) GetDocumentStatistics

WordsApiService Reads document statistics.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.StatDataResponse

func (*WordsApiService) GetDocumentWithFormat

func (a *WordsApiService) GetDocumentWithFormat(ctx context.Context, data *models.GetDocumentWithFormatRequest) (*http.Response, error)
WordsApiService Converts a document in cloud storage to the specified format.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return http.Response.Body contains binary result data

func (*WordsApiService) GetField

WordsApiService Reads a field from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.FieldResponse

func (*WordsApiService) GetFields

WordsApiService Reads fields from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.FieldsResponse

func (*WordsApiService) GetFilesList

WordsApiService Get all files and folders within a folder.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.FilesList

func (*WordsApiService) GetFootnote

WordsApiService Reads a footnote from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.FootnoteResponse

func (*WordsApiService) GetFootnotes

WordsApiService Reads footnotes from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.FootnotesResponse

func (*WordsApiService) GetFormField

WordsApiService Reads a form field from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.FormFieldResponse

func (*WordsApiService) GetFormFields

WordsApiService Reads form fields from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.FormFieldsResponse

func (*WordsApiService) GetHeaderFooter

WordsApiService Reads a HeaderFooter object from the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.HeaderFooterResponse

func (*WordsApiService) GetHeaderFooterOfSection

WordsApiService Reads a HeaderFooter object from the document section.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.HeaderFooterResponse

func (*WordsApiService) GetHeaderFooters

WordsApiService Reads HeaderFooter objects from the document section.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.HeaderFootersResponse

func (*WordsApiService) GetList

WordsApiService Reads a list from the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.ListResponse

func (*WordsApiService) GetLists

WordsApiService Reads lists from the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.ListsResponse

func (*WordsApiService) GetOfficeMathObject

WordsApiService Reads an OfficeMath object from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.OfficeMathObjectResponse

func (*WordsApiService) GetOfficeMathObjects

WordsApiService Reads OfficeMath objects from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.OfficeMathObjectsResponse

func (*WordsApiService) GetParagraph

WordsApiService Reads a paragraph from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.ParagraphResponse

func (*WordsApiService) GetParagraphFormat

WordsApiService Reads the formatting properties of a paragraph from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.ParagraphFormatResponse

func (*WordsApiService) GetParagraphListFormat

WordsApiService Reads the formatting properties of a paragraph list from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.ParagraphListFormatResponse

func (*WordsApiService) GetParagraphTabStops

WordsApiService Reads paragraph tab stops from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.TabStopsResponse

func (*WordsApiService) GetParagraphs

WordsApiService Reads paragraphs from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.ParagraphLinkCollectionResponse

func (*WordsApiService) GetRangeText

WordsApiService Reads range text from the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.RangeTextResponse

func (*WordsApiService) GetRun

WordsApiService Reads a Run object from the paragraph.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.RunResponse

func (*WordsApiService) GetRunFont

WordsApiService Reads the font properties of a Run object from the paragraph.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.FontResponse

func (*WordsApiService) GetRuns

WordsApiService Reads Run objects from the paragraph.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.RunsResponse

func (*WordsApiService) GetSection

WordsApiService Reads a section from the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.SectionResponse

func (*WordsApiService) GetSectionPageSetup

WordsApiService Reads the page setup of a section from the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.SectionPageSetupResponse

func (*WordsApiService) GetSections

WordsApiService Reads sections from the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.SectionLinkCollectionResponse

func (*WordsApiService) GetStyle

WordsApiService Reads a style from the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.StyleResponse

func (*WordsApiService) GetStyleFromDocumentElement

WordsApiService Reads a style from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.StyleResponse

func (*WordsApiService) GetStyles

WordsApiService Reads styles from the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.StylesResponse

func (*WordsApiService) GetTable

WordsApiService Reads a table from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.TableResponse

func (*WordsApiService) GetTableCell

WordsApiService Reads a cell from the table row.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.TableCellResponse

func (*WordsApiService) GetTableCellFormat

WordsApiService Reads the formatting properties of a table cell.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.TableCellFormatResponse

func (*WordsApiService) GetTableProperties

WordsApiService Reads properties of a table from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.TablePropertiesResponse

func (*WordsApiService) GetTableRow

WordsApiService Reads a row from the table.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.TableRowResponse

func (*WordsApiService) GetTableRowFormat

WordsApiService Reads the formatting properties of a table row.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.TableRowFormatResponse

func (*WordsApiService) GetTables

WordsApiService Reads tables from the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.TableLinkCollectionResponse

func (*WordsApiService) InsertComment

WordsApiService Inserts a new comment to the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.CommentResponse

func (*WordsApiService) InsertDrawingObject

WordsApiService Inserts a new DrawingObject to the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.DrawingObjectResponse

func (*WordsApiService) InsertField

WordsApiService Inserts a new field to the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.FieldResponse

func (*WordsApiService) InsertFootnote

WordsApiService Inserts a new footnote to the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.FootnoteResponse

func (*WordsApiService) InsertFormField

WordsApiService Inserts a new form field to the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.FormFieldResponse

func (*WordsApiService) InsertHeaderFooter

WordsApiService Inserts a new HeaderFooter object to the document section.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.HeaderFooterResponse

func (*WordsApiService) InsertList

WordsApiService Inserts a new list to the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.ListResponse

func (*WordsApiService) InsertOrUpdateParagraphTabStop

WordsApiService Inserts a new or updates an existing paragraph tab stop in the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.TabStopsResponse

func (*WordsApiService) InsertPageNumbers

WordsApiService Inserts page numbers to the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.DocumentResponse

func (*WordsApiService) InsertParagraph

WordsApiService Inserts a new paragraph to the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.ParagraphResponse

func (*WordsApiService) InsertRun

WordsApiService Inserts a new Run object to the paragraph.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.RunResponse

func (*WordsApiService) InsertStyle

WordsApiService Inserts a new style to the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.StyleResponse

func (*WordsApiService) InsertTable

WordsApiService Inserts a new table to the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.TableResponse

func (*WordsApiService) InsertTableCell

WordsApiService Inserts a new cell to the table row.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.TableCellResponse

func (*WordsApiService) InsertTableRow

WordsApiService Inserts a new row to the table.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.TableRowResponse

func (*WordsApiService) InsertWatermarkImage

WordsApiService Inserts a new watermark image to the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.DocumentResponse

func (*WordsApiService) InsertWatermarkText

WordsApiService Inserts a new watermark text to the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.DocumentResponse

func (*WordsApiService) LoadWebDocument

WordsApiService Downloads a document from the Web using URL and saves it to cloud storage in the specified format.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.SaveResponse

func (*WordsApiService) MoveFile

WordsApiService Move file.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return

func (*WordsApiService) MoveFolder

func (a *WordsApiService) MoveFolder(ctx context.Context, data *models.MoveFolderRequest) (*http.Response, error)
WordsApiService Move folder.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return

func (*WordsApiService) OptimizeDocument

func (a *WordsApiService) OptimizeDocument(ctx context.Context, data *models.OptimizeDocumentRequest) (*http.Response, error)
WordsApiService Applies document content optimization options, specific to a particular versions of Microsoft Word.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return

func (*WordsApiService) ProtectDocument

WordsApiService Adds protection to the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.ProtectionDataResponse

func (*WordsApiService) RejectAllRevisions

WordsApiService Rejects all revisions in the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.RevisionsModificationResponse

func (*WordsApiService) RemoveRange

WordsApiService Removes a range from the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.DocumentResponse

func (*WordsApiService) RenderDrawingObject

func (a *WordsApiService) RenderDrawingObject(ctx context.Context, data *models.RenderDrawingObjectRequest) (*http.Response, error)
WordsApiService Renders a DrawingObject to the specified format.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return http.Response.Body contains binary result data

func (*WordsApiService) RenderMathObject

func (a *WordsApiService) RenderMathObject(ctx context.Context, data *models.RenderMathObjectRequest) (*http.Response, error)
WordsApiService Renders an OfficeMath object to the specified format.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return http.Response.Body contains binary result data

func (*WordsApiService) RenderPage

func (a *WordsApiService) RenderPage(ctx context.Context, data *models.RenderPageRequest) (*http.Response, error)
WordsApiService Renders a page to the specified format.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return http.Response.Body contains binary result data

func (*WordsApiService) RenderParagraph

func (a *WordsApiService) RenderParagraph(ctx context.Context, data *models.RenderParagraphRequest) (*http.Response, error)
WordsApiService Renders a paragraph to the specified format.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return http.Response.Body contains binary result data

func (*WordsApiService) RenderTable

func (a *WordsApiService) RenderTable(ctx context.Context, data *models.RenderTableRequest) (*http.Response, error)
WordsApiService Renders a table to the specified format.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return http.Response.Body contains binary result data

func (*WordsApiService) ReplaceText

WordsApiService Replaces text in the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.ReplaceTextResponse

func (*WordsApiService) ReplaceWithText

WordsApiService Replaces a range with text in the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.DocumentResponse

func (*WordsApiService) ResetCache

func (a *WordsApiService) ResetCache(ctx context.Context, data *models.ResetCacheRequest) (*http.Response, error)
WordsApiService Clears the font cache.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return

func (*WordsApiService) SaveAs

WordsApiService Converts a document in cloud storage to the specified format.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.SaveResponse

func (*WordsApiService) SaveAsRange

WordsApiService Saves a range as a new document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.DocumentResponse

func (*WordsApiService) SaveAsTiff

WordsApiService Converts a document in cloud storage to TIFF format using detailed conversion settings.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.SaveResponse

func (*WordsApiService) Search

WordsApiService Searches text, specified by the regular expression, in the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.SearchResponse

func (*WordsApiService) SplitDocument

WordsApiService Splits a document into parts and saves them in the specified format.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.SplitDocumentResponse

func (*WordsApiService) UnprotectDocument

WordsApiService Removes protection from the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.ProtectionDataResponse

func (*WordsApiService) UpdateBookmark

WordsApiService Updates a bookmark in the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.BookmarkResponse

func (*WordsApiService) UpdateBorder

WordsApiService The 'nodePath' parameter should refer to a paragraph, a cell or a row.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.BorderResponse

func (*WordsApiService) UpdateComment

WordsApiService Updates a comment in the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.CommentResponse

func (*WordsApiService) UpdateDrawingObject

WordsApiService Updates a DrawingObject in the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.DrawingObjectResponse

func (*WordsApiService) UpdateField

WordsApiService Updates a field in the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.FieldResponse

func (*WordsApiService) UpdateFields

WordsApiService Reevaluates field values in the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.DocumentResponse

func (*WordsApiService) UpdateFootnote

WordsApiService Updates a footnote in the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.FootnoteResponse

func (*WordsApiService) UpdateFormField

WordsApiService Updates a form field in the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.FormFieldResponse

func (*WordsApiService) UpdateList

WordsApiService Updates a list in the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.ListResponse

func (*WordsApiService) UpdateListLevel

WordsApiService Updates the level of a List element in the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.ListResponse

func (*WordsApiService) UpdateParagraphFormat

WordsApiService Updates the formatting properties of a paragraph in the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.ParagraphFormatResponse

func (*WordsApiService) UpdateParagraphListFormat

WordsApiService Updates the formatting properties of a paragraph list in the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.ParagraphListFormatResponse

func (*WordsApiService) UpdateRun

WordsApiService Updates a Run object in the paragraph.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.RunResponse

func (*WordsApiService) UpdateRunFont

WordsApiService Updates the font properties of a Run object in the paragraph.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.FontResponse

func (*WordsApiService) UpdateSectionPageSetup

WordsApiService Updates the page setup of a section in the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.SectionPageSetupResponse

func (*WordsApiService) UpdateStyle

WordsApiService Updates a style in the document.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.StyleResponse

func (*WordsApiService) UpdateTableCellFormat

WordsApiService Updates the formatting properties of a cell in the table row.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.TableCellFormatResponse

func (*WordsApiService) UpdateTableProperties

WordsApiService Updates properties of a table in the document node.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.TablePropertiesResponse

func (*WordsApiService) UpdateTableRowFormat

WordsApiService Updates the formatting properties of a table row.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.TableRowFormatResponse

func (*WordsApiService) UploadFile

WordsApiService Upload file.
* @param ctx context.Context for authentication, logging, tracing, etc.
* @data operation request data.

@return models.FilesUploadResult

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL