Class: AsposeWordsCloud::BuildReportRequest

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

Overview

Request model for build_report operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, data, report_engine_settings, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil) ⇒ BuildReportRequest

Initializes a new instance.

Parameters:

  • name —

    The filename of the input document.

  • data —

    A string providing a data to populate the specified template. The string must be of one of the following types: xml, json, csv.

  • report_engine_settings —

    An object providing a settings of report engine.

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

  • dest_file_name (defaults to: nil) —

    The filename of the output document. If this parameter is omitted, the result will be saved with autogenerated name.



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/aspose_words_cloud/models/requests/build_report_request.rb', line 67

def initialize(name, data, report_engine_settings, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil)
  self.name = name
  self.data = data
  self.report_engine_settings = report_engine_settings
  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

#data ⇒ Object

A string providing a data to populate the specified template. The string must be of one of the following types: xml, json, csv.



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

def data
  @data
end

#dest_file_name ⇒ Object

The filename of the output document. If this parameter is omitted, the result will be saved with autogenerated name.



54
55
56
 
# File 'lib/aspose_words_cloud/models/requests/build_report_request.rb', line 54

def dest_file_name
  @dest_file_name
end

#folder ⇒ Object

Original document folder.



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

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.



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

def load_encoding
  @load_encoding
end

#name ⇒ Object

The filename of the input document.



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

def name
  @name
end

#password ⇒ Object

Password for opening an encrypted document.



51
52
53
 
# File 'lib/aspose_words_cloud/models/requests/build_report_request.rb', line 51

def password
  @password
end

#report_engine_settings ⇒ Object

An object providing a settings of report engine.



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

def report_engine_settings
  @report_engine_settings
end

#storage ⇒ Object

Original document storage.



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

def storage
  @storage
end