Class: WordsRubySdk::GetHeaderFootersRequest
- Inherits:
-
Object
- Object
- WordsRubySdk::GetHeaderFootersRequest
- Defined in:
- lib/words_ruby_sdk/models/requests/GetHeaderFootersRequest.rb
Overview
Request model for get_header_footers operation.
Instance Attribute Summary collapse
-
#filter_by_type ⇒ Object
List of types of headers and footers.
-
#folder ⇒ Object
Original document folder.
-
#load_encoding ⇒ Object
Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
-
#name ⇒ Object
The document name.
-
#password ⇒ Object
Password for opening an encrypted document.
-
#section_path ⇒ Object
Path to parent section.
-
#storage ⇒ Object
File storage, which have to be used.
Instance Method Summary collapse
-
#initialize(name, folder = nil, storage = nil, load_encoding = nil, password = nil, section_path = nil, filter_by_type = nil) ⇒ GetHeaderFootersRequest
constructor
Initializes a new instance.
Constructor Details
#initialize(name, folder = nil, storage = nil, load_encoding = nil, password = nil, section_path = nil, filter_by_type = nil) ⇒ GetHeaderFootersRequest
Initializes a new instance.
59 60 61 62 63 64 65 66 67 |
# File 'lib/words_ruby_sdk/models/requests/GetHeaderFootersRequest.rb', line 59 def initialize(name, folder = nil, storage = nil, load_encoding = nil, password = nil, section_path = nil, filter_by_type = nil) self.name = name self.folder = folder self.storage = storage self.load_encoding = load_encoding self.password = password self.section_path = section_path self.filter_by_type = filter_by_type end |
Instance Attribute Details
#filter_by_type ⇒ Object
List of types of headers and footers.
48 49 50 |
# File 'lib/words_ruby_sdk/models/requests/GetHeaderFootersRequest.rb', line 48 def filter_by_type @filter_by_type end |
#folder ⇒ Object
Original document folder.
38 39 40 |
# File 'lib/words_ruby_sdk/models/requests/GetHeaderFootersRequest.rb', line 38 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.
42 43 44 |
# File 'lib/words_ruby_sdk/models/requests/GetHeaderFootersRequest.rb', line 42 def load_encoding @load_encoding end |
#name ⇒ Object
The document name.
36 37 38 |
# File 'lib/words_ruby_sdk/models/requests/GetHeaderFootersRequest.rb', line 36 def name @name end |
#password ⇒ Object
Password for opening an encrypted document.
44 45 46 |
# File 'lib/words_ruby_sdk/models/requests/GetHeaderFootersRequest.rb', line 44 def password @password end |
#section_path ⇒ Object
Path to parent section.
46 47 48 |
# File 'lib/words_ruby_sdk/models/requests/GetHeaderFootersRequest.rb', line 46 def section_path @section_path end |
#storage ⇒ Object
File storage, which have to be used.
40 41 42 |
# File 'lib/words_ruby_sdk/models/requests/GetHeaderFootersRequest.rb', line 40 def storage @storage end |