Class: AsposeWordsCloud::GetHeaderFooterOnlineRequest
- Inherits:
-
Object
- Object
- AsposeWordsCloud::GetHeaderFooterOnlineRequest
- Defined in:
- lib/aspose_words_cloud/models/requests/get_header_footer_online_request.rb
Overview
Request model for get_header_footer_online operation.
Instance Attribute Summary collapse
-
#document ⇒ Object
The document.
-
#encrypted_password ⇒ Object
Password of protected Word document.
-
#filter_by_type ⇒ Object
The list of HeaderFooter types.
-
#header_footer_index ⇒ Object
The index of the HeaderFooter object.
-
#load_encoding ⇒ Object
Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
-
#password ⇒ Object
Password of protected Word document.
Instance Method Summary collapse
- #create_http_request(api_client) ⇒ Object
-
#downcase_first_letter(str) ⇒ Object
Helper method to convert first letter to downcase.
-
#get_response_type ⇒ Object
Get response type.
-
#initialize(document:, header_footer_index:, load_encoding: nil, password: nil, encrypted_password: nil, filter_by_type: nil) ⇒ GetHeaderFooterOnlineRequest
constructor
Initializes a new instance.
-
#to_batch_part(api_client, guid) ⇒ Object
Creating batch part from request.
Constructor Details
#initialize(document:, header_footer_index:, load_encoding: nil, password: nil, encrypted_password: nil, filter_by_type: nil) ⇒ GetHeaderFooterOnlineRequest
Initializes a new instance.
59 60 61 62 63 64 65 66 |
# File 'lib/aspose_words_cloud/models/requests/get_header_footer_online_request.rb', line 59 def initialize(document:, header_footer_index:, load_encoding: nil, password: nil, encrypted_password: nil, filter_by_type: nil) self.document = document self. = self.load_encoding = load_encoding self.password = password self.encrypted_password = encrypted_password self.filter_by_type = filter_by_type end |
Instance Attribute Details
#document ⇒ Object
The document.
33 34 35 |
# File 'lib/aspose_words_cloud/models/requests/get_header_footer_online_request.rb', line 33 def document @document end |
#encrypted_password ⇒ Object
Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
45 46 47 |
# File 'lib/aspose_words_cloud/models/requests/get_header_footer_online_request.rb', line 45 def encrypted_password @encrypted_password end |
#filter_by_type ⇒ Object
The list of HeaderFooter types.
48 49 50 |
# File 'lib/aspose_words_cloud/models/requests/get_header_footer_online_request.rb', line 48 def filter_by_type @filter_by_type end |
#header_footer_index ⇒ Object
The index of the HeaderFooter object.
36 37 38 |
# File 'lib/aspose_words_cloud/models/requests/get_header_footer_online_request.rb', line 36 def @header_footer_index 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/get_header_footer_online_request.rb', line 39 def load_encoding @load_encoding end |
#password ⇒ Object
Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API.
42 43 44 |
# File 'lib/aspose_words_cloud/models/requests/get_header_footer_online_request.rb', line 42 def password @password end |
Instance Method Details
#create_http_request(api_client) ⇒ Object
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 |
# File 'lib/aspose_words_cloud/models/requests/get_header_footer_online_request.rb', line 124 def create_http_request(api_client) # verify the required parameter 'document' is set raise ArgumentError, 'Missing the required parameter document when calling WordsApi.get_header_footer_online' if api_client.config.client_side_validation && self.document.nil? # verify the required parameter 'header_footer_index' is set raise ArgumentError, 'Missing the required parameter header_footer_index when calling WordsApi.get_header_footer_online' if api_client.config.client_side_validation && self..nil? # resource path local_var_path = '/words/online/get/headersfooters/{headerFooterIndex}'[1..-1] local_var_path = local_var_path.sub('{' + downcase_first_letter('HeaderFooterIndex') + '}', self..nil? ? '' : self..to_s) local_var_path = local_var_path.sub('//', '/') # query parameters query_params = {} query_params[downcase_first_letter('LoadEncoding')] = self.load_encoding unless self.load_encoding.nil? query_params[downcase_first_letter('Password')] = self.password unless self.password.nil? query_params[downcase_first_letter('EncryptedPassword')] = self.encrypted_password unless self.encrypted_password.nil? query_params[downcase_first_letter('FilterByType')] = self.filter_by_type unless self.filter_by_type.nil? # header parameters header_params = {} # HTTP header 'Content-Type' header_params['Content-Type'] = api_client.select_header_content_type(['multipart/form-data']) # form parameters form_params = {} form_params[downcase_first_letter('Document')] = self.document # http body (model) post_body = nil body = api_client.build_request_body(header_params, form_params, post_body) { 'method': :PUT, 'path': local_var_path, 'header_params': header_params, 'query_params': query_params, 'body': body, 'auth_names': ['JWT'] } end |
#downcase_first_letter(str) ⇒ Object
Helper method to convert first letter to downcase
167 168 169 |
# File 'lib/aspose_words_cloud/models/requests/get_header_footer_online_request.rb', line 167 def downcase_first_letter(str) str[0].downcase + str[1..-1] end |
#get_response_type ⇒ Object
Get response type
172 173 174 |
# File 'lib/aspose_words_cloud/models/requests/get_header_footer_online_request.rb', line 172 def get_response_type 'HeaderFooterResponse' end |
#to_batch_part(api_client, guid) ⇒ Object
Creating batch part from request
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
# File 'lib/aspose_words_cloud/models/requests/get_header_footer_online_request.rb', line 69 def to_batch_part(api_client, guid) # verify the required parameter 'document' is set raise ArgumentError, 'Missing the required parameter document when calling WordsApi.get_header_footer_online' if api_client.config.client_side_validation && self.document.nil? # verify the required parameter 'header_footer_index' is set raise ArgumentError, 'Missing the required parameter header_footer_index when calling WordsApi.get_header_footer_online' if api_client.config.client_side_validation && self..nil? # resource path local_var_path = '/words/online/get/headersfooters/{headerFooterIndex}'[7..-1] local_var_path = local_var_path.sub('{' + downcase_first_letter('HeaderFooterIndex') + '}', self..nil? ? '' : self..to_s) local_var_path = local_var_path.sub('//', '/') # query parameters query_params = {} query_params[downcase_first_letter('LoadEncoding')] = self.load_encoding unless self.load_encoding.nil? query_params[downcase_first_letter('Password')] = self.password unless self.password.nil? query_params[downcase_first_letter('EncryptedPassword')] = self.encrypted_password unless self.encrypted_password.nil? query_params[downcase_first_letter('FilterByType')] = self.filter_by_type unless self.filter_by_type.nil? if query_params query_params.each { |key, value| local_var_path = api_client.add_param_to_query(local_var_path, key, value) } end header_params = {} # header parameters # HTTP header 'Content-Type' header_params['Content-Type'] = api_client.select_header_content_type(['multipart/form-data']) header_params['RequestId'] = guid # form parameters form_params = {} form_params[downcase_first_letter('Document')] = self.document # http body (model) post_body = nil body = api_client.build_request_body_batch(header_params, form_params, post_body) part = "" part.concat("PUT".force_encoding('UTF-8')) part.concat(" ".force_encoding('UTF-8')) part.concat(local_var_path.force_encoding('UTF-8')) part.concat(" \r\n".force_encoding('UTF-8')) header_params.each_pair {|key, value| part.concat(key.dup.force_encoding('UTF-8') , ": ".force_encoding('UTF-8'), value.dup.force_encoding('UTF-8'), "\r\n".force_encoding('UTF-8')) } part.concat("\r\n".force_encoding('UTF-8')) if body if body.is_a?(Hash) body.each do |key, value| part.concat(value, "\r\n") end else part.concat(body) end end part end |