Class: WordsRubySdk::PutConvertDocumentRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/words_ruby_sdk/models/requests/PutConvertDocumentRequest.rb

Overview

Request model for put_convert_document operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(document, format, storage = nil, out_path = nil, document_file_name = nil, fonts_location = nil) ⇒ PutConvertDocumentRequest

Initializes a new instance.

Parameters:

  • document —

    Converting document

  • format —

    Format to convert.

  • storage (defaults to: nil) —

    File storage, which have to be used.

  • out_path (defaults to: nil) —

    Path for saving operation result to the local storage.

  • document_file_name (defaults to: nil) —

    This file name will be used when resulting document has dynamic field for document file name filename. If it is not setted, "sourceFilename" will be used instead.

  • fonts_location (defaults to: nil) —

    Folder in filestorage with custom fonts.



56
57
58
59
60
61
62
63
 
# File 'lib/words_ruby_sdk/models/requests/PutConvertDocumentRequest.rb', line 56

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

Instance Attribute Details

#document ⇒ Object

Converting document



36
37
38
 
# File 'lib/words_ruby_sdk/models/requests/PutConvertDocumentRequest.rb', line 36

def document
  @document
end

#document_file_name ⇒ Object

This file name will be used when resulting document has dynamic field for document file name filename. If it is not setted, "sourceFilename" will be used instead.



44
45
46
 
# File 'lib/words_ruby_sdk/models/requests/PutConvertDocumentRequest.rb', line 44

def document_file_name
  @document_file_name
end

#fonts_location ⇒ Object

Folder in filestorage with custom fonts.



46
47
48
 
# File 'lib/words_ruby_sdk/models/requests/PutConvertDocumentRequest.rb', line 46

def fonts_location
  @fonts_location
end

#format ⇒ Object

Format to convert.



38
39
40
 
# File 'lib/words_ruby_sdk/models/requests/PutConvertDocumentRequest.rb', line 38

def format
  @format
end

#out_path ⇒ Object

Path for saving operation result to the local storage.



42
43
44
 
# File 'lib/words_ruby_sdk/models/requests/PutConvertDocumentRequest.rb', line 42

def out_path
  @out_path
end

#storage ⇒ Object

File storage, which have to be used.



40
41
42
 
# File 'lib/words_ruby_sdk/models/requests/PutConvertDocumentRequest.rb', line 40

def storage
  @storage
end