class AsposeWordsCloud::InsertWatermarkImageRequest
Request model for insert_watermark_image operation.
Attributes
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.
Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
Original document folder.
The filename of the image. If the parameter value is missing — the image data is expected in the request content.
File with image.
Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
The filename of the input document.
The value indicates whether OpenType support is on.
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.
The date and time to use for revisions.
The rotation angle of the watermark.
Original document storage.
Public Class Methods
Source
# File lib/aspose_words_cloud/models/requests/insert_watermark_image_request.rb, line 87 def initialize(name:, image_file: nil, folder: nil, storage: nil, load_encoding: nil, password: nil, encrypted_password: nil, open_type_support: nil, dest_file_name: nil, revision_author: nil, revision_date_time: nil, rotation_angle: nil, image: nil) self.name = name self.image_file = image_file self.folder = folder self.storage = storage self.load_encoding = load_encoding self.password = password self.encrypted_password = encrypted_password self.open_type_support = open_type_support self.dest_file_name = dest_file_name self.revision_author = revision_author self.revision_date_time = revision_date_time self.rotation_angle = rotation_angle self.image = image end
Initializes a new instance. @param name The filename of the input document. @param image_file
File with image. @param folder Original document folder. @param storage Original document storage. @param load_encoding
Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param password 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. @param encrypted_password
Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. @param open_type_support
The value indicates whether OpenType support is on. @param dest_file_name
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. @param revision_author
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. @param revision_date_time
The date and time to use for revisions. @param rotation_angle
The rotation angle of the watermark. @param image The filename of the image. If the parameter value is missing — the image data is expected in the request content.
Public Instance Methods
Source
# File lib/aspose_words_cloud/models/requests/insert_watermark_image_request.rb, line 171 def create_http_request(api_client) # verify the required parameter 'name' is set raise ArgumentError, 'Missing the required parameter name when calling WordsApi.insert_watermark_image' if api_client.config.client_side_validation && self.name.nil? # resource path local_var_path = '/words/{name}/watermarks/images'[1..-1] local_var_path = local_var_path.sub('{' + downcase_first_letter('Name') + '}', self.name.nil? ? '' : self.name.to_s) local_var_path = local_var_path.sub('//', '/') # query parameters query_params = {} query_params[downcase_first_letter('Folder')] = self.folder unless self.folder.nil? query_params[downcase_first_letter('Storage')] = self.storage unless self.storage.nil? 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('OpenTypeSupport')] = self.open_type_support unless self.open_type_support.nil? query_params[downcase_first_letter('DestFileName')] = self.dest_file_name unless self.dest_file_name.nil? query_params[downcase_first_letter('RevisionAuthor')] = self.revision_author unless self.revision_author.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 = [] 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': :POST, 'path': local_var_path, 'header_params': header_params, 'query_params': query_params, 'body': body, 'auth_names': ['JWT'] } end
Source
# File lib/aspose_words_cloud/models/requests/insert_watermark_image_request.rb, line 220 def downcase_first_letter(str) str[0].downcase + str[1..-1] end
Helper method to convert first letter to downcase
Source
# File lib/aspose_words_cloud/models/requests/insert_watermark_image_request.rb, line 225 def get_response_type 'DocumentResponse' end
Get response type
Source
# File lib/aspose_words_cloud/models/requests/insert_watermark_image_request.rb, line 104 def to_batch_part(api_client, requestId, parentRequestId = nil) # verify the required parameter 'name' is set raise ArgumentError, 'Missing the required parameter name when calling WordsApi.insert_watermark_image' if api_client.config.client_side_validation && self.name.nil? # resource path local_var_path = '/words/{name}/watermarks/images'[7..-1] local_var_path = local_var_path.sub('{' + downcase_first_letter('Name') + '}', self.name.nil? ? '' : self.name.to_s) local_var_path = local_var_path.sub('//', '/') # query parameters query_params = {} query_params[downcase_first_letter('Folder')] = self.folder unless self.folder.nil? query_params[downcase_first_letter('Storage')] = self.storage unless self.storage.nil? 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('OpenTypeSupport')] = self.open_type_support unless self.open_type_support.nil? query_params[downcase_first_letter('DestFileName')] = self.dest_file_name unless self.dest_file_name.nil? query_params[downcase_first_letter('RevisionAuthor')] = self.revision_author unless self.revision_author.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 = [] 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("POST".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
Creating batch part from request