Class: AsposeWordsCloud::GetDocumentWithFormatRequest

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

Overview

Request model for get_document_with_format operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, format, folder = nil, storage = nil, load_encoding = nil, password = nil, out_path = nil, fonts_location = nil) ⇒ GetDocumentWithFormatRequest

Initializes a new instance.

Parameters:

  • name —

    The document name.

  • format —

    The destination format.

  • 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.

  • out_path (defaults to: nil) —

    Path to save the result.

  • fonts_location (defaults to: nil) —

    Folder in filestorage with custom fonts.



62
63
64
65
66
67
68
69
70
71
 
# File 'lib/aspose_words_cloud/models/requests/GetDocumentWithFormatRequest.rb', line 62

def initialize(name, format, folder = nil, storage = nil, load_encoding = nil, password = nil, out_path = nil, fonts_location = nil)
   self.name = name
   self.format = format
   self.folder = folder
   self.storage = storage
   self.load_encoding = load_encoding
   self.password = password
   self.out_path = out_path
   self.fonts_location = fonts_location
end

Instance Attribute Details

#folder ⇒ Object

Original document folder.



40
41
42
 
# File 'lib/aspose_words_cloud/models/requests/GetDocumentWithFormatRequest.rb', line 40

def folder
  @folder
end

#fonts_location ⇒ Object

Folder in filestorage with custom fonts.



50
51
52
 
# File 'lib/aspose_words_cloud/models/requests/GetDocumentWithFormatRequest.rb', line 50

def fonts_location
  @fonts_location
end

#format ⇒ Object

The destination format.



38
39
40
 
# File 'lib/aspose_words_cloud/models/requests/GetDocumentWithFormatRequest.rb', line 38

def format
  @format
end

#load_encoding ⇒ Object

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



44
45
46
 
# File 'lib/aspose_words_cloud/models/requests/GetDocumentWithFormatRequest.rb', line 44

def load_encoding
  @load_encoding
end

#name ⇒ Object

The document name.



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

def name
  @name
end

#out_path ⇒ Object

Path to save the result.



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

def out_path
  @out_path
end

#password ⇒ Object

Password for opening an encrypted document.



46
47
48
 
# File 'lib/aspose_words_cloud/models/requests/GetDocumentWithFormatRequest.rb', line 46

def password
  @password
end

#storage ⇒ Object

Original document storage.



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

def storage
  @storage
end