Class: WordsRubySdk::PostDocumentSaveAsRequest

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

Overview

Request model for post_document_save_as operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, save_options_data, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, fonts_location = nil) ⇒ PostDocumentSaveAsRequest

Initializes a new instance.

Parameters:

  • name —

    The document name.

  • save_options_data —

    Save options.

  • folder (defaults to: nil) —

    Original document folder.

  • storage (defaults to: nil) —

    File storage, which have to be used.

  • 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 name of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.

  • fonts_location (defaults to: nil) —

    Folder in filestorage with custom fonts.



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

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

Instance Attribute Details

#dest_file_name ⇒ Object

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



48
49
50
 
# File 'lib/words_ruby_sdk/models/requests/PostDocumentSaveAsRequest.rb', line 48

def dest_file_name
  @dest_file_name
end

#folder ⇒ Object

Original document folder.



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

def folder
  @folder
end

#fonts_location ⇒ Object

Folder in filestorage with custom fonts.



50
51
52
 
# File 'lib/words_ruby_sdk/models/requests/PostDocumentSaveAsRequest.rb', line 50

def fonts_location
  @fonts_location
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/words_ruby_sdk/models/requests/PostDocumentSaveAsRequest.rb', line 44

def load_encoding
  @load_encoding
end

#name ⇒ Object

The document name.



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

def name
  @name
end

#password ⇒ Object

Password for opening an encrypted document.



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

def password
  @password
end

#save_options_data ⇒ Object

Save options.



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

def save_options_data
  @save_options_data
end

#storage ⇒ Object

File storage, which have to be used.



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

def storage
  @storage
end