Class: AsposeWordsCloud::UpdateRunFontOnlineRequest
- Inherits:
-
Object
- Object
- AsposeWordsCloud::UpdateRunFontOnlineRequest
- Defined in:
- lib/aspose_words_cloud/models/requests/update_run_font_online_request.rb
Overview
Request model for update_run_font_online operation.
Instance Attribute Summary collapse
-
#dest_file_name ⇒ Object
Result path of the document after the operation.
-
#document ⇒ Object
The document.
-
#encrypted_password ⇒ Object
Password of protected Word document.
-
#font_dto ⇒ Object
Font dto object.
-
#index ⇒ Object
Object index.
-
#load_encoding ⇒ Object
Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
-
#paragraph_path ⇒ Object
The path to the paragraph in the document tree.
-
#password ⇒ Object
Password of protected Word document.
-
#revision_author ⇒ Object
Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.
-
#revision_date_time ⇒ Object
The date and time to use for revisions.
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:, paragraph_path:, font_dto:, index:, load_encoding: nil, password: nil, encrypted_password: nil, dest_file_name: nil, revision_author: nil, revision_date_time: nil) ⇒ UpdateRunFontOnlineRequest
constructor
Initializes a new instance.
-
#to_batch_part(api_client, requestId, parentRequestId = nil) ⇒ Object
Creating batch part from request.
Constructor Details
#initialize(document:, paragraph_path:, font_dto:, index:, load_encoding: nil, password: nil, encrypted_password: nil, dest_file_name: nil, revision_author: nil, revision_date_time: nil) ⇒ UpdateRunFontOnlineRequest
Initializes a new instance.
75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/aspose_words_cloud/models/requests/update_run_font_online_request.rb', line 75 def initialize(document:, paragraph_path:, font_dto:, index:, load_encoding: nil, password: nil, encrypted_password: nil, dest_file_name: nil, revision_author: nil, revision_date_time: nil) self.document = document self.paragraph_path = paragraph_path self.font_dto = font_dto self.index = index self.load_encoding = load_encoding self.password = password self.encrypted_password = encrypted_password self.dest_file_name = dest_file_name self. = self.revision_date_time = revision_date_time 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.
54 55 56 |
# File 'lib/aspose_words_cloud/models/requests/update_run_font_online_request.rb', line 54 def dest_file_name @dest_file_name end |
#document ⇒ Object
The document.
33 34 35 |
# File 'lib/aspose_words_cloud/models/requests/update_run_font_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.
51 52 53 |
# File 'lib/aspose_words_cloud/models/requests/update_run_font_online_request.rb', line 51 def encrypted_password @encrypted_password end |
#font_dto ⇒ Object
Font dto object.
39 40 41 |
# File 'lib/aspose_words_cloud/models/requests/update_run_font_online_request.rb', line 39 def font_dto @font_dto end |
#index ⇒ Object
Object index.
42 43 44 |
# File 'lib/aspose_words_cloud/models/requests/update_run_font_online_request.rb', line 42 def index @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.
45 46 47 |
# File 'lib/aspose_words_cloud/models/requests/update_run_font_online_request.rb', line 45 def load_encoding @load_encoding end |
#paragraph_path ⇒ Object
The path to the paragraph in the document tree.
36 37 38 |
# File 'lib/aspose_words_cloud/models/requests/update_run_font_online_request.rb', line 36 def paragraph_path @paragraph_path 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.
48 49 50 |
# File 'lib/aspose_words_cloud/models/requests/update_run_font_online_request.rb', line 48 def password @password end |
#revision_author ⇒ Object
Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.
57 58 59 |
# File 'lib/aspose_words_cloud/models/requests/update_run_font_online_request.rb', line 57 def @revision_author end |
#revision_date_time ⇒ Object
The date and time to use for revisions.
60 61 62 |
# File 'lib/aspose_words_cloud/models/requests/update_run_font_online_request.rb', line 60 def revision_date_time @revision_date_time end |
Instance Method Details
#create_http_request(api_client) ⇒ Object
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 |
# File 'lib/aspose_words_cloud/models/requests/update_run_font_online_request.rb', line 168 def create_http_request(api_client) # verify the required parameter 'document' is set raise ArgumentError, 'Missing the required parameter document when calling WordsApi.update_run_font_online' if api_client.config.client_side_validation && self.document.nil? # verify the required parameter 'paragraph_path' is set raise ArgumentError, 'Missing the required parameter paragraph_path when calling WordsApi.update_run_font_online' if api_client.config.client_side_validation && self.paragraph_path.nil? # verify the required parameter 'font_dto' is set raise ArgumentError, 'Missing the required parameter font_dto when calling WordsApi.update_run_font_online' if api_client.config.client_side_validation && self.font_dto.nil? self.font_dto.validate# verify the required parameter 'index' is set raise ArgumentError, 'Missing the required parameter index when calling WordsApi.update_run_font_online' if api_client.config.client_side_validation && self.index.nil? # resource path local_var_path = '/words/online/put/{paragraphPath}/runs/{index}/font'[1..-1] local_var_path = local_var_path.sub('{' + downcase_first_letter('ParagraphPath') + '}', self.paragraph_path.nil? ? '' : self.paragraph_path.to_s) local_var_path = local_var_path.sub('{' + downcase_first_letter('Index') + '}', self.index.nil? ? '' : self.index.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('DestFileName')] = self.dest_file_name unless self.dest_file_name.nil? query_params[downcase_first_letter('RevisionAuthor')] = self. unless self..nil? query_params[downcase_first_letter('RevisionDateTime')] = self.revision_date_time unless self.revision_date_time.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 = [] files_content = [] if self.document.nil? raise "Parameter Document is required." end unless self.document.nil? form_params.push({:'Name' => 'document', :'Data' => self.document, :'MimeType' =>'application/octet-stream'}) end if self.font_dto.nil? raise "Parameter FontDto is required." end unless self.font_dto.nil? form_params.push({:'Name' => 'fontDto', :'Data' => self.font_dto.to_body.to_json, :'MimeType' =>'application/json'}) end body = api_client.build_request_body(header_params, form_params, files_content) { '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
229 230 231 |
# File 'lib/aspose_words_cloud/models/requests/update_run_font_online_request.rb', line 229 def downcase_first_letter(str) str[0].downcase + str[1..-1] end |
#get_response_type ⇒ Object
Get response type
234 235 236 |
# File 'lib/aspose_words_cloud/models/requests/update_run_font_online_request.rb', line 234 def get_response_type 'UpdateRunFontOnlineResponse' end |
#to_batch_part(api_client, requestId, parentRequestId = nil) ⇒ Object
Creating batch part from request
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 123 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 163 164 165 166 |
# File 'lib/aspose_words_cloud/models/requests/update_run_font_online_request.rb', line 89 def to_batch_part(api_client, requestId, parentRequestId = nil) # verify the required parameter 'document' is set raise ArgumentError, 'Missing the required parameter document when calling WordsApi.update_run_font_online' if api_client.config.client_side_validation && self.document.nil? # verify the required parameter 'paragraph_path' is set raise ArgumentError, 'Missing the required parameter paragraph_path when calling WordsApi.update_run_font_online' if api_client.config.client_side_validation && self.paragraph_path.nil? # verify the required parameter 'font_dto' is set raise ArgumentError, 'Missing the required parameter font_dto when calling WordsApi.update_run_font_online' if api_client.config.client_side_validation && self.font_dto.nil? self.font_dto.validate# verify the required parameter 'index' is set raise ArgumentError, 'Missing the required parameter index when calling WordsApi.update_run_font_online' if api_client.config.client_side_validation && self.index.nil? # resource path local_var_path = '/words/online/put/{paragraphPath}/runs/{index}/font'[7..-1] local_var_path = local_var_path.sub('{' + downcase_first_letter('ParagraphPath') + '}', self.paragraph_path.nil? ? '' : self.paragraph_path.to_s) local_var_path = local_var_path.sub('{' + downcase_first_letter('Index') + '}', self.index.nil? ? '' : self.index.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('DestFileName')] = self.dest_file_name unless self.dest_file_name.nil? query_params[downcase_first_letter('RevisionAuthor')] = self. unless self..nil? query_params[downcase_first_letter('RevisionDateTime')] = self.revision_date_time unless self.revision_date_time.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'] = requestId if parentRequestId != nil header_params['DependsOn'] = parentRequestId end # form parameters form_params = [] files_content = [] if self.document.nil? raise "Parameter Document is required." end unless self.document.nil? form_params.push({:'Name' => 'document', :'Data' => self.document, :'MimeType' =>'application/octet-stream'}) end if self.font_dto.nil? raise "Parameter FontDto is required." end unless self.font_dto.nil? form_params.push({:'Name' => 'fontDto', :'Data' => self.font_dto.to_body.to_json, :'MimeType' =>'application/json'}) end # http body (model) body = api_client.build_request_body_batch(header_params, form_params, files_content) 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 |