Class: AsposeEmailCloud::ClientThreadSetIsReadRequest

Inherits:
ClientThreadBaseRequest show all
Defined in:
lib/aspose-email-cloud/models/client_thread_set_is_read_request.rb

Overview

Mark thread messages as read or unread request.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(account_location: nil, thread_id: nil, is_read: nil, folder: nil) ⇒ ClientThreadSetIsReadRequest

Initializes the object

Parameters:

  • account_location (StorageFileLocation) (defaults to: nil) —

    Email client account configuration location on storage.

  • thread_id (String) (defaults to: nil) —

    Thread identifier.

  • is_read (BOOLEAN) (defaults to: nil) —

    Message is read flag.

  • folder (String) (defaults to: nil) —

    Folder on email server, where thread is stored.



68
69
70
71
72
73
74
75
76
77
 
# File 'lib/aspose-email-cloud/models/client_thread_set_is_read_request.rb', line 68

def initialize(
  account_location: nil,
  thread_id: nil,
  is_read: nil,
  folder: nil)
  self. =  if 
  self.thread_id = thread_id if thread_id
  self.is_read = is_read if is_read
  self.folder = folder if folder
end

Instance Attribute Details

#account_location ⇒ StorageFileLocation

Email client account configuration location on storage.

Returns:



33
34
35
 
# File 'lib/aspose-email-cloud/models/client_thread_set_is_read_request.rb', line 33

def 
  @account_location
end

#folder ⇒ String

Folder on email server, where thread is stored.

Returns:

  • (String) 


42
43
44
 
# File 'lib/aspose-email-cloud/models/client_thread_set_is_read_request.rb', line 42

def folder
  @folder
end

#is_read ⇒ BOOLEAN

Message is read flag.

Returns:

  • (BOOLEAN) 


39
40
41
 
# File 'lib/aspose-email-cloud/models/client_thread_set_is_read_request.rb', line 39

def is_read
  @is_read
end

#thread_id ⇒ String

Thread identifier.

Returns:

  • (String) 


36
37
38
 
# File 'lib/aspose-email-cloud/models/client_thread_set_is_read_request.rb', line 36

def thread_id
  @thread_id
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



44
45
46
47
48
49
50
51
 
# File 'lib/aspose-email-cloud/models/client_thread_set_is_read_request.rb', line 44

def self.attribute_map
  {
    :'account_location' => :'accountLocation',
    :'thread_id' => :'threadId',
    :'is_read' => :'isRead',
    :'folder' => :'folder'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
 
# File 'lib/aspose-email-cloud/models/client_thread_set_is_read_request.rb', line 54

def self.swagger_types
  {
    :'account_location' => :'StorageFileLocation',
    :'thread_id' => :'String',
    :'is_read' => :'BOOLEAN',
    :'folder' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



128
129
130
131
132
133
134
135
 
# File 'lib/aspose-email-cloud/models/client_thread_set_is_read_request.rb', line 128

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      thread_id == o.thread_id &&
      is_read == o.is_read &&
      folder == o.folder
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/aspose-email-cloud/models/client_thread_set_is_read_request.rb', line 175

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    sub_type = value[:type] || value[:discriminator] || type
    if AsposeEmailCloud.const_defined?(sub_type)
      type = sub_type
    end
    temp_model = AsposeEmailCloud.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/aspose-email-cloud/models/client_thread_set_is_read_request.rb', line 245

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/aspose-email-cloud/models/client_thread_set_is_read_request.rb', line 152

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    attribute_key = self.class.attribute_map[key]
    attribute_key = (attribute_key[0, 1].downcase + attribute_key[1..-1]).to_sym
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[attribute_key].is_a?(Array)
        self.send("#{key}=", attributes[attribute_key].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_key].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_key]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


139
140
141
 
# File 'lib/aspose-email-cloud/models/client_thread_set_is_read_request.rb', line 139

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



145
146
147
 
# File 'lib/aspose-email-cloud/models/client_thread_set_is_read_request.rb', line 145

def hash
  [, thread_id, is_read, folder].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/aspose-email-cloud/models/client_thread_set_is_read_request.rb', line 81

def list_invalid_properties
  invalid_properties = Array.new
  if @account_location.nil?
    invalid_properties.push('invalid value for "account_location", account_location cannot be nil.')
  end

  if @thread_id.nil?
    invalid_properties.push('invalid value for "thread_id", thread_id cannot be nil.')
  end

  if @thread_id.to_s.length < 1
    invalid_properties.push('invalid value for "thread_id", the character length must be great than or equal to 1.')
  end

  if @is_read.nil?
    invalid_properties.push('invalid value for "is_read", is_read cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



225
226
227
 
# File 'lib/aspose-email-cloud/models/client_thread_set_is_read_request.rb', line 225

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



231
232
233
234
235
236
237
238
239
 
# File 'lib/aspose-email-cloud/models/client_thread_set_is_read_request.rb', line 231

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



219
220
221
 
# File 'lib/aspose-email-cloud/models/client_thread_set_is_read_request.rb', line 219

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



104
105
106
107
108
109
110
 
# File 'lib/aspose-email-cloud/models/client_thread_set_is_read_request.rb', line 104

def valid?
  return false if @account_location.nil?
  return false if @thread_id.nil?
  return false if @thread_id.to_s.length < 1
  return false if @is_read.nil?
  true
end