Class: GroupDocsViewerCloud::MailStorageOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_viewer_cloud/models/mail_storage_options.rb

Overview

Provides options for rendering Mail storage (Lotus Notes, MBox) data files.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MailStorageOptions

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/groupdocs_viewer_cloud/models/mail_storage_options.rb', line 63

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.key?(:'TextFilter')
    self.text_filter = attributes[:'TextFilter']
  end

  if attributes.key?(:'AddressFilter')
    self.address_filter = attributes[:'AddressFilter']
  end

  if attributes.key?(:'MaxItems')
    self.max_items = attributes[:'MaxItems']
  end

end

Instance Attribute Details

#address_filter ⇒ Object

The email-address used to filter messages by sender or recipient.



38
39
40
 
# File 'lib/groupdocs_viewer_cloud/models/mail_storage_options.rb', line 38

def address_filter
  @address_filter
end

#max_items ⇒ Object

The maximum number of messages or items for render. Default value is 0 - all messages will be rendered



41
42
43
 
# File 'lib/groupdocs_viewer_cloud/models/mail_storage_options.rb', line 41

def max_items
  @max_items
end

#text_filter ⇒ Object

The keywords used to filter messages.



35
36
37
 
# File 'lib/groupdocs_viewer_cloud/models/mail_storage_options.rb', line 35

def text_filter
  @text_filter
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
 
# File 'lib/groupdocs_viewer_cloud/models/mail_storage_options.rb', line 44

def self.attribute_map
  {
    :'text_filter' => :'TextFilter',
    :'address_filter' => :'AddressFilter',
    :'max_items' => :'MaxItems'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
 
# File 'lib/groupdocs_viewer_cloud/models/mail_storage_options.rb', line 53

def self.swagger_types
  {
    :'text_filter' => :'String',
    :'address_filter' => :'String',
    :'max_items' => :'Integer'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



103
104
105
106
107
108
109
 
# File 'lib/groupdocs_viewer_cloud/models/mail_storage_options.rb', line 103

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      text_filter == other.text_filter &&
      address_filter == other.address_filter &&
      max_items == other.max_items
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



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/groupdocs_viewer_cloud/models/mail_storage_options.rb', line 156

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Date.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
    temp_model = GroupDocsViewerCloud.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



223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/groupdocs_viewer_cloud/models/mail_storage_options.rb', line 223

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



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/groupdocs_viewer_cloud/models/mail_storage_options.rb', line 132

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    pname = uncap(self.class.attribute_map[key]).intern
    value = attributes[pname]
    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 value.is_a?(Array)
        self.send("#{key}=", value.map { |v| _deserialize($1, v) })
      end
    elsif !value.nil?
      self.send("#{key}=", _deserialize(type, value))
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


113
114
115
 
# File 'lib/groupdocs_viewer_cloud/models/mail_storage_options.rb', line 113

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



119
120
121
 
# File 'lib/groupdocs_viewer_cloud/models/mail_storage_options.rb', line 119

def hash
  [text_filter, address_filter, max_items].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



85
86
87
88
89
90
91
92
 
# File 'lib/groupdocs_viewer_cloud/models/mail_storage_options.rb', line 85

def list_invalid_properties
  invalid_properties = []
  if @max_items.nil?
    invalid_properties.push("invalid value for 'max_items', max_items cannot be nil.")
  end

  return 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



203
204
205
 
# File 'lib/groupdocs_viewer_cloud/models/mail_storage_options.rb', line 203

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



209
210
211
212
213
214
215
216
217
 
# File 'lib/groupdocs_viewer_cloud/models/mail_storage_options.rb', line 209

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



197
198
199
 
# File 'lib/groupdocs_viewer_cloud/models/mail_storage_options.rb', line 197

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



125
126
127
 
# File 'lib/groupdocs_viewer_cloud/models/mail_storage_options.rb', line 125

def uncap(str)
  str[0, 1].downcase + str[1..-1]
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



96
97
98
99
 
# File 'lib/groupdocs_viewer_cloud/models/mail_storage_options.rb', line 96

def valid?
  return false if @max_items.nil?
  return true
end