Class: AsposeWordsCloud::ProtectDocumentOnlineRequest

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

Overview

Request model for protect_document_online operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(document, protection_request, load_encoding = nil, password = nil, dest_file_name = nil) ⇒ ProtectDocumentOnlineRequest

Initializes a new instance.

Parameters:

  • document —

    The document.

  • protection_request —

    Protection request.

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



55
56
57
58
59
60
61
 
# File 'lib/aspose_words_cloud/models/requests/protect_document_online_request.rb', line 55

def initialize(document, protection_request, load_encoding = nil, password = nil, dest_file_name = nil)
  self.document = document
  self.protection_request = protection_request
  self.load_encoding = load_encoding
  self.password = password
  self.dest_file_name = dest_file_name
end

Instance Attribute Details

#dest_file_name ⇒ Object

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



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

def dest_file_name
  @dest_file_name
end

#document ⇒ Object

The document.



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

def document
  @document
end

#load_encoding ⇒ Object

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



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

def load_encoding
  @load_encoding
end

#password ⇒ Object

Password for opening an encrypted document.



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

def password
  @password
end

#protection_request ⇒ Object

Protection request.



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

def protection_request
  @protection_request
end