Class: AsposeWordsCloud::ConvertDocumentRequest

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

Overview

Request model for convert_document operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(document, format, out_path = nil, file_name_field_value = nil, storage = nil, fonts_location = nil) ⇒ ConvertDocumentRequest

Initializes a new instance.

Parameters:

  • document —

    Converting document.

  • format —

    The format to convert.

  • out_path (defaults to: nil) —

    The path to the output document on a local storage.

  • file_name_field_value (defaults to: nil) —

    The filename of the output document, that will be used when the resulting document has a dynamic field filename. If it is not set, the “sourceFilename” will be used instead.

  • storage (defaults to: nil) —

    Original document storage.

  • fonts_location (defaults to: nil) —

    Folder in filestorage with custom fonts.



59
60
61
62
63
64
65
66
 
# File 'lib/aspose_words_cloud/models/requests/convert_document_request.rb', line 59

def initialize(document, format, out_path = nil, file_name_field_value = nil, storage = nil, fonts_location = nil)
  self.document = document
  self.format = format
  self.out_path = out_path
  self.file_name_field_value = file_name_field_value
  self.storage = storage
  self.fonts_location = fonts_location
end

Instance Attribute Details

#document ⇒ Object

Converting document.



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

def document
  @document
end

#file_name_field_value ⇒ Object

The filename of the output document, that will be used when the resulting document has a dynamic field filename. If it is not set, the “sourceFilename” will be used instead.



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

def file_name_field_value
  @file_name_field_value
end

#fonts_location ⇒ Object

Folder in filestorage with custom fonts.



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

def fonts_location
  @fonts_location
end

#format ⇒ Object

The format to convert.



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

def format
  @format
end

#out_path ⇒ Object

The path to the output document on a local storage.



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

def out_path
  @out_path
end

#storage ⇒ Object

Original document storage.



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

def storage
  @storage
end