class AsposeWordsCloud::GetDocumentPropertyOnlineRequest
Request model for get_document_property_online operation.
Attributes
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.
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.
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 name of the property.
Public Class Methods
Source
# File lib/aspose_words_cloud/models/requests/get_document_property_online_request.rb, line 59 def initialize(document:, property_name:, load_encoding: nil, password: nil, encrypted_password: nil, open_type_support: nil) self.document = document self.property_name = property_name self.load_encoding = load_encoding self.password = password self.encrypted_password = encrypted_password self.open_type_support = open_type_support end
Initializes a new instance. @param document The document. @param property_name
The name of the property. @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.
Public Instance Methods
Source
# File lib/aspose_words_cloud/models/requests/get_document_property_online_request.rb, line 134 def create_http_request(api_client) # verify the required parameter 'document' is set raise ArgumentError, 'Missing the required parameter document when calling WordsApi.get_document_property_online' if api_client.config.client_side_validation && self.document.nil? # verify the required parameter 'property_name' is set raise ArgumentError, 'Missing the required parameter property_name when calling WordsApi.get_document_property_online' if api_client.config.client_side_validation && self.property_name.nil? # resource path local_var_path = '/words/online/get/documentProperties/{propertyName}'[1..-1] local_var_path = local_var_path.sub('{' + downcase_first_letter('PropertyName') + '}', self.property_name.nil? ? '' : self.property_name.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('OpenTypeSupport')] = self.open_type_support unless self.open_type_support.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/get_document_property_online_request.rb, line 181 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/get_document_property_online_request.rb, line 186 def get_response_type 'DocumentPropertyResponse' end
Get response type
Source
# File lib/aspose_words_cloud/models/requests/get_document_property_online_request.rb, line 69 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.get_document_property_online' if api_client.config.client_side_validation && self.document.nil? # verify the required parameter 'property_name' is set raise ArgumentError, 'Missing the required parameter property_name when calling WordsApi.get_document_property_online' if api_client.config.client_side_validation && self.property_name.nil? # resource path local_var_path = '/words/online/get/documentProperties/{propertyName}'[7..-1] local_var_path = local_var_path.sub('{' + downcase_first_letter('PropertyName') + '}', self.property_name.nil? ? '' : self.property_name.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('OpenTypeSupport')] = self.open_type_support unless self.open_type_support.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