class AsposeWordsCloud::GetDocumentStatisticsRequest
Request model for get_document_statistics operation.
Attributes
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 flag indicating whether to include comments from the WordCount. The default value is “false”.
The flag indicating whether to include footnotes from the WordCount. The default value is “false”.
The flag indicating whether to include shape’s text from the WordCount. The default value is “false”.
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.
Original document storage.
Public Class Methods
Source
# File lib/aspose_words_cloud/models/requests/get_document_statistics_request.rb, line 75 def initialize(name:, folder: nil, storage: nil, load_encoding: nil, password: nil, encrypted_password: nil, open_type_support: nil, include_comments: nil, include_footnotes: nil, include_text_in_shapes: nil) self.name = name 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.include_comments = include_comments self.include_footnotes = include_footnotes self.include_text_in_shapes = include_text_in_shapes end
Initializes a new instance. @param name The filename of the input document. @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 include_comments
The flag indicating whether to include comments from the WordCount. The default value is “false”. @param include_footnotes
The flag indicating whether to include footnotes from the WordCount. The default value is “false”. @param include_text_in_shapes
The flag indicating whether to include shape’s text from the WordCount. The default value is “false”.
Public Instance Methods
Source
# File lib/aspose_words_cloud/models/requests/get_document_statistics_request.rb, line 147 def create_http_request(api_client) # verify the required parameter 'name' is set raise ArgumentError, 'Missing the required parameter name when calling WordsApi.get_document_statistics' if api_client.config.client_side_validation && self.name.nil? # resource path local_var_path = '/words/{name}/statistics'[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('IncludeComments')] = self.include_comments unless self.include_comments.nil? query_params[downcase_first_letter('IncludeFootnotes')] = self.include_footnotes unless self.include_footnotes.nil? query_params[downcase_first_letter('IncludeTextInShapes')] = self.include_text_in_shapes unless self.include_text_in_shapes.nil? # header parameters header_params = {} # HTTP header 'Content-Type' header_params['Content-Type'] = api_client.select_header_content_type(['application/xml', 'application/json']) # form parameters form_params = [] files_content = [] body = api_client.build_request_body(header_params, form_params, files_content) { 'method': :GET, '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_statistics_request.rb, line 190 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_statistics_request.rb, line 195 def get_response_type 'StatDataResponse' end
Get response type
Source
# File lib/aspose_words_cloud/models/requests/get_document_statistics_request.rb, line 89 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.get_document_statistics' if api_client.config.client_side_validation && self.name.nil? # resource path local_var_path = '/words/{name}/statistics'[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('IncludeComments')] = self.include_comments unless self.include_comments.nil? query_params[downcase_first_letter('IncludeFootnotes')] = self.include_footnotes unless self.include_footnotes.nil? query_params[downcase_first_letter('IncludeTextInShapes')] = self.include_text_in_shapes unless self.include_text_in_shapes.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_params['RequestId'] = requestId if parentRequestId != nil header_params['DependsOn'] = parentRequestId end # form parameters form_params = [] files_content = [] # http body (model) body = api_client.build_request_body_batch(header_params, form_params, files_content) part = "" part.concat("GET".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