Class: AsposeWordsCloud::GetCommentRequest
- Inherits:
-
Object
- Object
- AsposeWordsCloud::GetCommentRequest
- Defined in:
- lib/aspose_words_cloud/models/requests/get_comment_request.rb
Overview
Request model for get_comment operation.
Instance Attribute Summary collapse
-
#comment_index ⇒ Object
The index of the comment.
-
#encrypted_password ⇒ Object
Password of protected Word document.
-
#folder ⇒ Object
Original document folder.
-
#load_encoding ⇒ Object
Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
-
#name ⇒ Object
The filename of the input document.
-
#password ⇒ Object
Password of protected Word document.
-
#storage ⇒ Object
Original document storage.
Instance Method Summary collapse
- #create_http_request(api_client) ⇒ Object
-
#downcase_first_letter(str) ⇒ Object
Helper method to convert first letter to downcase.
-
#get_response_type ⇒ Object
Get response type.
-
#initialize(name:, comment_index:, folder: nil, storage: nil, load_encoding: nil, password: nil, encrypted_password: nil) ⇒ GetCommentRequest
constructor
Initializes a new instance.
-
#to_batch_part(api_client, requestId, parentRequestId = nil) ⇒ Object
Creating batch part from request.
Constructor Details
#initialize(name:, comment_index:, folder: nil, storage: nil, load_encoding: nil, password: nil, encrypted_password: nil) ⇒ GetCommentRequest
Initializes a new instance.
63 64 65 66 67 68 69 70 71 |
# File 'lib/aspose_words_cloud/models/requests/get_comment_request.rb', line 63 def initialize(name:, comment_index:, folder: nil, storage: nil, load_encoding: nil, password: nil, encrypted_password: nil) self.name = name self.comment_index = comment_index self.folder = folder self.storage = storage self.load_encoding = load_encoding self.password = password self.encrypted_password = encrypted_password end |
Instance Attribute Details
#comment_index ⇒ Object
The index of the comment.
36 37 38 |
# File 'lib/aspose_words_cloud/models/requests/get_comment_request.rb', line 36 def comment_index @comment_index end |
#encrypted_password ⇒ Object
Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
51 52 53 |
# File 'lib/aspose_words_cloud/models/requests/get_comment_request.rb', line 51 def encrypted_password @encrypted_password end |
#folder ⇒ Object
Original document folder.
39 40 41 |
# File 'lib/aspose_words_cloud/models/requests/get_comment_request.rb', line 39 def folder @folder end |
#load_encoding ⇒ Object
Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
45 46 47 |
# File 'lib/aspose_words_cloud/models/requests/get_comment_request.rb', line 45 def load_encoding @load_encoding end |
#name ⇒ Object
The filename of the input document.
33 34 35 |
# File 'lib/aspose_words_cloud/models/requests/get_comment_request.rb', line 33 def name @name end |
#password ⇒ Object
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.
48 49 50 |
# File 'lib/aspose_words_cloud/models/requests/get_comment_request.rb', line 48 def password @password end |
#storage ⇒ Object
Original document storage.
42 43 44 |
# File 'lib/aspose_words_cloud/models/requests/get_comment_request.rb', line 42 def storage @storage end |
Instance Method Details
#create_http_request(api_client) ⇒ Object
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/aspose_words_cloud/models/requests/get_comment_request.rb', line 131 def create_http_request(api_client) # verify the required parameter 'name' is set raise ArgumentError, 'Missing the required parameter name when calling WordsApi.get_comment' if api_client.config.client_side_validation && self.name.nil? # verify the required parameter 'comment_index' is set raise ArgumentError, 'Missing the required parameter comment_index when calling WordsApi.get_comment' if api_client.config.client_side_validation && self.comment_index.nil? # resource path local_var_path = '/words/{name}/comments/{commentIndex}'[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('{' + downcase_first_letter('CommentIndex') + '}', self.comment_index.nil? ? '' : self.comment_index.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? # 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 |
#downcase_first_letter(str) ⇒ Object
Helper method to convert first letter to downcase
173 174 175 |
# File 'lib/aspose_words_cloud/models/requests/get_comment_request.rb', line 173 def downcase_first_letter(str) str[0].downcase + str[1..-1] end |
#get_response_type ⇒ Object
Get response type
178 179 180 |
# File 'lib/aspose_words_cloud/models/requests/get_comment_request.rb', line 178 def get_response_type 'CommentResponse' end |
#to_batch_part(api_client, requestId, parentRequestId = nil) ⇒ Object
Creating batch part from request
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 |
# File 'lib/aspose_words_cloud/models/requests/get_comment_request.rb', line 74 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_comment' if api_client.config.client_side_validation && self.name.nil? # verify the required parameter 'comment_index' is set raise ArgumentError, 'Missing the required parameter comment_index when calling WordsApi.get_comment' if api_client.config.client_side_validation && self.comment_index.nil? # resource path local_var_path = '/words/{name}/comments/{commentIndex}'[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('{' + downcase_first_letter('CommentIndex') + '}', self.comment_index.nil? ? '' : self.comment_index.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? 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 |