class AsposeWordsCloud::SaveAsTiffOnlineRequest
Request model for save_as_tiff_online operation.
Attributes
The optional dml effects rendering mode. The default value is Simplified.
The optional dml rendering mode. The default value is Fallback.
The 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.
Folder in filestorage with custom fonts.
The level of brightness for the generated images.
The color mode for the generated images.
The contrast for the generated images.
Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
The images numeral format.
The value indicates whether OpenType support is on.
The number of pages to render.
The index of the page to start rendering.
The background image color.
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 pixel format of the generated images.
The resolution of the generated images.
Tiff save options.
The zoom factor for the generated images.
The optional TIFF binarization method. Possible values are: FloydSteinbergDithering, Threshold.
The compression tipe.
The flag indicating whether to use antialiasing.
The flag indicating whether to use high quality.
The flag indicating whether to ZIP the output.
Public Class Methods
Source
# File lib/aspose_words_cloud/models/requests/save_as_tiff_online_request.rb, line 131 def initialize(document:, save_options:, load_encoding: nil, password: nil, encrypted_password: nil, open_type_support: nil, use_anti_aliasing: nil, use_high_quality_rendering: nil, image_brightness: nil, image_color_mode: nil, image_contrast: nil, numeral_format: nil, page_count: nil, page_index: nil, paper_color: nil, pixel_format: nil, resolution: nil, scale: nil, tiff_compression: nil, dml_rendering_mode: nil, dml_effects_rendering_mode: nil, tiff_binarization_method: nil, zip_output: nil, fonts_location: nil) self.document = document self.save_options = save_options self.load_encoding = load_encoding self.password = password self.encrypted_password = encrypted_password self.open_type_support = open_type_support self.use_anti_aliasing = use_anti_aliasing self.use_high_quality_rendering = use_high_quality_rendering self.image_brightness = image_brightness self.image_color_mode = image_color_mode self.image_contrast = image_contrast self.numeral_format = numeral_format self.page_count = page_count self.page_index = page_index self.paper_color = paper_color self.pixel_format = pixel_format self.resolution = resolution self.scale = scale self.tiff_compression = tiff_compression self.dml_rendering_mode = dml_rendering_mode self.dml_effects_rendering_mode = dml_effects_rendering_mode self.tiff_binarization_method = tiff_binarization_method self.zip_output = zip_output self.fonts_location = fonts_location end
Initializes a new instance. @param document The document. @param save_options
Tiff save options. @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 use_anti_aliasing
The flag indicating whether to use antialiasing. @param use_high_quality_rendering
The flag indicating whether to use high quality. @param image_brightness
The level of brightness for the generated images. @param image_color_mode
The color mode for the generated images. @param image_contrast
The contrast for the generated images. @param numeral_format
The images numeral format. @param page_count
The number of pages to render. @param page_index
The index of the page to start rendering. @param paper_color
The background image color. @param pixel_format
The pixel format of the generated images. @param resolution The resolution of the generated images. @param scale The zoom factor for the generated images. @param tiff_compression
The compression tipe. @param dml_rendering_mode
The optional dml rendering mode. The default value is Fallback. @param dml_effects_rendering_mode
The optional dml effects rendering mode. The default value is Simplified. @param tiff_binarization_method
The optional TIFF binarization method. Possible values are: FloydSteinbergDithering, Threshold. @param zip_output
The flag indicating whether to ZIP the output. @param fonts_location
Folder in filestorage with custom fonts.
Public Instance Methods
Source
# File lib/aspose_words_cloud/models/requests/save_as_tiff_online_request.rb, line 248 def create_http_request(api_client) # verify the required parameter 'document' is set raise ArgumentError, 'Missing the required parameter document when calling WordsApi.save_as_tiff_online' if api_client.config.client_side_validation && self.document.nil? # verify the required parameter 'save_options' is set raise ArgumentError, 'Missing the required parameter save_options when calling WordsApi.save_as_tiff_online' if api_client.config.client_side_validation && self.save_options.nil? self.save_options.validate # resource path local_var_path = '/words/online/put/saveAs/tiff'[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('OpenTypeSupport')] = self.open_type_support unless self.open_type_support.nil? query_params[downcase_first_letter('UseAntiAliasing')] = self.use_anti_aliasing unless self.use_anti_aliasing.nil? query_params[downcase_first_letter('UseHighQualityRendering')] = self.use_high_quality_rendering unless self.use_high_quality_rendering.nil? query_params[downcase_first_letter('ImageBrightness')] = self.image_brightness unless self.image_brightness.nil? query_params[downcase_first_letter('ImageColorMode')] = self.image_color_mode unless self.image_color_mode.nil? query_params[downcase_first_letter('ImageContrast')] = self.image_contrast unless self.image_contrast.nil? query_params[downcase_first_letter('NumeralFormat')] = self.numeral_format unless self.numeral_format.nil? query_params[downcase_first_letter('PageCount')] = self.page_count unless self.page_count.nil? query_params[downcase_first_letter('PageIndex')] = self.page_index unless self.page_index.nil? query_params[downcase_first_letter('PaperColor')] = self.paper_color unless self.paper_color.nil? query_params[downcase_first_letter('PixelFormat')] = self.pixel_format unless self.pixel_format.nil? query_params[downcase_first_letter('Resolution')] = self.resolution unless self.resolution.nil? query_params[downcase_first_letter('Scale')] = self.scale unless self.scale.nil? query_params[downcase_first_letter('TiffCompression')] = self.tiff_compression unless self.tiff_compression.nil? query_params[downcase_first_letter('DmlRenderingMode')] = self.dml_rendering_mode unless self.dml_rendering_mode.nil? query_params[downcase_first_letter('DmlEffectsRenderingMode')] = self.dml_effects_rendering_mode unless self.dml_effects_rendering_mode.nil? query_params[downcase_first_letter('TiffBinarizationMethod')] = self.tiff_binarization_method unless self.tiff_binarization_method.nil? query_params[downcase_first_letter('ZipOutput')] = self.zip_output unless self.zip_output.nil? query_params[downcase_first_letter('FontsLocation')] = self.fonts_location unless self.fonts_location.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.save_options.nil? raise "Parameter SaveOptions is required." end unless self.save_options.nil? form_params.push({:'Name' => 'saveOptions', :'Data' => self.save_options.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
Source
# File lib/aspose_words_cloud/models/requests/save_as_tiff_online_request.rb, line 319 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/save_as_tiff_online_request.rb, line 324 def get_response_type 'SaveAsTiffOnlineResponse' end
Get response type
Source
# File lib/aspose_words_cloud/models/requests/save_as_tiff_online_request.rb, line 159 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.save_as_tiff_online' if api_client.config.client_side_validation && self.document.nil? # verify the required parameter 'save_options' is set raise ArgumentError, 'Missing the required parameter save_options when calling WordsApi.save_as_tiff_online' if api_client.config.client_side_validation && self.save_options.nil? self.save_options.validate # resource path local_var_path = '/words/online/put/saveAs/tiff'[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('OpenTypeSupport')] = self.open_type_support unless self.open_type_support.nil? query_params[downcase_first_letter('UseAntiAliasing')] = self.use_anti_aliasing unless self.use_anti_aliasing.nil? query_params[downcase_first_letter('UseHighQualityRendering')] = self.use_high_quality_rendering unless self.use_high_quality_rendering.nil? query_params[downcase_first_letter('ImageBrightness')] = self.image_brightness unless self.image_brightness.nil? query_params[downcase_first_letter('ImageColorMode')] = self.image_color_mode unless self.image_color_mode.nil? query_params[downcase_first_letter('ImageContrast')] = self.image_contrast unless self.image_contrast.nil? query_params[downcase_first_letter('NumeralFormat')] = self.numeral_format unless self.numeral_format.nil? query_params[downcase_first_letter('PageCount')] = self.page_count unless self.page_count.nil? query_params[downcase_first_letter('PageIndex')] = self.page_index unless self.page_index.nil? query_params[downcase_first_letter('PaperColor')] = self.paper_color unless self.paper_color.nil? query_params[downcase_first_letter('PixelFormat')] = self.pixel_format unless self.pixel_format.nil? query_params[downcase_first_letter('Resolution')] = self.resolution unless self.resolution.nil? query_params[downcase_first_letter('Scale')] = self.scale unless self.scale.nil? query_params[downcase_first_letter('TiffCompression')] = self.tiff_compression unless self.tiff_compression.nil? query_params[downcase_first_letter('DmlRenderingMode')] = self.dml_rendering_mode unless self.dml_rendering_mode.nil? query_params[downcase_first_letter('DmlEffectsRenderingMode')] = self.dml_effects_rendering_mode unless self.dml_effects_rendering_mode.nil? query_params[downcase_first_letter('TiffBinarizationMethod')] = self.tiff_binarization_method unless self.tiff_binarization_method.nil? query_params[downcase_first_letter('ZipOutput')] = self.zip_output unless self.zip_output.nil? query_params[downcase_first_letter('FontsLocation')] = self.fonts_location unless self.fonts_location.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.save_options.nil? raise "Parameter SaveOptions is required." end unless self.save_options.nil? form_params.push({:'Name' => 'saveOptions', :'Data' => self.save_options.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
Creating batch part from request