Class: GroupDocsViewerCloud::OutlookOptions

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

Overview

Provides options for rendering Outlook data files

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OutlookOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/groupdocs_viewer_cloud/models/outlook_options.rb', line 68

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?(:'Folder')
    self.folder = attributes[:'Folder']
  end

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

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

  if attributes.key?(:'MaxItemsInFolder')
    self.max_items_in_folder = attributes[:'MaxItemsInFolder']
  end

end

Instance Attribute Details

#address_filter ⇒ Object

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



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

def address_filter
  @address_filter
end

#folder ⇒ Object

The name of the folder (e.g. Inbox, Sent Item or Deleted Items) to render



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

def folder
  @folder
end

#max_items_in_folder ⇒ Object

The maximum number of messages or items, that can be rendered from one folder



44
45
46
 
# File 'lib/groupdocs_viewer_cloud/models/outlook_options.rb', line 44

def max_items_in_folder
  @max_items_in_folder
end

#text_filter ⇒ Object

The keywords used to filter messages



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

def text_filter
  @text_filter
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
 
# File 'lib/groupdocs_viewer_cloud/models/outlook_options.rb', line 47

def self.attribute_map
  {
    :'folder' => :'Folder',
    :'text_filter' => :'TextFilter',
    :'address_filter' => :'AddressFilter',
    :'max_items_in_folder' => :'MaxItemsInFolder'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
 
# File 'lib/groupdocs_viewer_cloud/models/outlook_options.rb', line 57

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

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



112
113
114
115
116
117
118
119
 
# File 'lib/groupdocs_viewer_cloud/models/outlook_options.rb', line 112

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



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
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/groupdocs_viewer_cloud/models/outlook_options.rb', line 166

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



233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/groupdocs_viewer_cloud/models/outlook_options.rb', line 233

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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/groupdocs_viewer_cloud/models/outlook_options.rb', line 142

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


123
124
125
 
# File 'lib/groupdocs_viewer_cloud/models/outlook_options.rb', line 123

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



129
130
131
 
# File 'lib/groupdocs_viewer_cloud/models/outlook_options.rb', line 129

def hash
  [folder, text_filter, address_filter, max_items_in_folder].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



94
95
96
97
98
99
100
101
 
# File 'lib/groupdocs_viewer_cloud/models/outlook_options.rb', line 94

def list_invalid_properties
  invalid_properties = []
  if @max_items_in_folder.nil?
    invalid_properties.push("invalid value for 'max_items_in_folder', max_items_in_folder 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



213
214
215
 
# File 'lib/groupdocs_viewer_cloud/models/outlook_options.rb', line 213

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



219
220
221
222
223
224
225
226
227
 
# File 'lib/groupdocs_viewer_cloud/models/outlook_options.rb', line 219

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



207
208
209
 
# File 'lib/groupdocs_viewer_cloud/models/outlook_options.rb', line 207

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



135
136
137
 
# File 'lib/groupdocs_viewer_cloud/models/outlook_options.rb', line 135

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



105
106
107
108
 
# File 'lib/groupdocs_viewer_cloud/models/outlook_options.rb', line 105

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