Class: WordsRubySdk::PutProtectDocumentRequest

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

Overview

Request model for put_protect_document operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, protection_request, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil) ⇒ PutProtectDocumentRequest

Initializes a new instance.



59
60
61
62
63
64
65
66
67
 
# File 'lib/words_ruby_sdk/models/requests/PutProtectDocumentRequest.rb', line 59

def initialize(name, protection_request, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil)
   self.name = name
   self.protection_request = protection_request
   self.folder = folder
   self.storage = storage
   self.load_encoding = load_encoding
   self.password = password
   self.dest_file_name = dest_file_name
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/PutProtectDocumentRequest.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/PutProtectDocumentRequest.rb', line 40

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.



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

def load_encoding
  @load_encoding
end

#name ⇒ Object

The document name.



36
37
38
 
# File 'lib/words_ruby_sdk/models/requests/PutProtectDocumentRequest.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/PutProtectDocumentRequest.rb', line 46

def password
  @password
end

#protection_request ⇒ Object

with protection settings.



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

def protection_request
  @protection_request
end

#storage ⇒ Object

File storage, which have to be used.



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

def storage
  @storage
end