Class: AsposeWordsCloud::InsertWatermarkImageOnlineRequest
- Inherits:
-
Object
- Object
- AsposeWordsCloud::InsertWatermarkImageOnlineRequest
- Defined in:
- lib/aspose_words_cloud/models/requests/insert_watermark_image_online_request.rb
Overview
Request model for insert_watermark_image_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.
-
#image ⇒ Object
The filename of the image.
-
#image_file ⇒ Object
File with image.
-
#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.
-
#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.
-
#rotation_angle ⇒ Object
The rotation angle of the watermark.
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:, image_file: nil, load_encoding: nil, password: nil, encrypted_password: nil, dest_file_name: nil, revision_author: nil, revision_date_time: nil, rotation_angle: nil, image: nil) ⇒ InsertWatermarkImageOnlineRequest
constructor
Initializes a new instance.
-
#to_batch_part(api_client, requestId, parentRequestId = nil) ⇒ Object
Creating batch part from request.
Constructor Details
#initialize(document:, image_file: nil, load_encoding: nil, password: nil, encrypted_password: nil, dest_file_name: nil, revision_author: nil, revision_date_time: nil, rotation_angle: nil, image: nil) ⇒ InsertWatermarkImageOnlineRequest
Initializes a new instance.
75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/aspose_words_cloud/models/requests/insert_watermark_image_online_request.rb', line 75 def initialize(document:, image_file: nil, load_encoding: nil, password: nil, encrypted_password: nil, dest_file_name: nil, revision_author: nil, revision_date_time: nil, rotation_angle: nil, image: nil) self.document = document self.image_file = image_file 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 self.rotation_angle = rotation_angle self.image = image 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.
48 49 50 |
# File 'lib/aspose_words_cloud/models/requests/insert_watermark_image_online_request.rb', line 48 def dest_file_name @dest_file_name end |
#document ⇒ Object
The document.
33 34 35 |
# File 'lib/aspose_words_cloud/models/requests/insert_watermark_image_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/insert_watermark_image_online_request.rb', line 45 def encrypted_password @encrypted_password end |
#image ⇒ Object
The filename of the image. If the parameter value is missing — the image data is expected in the request content.
60 61 62 |
# File 'lib/aspose_words_cloud/models/requests/insert_watermark_image_online_request.rb', line 60 def image @image end |
#image_file ⇒ Object
File with image.
36 37 38 |
# File 'lib/aspose_words_cloud/models/requests/insert_watermark_image_online_request.rb', line 36 def image_file @image_file 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/insert_watermark_image_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/insert_watermark_image_online_request.rb', line 42 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.
51 52 53 |
# File 'lib/aspose_words_cloud/models/requests/insert_watermark_image_online_request.rb', line 51 def @revision_author end |
#revision_date_time ⇒ Object
The date and time to use for revisions.
54 55 56 |
# File 'lib/aspose_words_cloud/models/requests/insert_watermark_image_online_request.rb', line 54 def revision_date_time @revision_date_time end |
#rotation_angle ⇒ Object
The rotation angle of the watermark.
57 58 59 |
# File 'lib/aspose_words_cloud/models/requests/insert_watermark_image_online_request.rb', line 57 def rotation_angle @rotation_angle end |
Instance Method Details
#create_http_request(api_client) ⇒ Object
159 160 161 162 163 164 165 166 167 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 |
# File 'lib/aspose_words_cloud/models/requests/insert_watermark_image_online_request.rb', line 159 def create_http_request(api_client) # verify the required parameter 'document' is set raise ArgumentError, 'Missing the required parameter document when calling WordsApi.insert_watermark_image_online' if api_client.config.client_side_validation && self.document.nil? # resource path local_var_path = '/words/online/post/watermarks/images'[1..-1] 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? query_params[downcase_first_letter('RotationAngle')] = self.rotation_angle unless self.rotation_angle.nil? query_params[downcase_first_letter('Image')] = self.image unless self.image.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 unless self.image_file.nil? form_params.push({:'Name' => 'imageFile', :'Data' => self.image_file, :'MimeType' =>'application/octet-stream'}) 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
211 212 213 |
# File 'lib/aspose_words_cloud/models/requests/insert_watermark_image_online_request.rb', line 211 def downcase_first_letter(str) str[0].downcase + str[1..-1] end |
#get_response_type ⇒ Object
Get response type
216 217 218 |
# File 'lib/aspose_words_cloud/models/requests/insert_watermark_image_online_request.rb', line 216 def get_response_type 'InsertWatermarkImageOnlineResponse' 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 |
# File 'lib/aspose_words_cloud/models/requests/insert_watermark_image_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.insert_watermark_image_online' if api_client.config.client_side_validation && self.document.nil? # resource path local_var_path = '/words/online/post/watermarks/images'[7..-1] 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? query_params[downcase_first_letter('RotationAngle')] = self.rotation_angle unless self.rotation_angle.nil? query_params[downcase_first_letter('Image')] = self.image unless self.image.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 unless self.image_file.nil? form_params.push({:'Name' => 'imageFile', :'Data' => self.image_file, :'MimeType' =>'application/octet-stream'}) 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 |