class AsposeWordsCloud::ConvertDocumentRequest
Request model for convert_document operation.
Attributes
Converting 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.
The filename of the output document, that will be used when the resulting document has a dynamic field {filename}. If it is not set, the “sourceFilename” will be used instead.
Folder in filestorage with custom fonts.
The format to convert.
Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
The value indicates whether OpenType support is on.
The path to the output document on a local storage.
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.
Original document storage.
Public Class Methods
Source
# File lib/aspose_words_cloud/models/requests/convert_document_request.rb, line 75 def initialize(document:, format:, out_path: nil, file_name_field_value: nil, storage: nil, load_encoding: nil, password: nil, encrypted_password: nil, open_type_support: nil, fonts_location: nil) self.document = document self.format = format self.out_path = out_path self.file_name_field_value = file_name_field_value self.storage = storage self.load_encoding = load_encoding self.password = password self.encrypted_password = encrypted_password self.open_type_support = open_type_support self.fonts_location = fonts_location end
Initializes a new instance. @param document Converting document. @param format The format to convert. @param out_path
The path to the output document on a local storage. @param file_name_field_value
The filename of the output document, that will be used when the resulting document has a dynamic field {filename}. If it is not set, the “sourceFilename” will be used instead. @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 fonts_location
Folder in filestorage with custom fonts.
Public Instance Methods
Source
# File lib/aspose_words_cloud/models/requests/convert_document_request.rb, line 158 def create_http_request(api_client) # verify the required parameter 'document' is set raise ArgumentError, 'Missing the required parameter document when calling WordsApi.convert_document' if api_client.config.client_side_validation && self.document.nil? # verify the required parameter 'format' is set raise ArgumentError, 'Missing the required parameter format when calling WordsApi.convert_document' if api_client.config.client_side_validation && self.format.nil? # resource path local_var_path = '/words/convert'[1..-1] local_var_path = local_var_path.sub('//', '/') # query parameters query_params = {} query_params[downcase_first_letter('Format')] = self.format query_params[downcase_first_letter('OutPath')] = self.out_path unless self.out_path.nil? query_params[downcase_first_letter('FileNameFieldValue')] = self.file_name_field_value unless self.file_name_field_value.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('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 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/convert_document_request.rb, line 209 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/convert_document_request.rb, line 214 def get_response_type 'File' end
Get response type
Source
# File lib/aspose_words_cloud/models/requests/convert_document_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.convert_document' if api_client.config.client_side_validation && self.document.nil? # verify the required parameter 'format' is set raise ArgumentError, 'Missing the required parameter format when calling WordsApi.convert_document' if api_client.config.client_side_validation && self.format.nil? # resource path local_var_path = '/words/convert'[7..-1] local_var_path = local_var_path.sub('//', '/') # query parameters query_params = {} query_params[downcase_first_letter('Format')] = self.format query_params[downcase_first_letter('OutPath')] = self.out_path unless self.out_path.nil? query_params[downcase_first_letter('FileNameFieldValue')] = self.file_name_field_value unless self.file_name_field_value.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('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 # 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