Class: AsposeWordsCloud::OptimizeDocumentRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_words_cloud/models/requests/optimize_document_request.rb

Overview

Request model for optimize_document operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, options, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil) ⇒ OptimizeDocumentRequest

Initializes a new instance.

Parameters:

  • name —

    The filename of the input document.

  • options —

    The document optimization options.

  • folder (defaults to: nil) —

    Original document folder.

  • storage (defaults to: nil) —

    Original document storage.

  • load_encoding (defaults to: nil) —

    Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

  • password (defaults to: nil) —

    Password for opening an encrypted document.

  • dest_file_name (defaults to: nil) —

    Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.

  • revision_author (defaults to: nil) —

    Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.

  • revision_date_time (defaults to: nil) —

    The date and time to use for revisions.



71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/aspose_words_cloud/models/requests/optimize_document_request.rb', line 71

def initialize(name, options, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil)
  self.name = name
  self.options = options
  self.folder = folder
  self.storage = storage
  self.load_encoding = load_encoding
  self.password = password
  self.dest_file_name = dest_file_name
  self.revision_author = revision_author
  self.revision_date_time = revision_date_time
end

Instance Attribute Details

#dest_file_name ⇒ Object

Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.



51
52
53
 
# File 'lib/aspose_words_cloud/models/requests/optimize_document_request.rb', line 51

def dest_file_name
  @dest_file_name
end

#folder ⇒ Object

Original document folder.



39
40
41
 
# File 'lib/aspose_words_cloud/models/requests/optimize_document_request.rb', line 39

def folder
  @folder
end

#load_encoding ⇒ Object

Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.



45
46
47
 
# File 'lib/aspose_words_cloud/models/requests/optimize_document_request.rb', line 45

def load_encoding
  @load_encoding
end

#name ⇒ Object

The filename of the input document.



33
34
35
 
# File 'lib/aspose_words_cloud/models/requests/optimize_document_request.rb', line 33

def name
  @name
end

#options ⇒ Object

The document optimization options.



36
37
38
 
# File 'lib/aspose_words_cloud/models/requests/optimize_document_request.rb', line 36

def options
  @options
end

#password ⇒ Object

Password for opening an encrypted document.



48
49
50
 
# File 'lib/aspose_words_cloud/models/requests/optimize_document_request.rb', line 48

def password
  @password
end

#revision_author ⇒ Object

Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.



54
55
56
 
# File 'lib/aspose_words_cloud/models/requests/optimize_document_request.rb', line 54

def revision_author
  @revision_author
end

#revision_date_time ⇒ Object

The date and time to use for revisions.



57
58
59
 
# File 'lib/aspose_words_cloud/models/requests/optimize_document_request.rb', line 57

def revision_date_time
  @revision_date_time
end

#storage ⇒ Object

Original document storage.



42
43
44
 
# File 'lib/aspose_words_cloud/models/requests/optimize_document_request.rb', line 42

def storage
  @storage
end