Class: GroupDocsViewerCloud::EmailOptions

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

Overview

Rendering options for Email file formats. Email file formats include files with extensions: .msg, .eml, .emlx, .ifc, .stl

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/groupdocs_viewer_cloud/models/email_options.rb', line 89

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

  if attributes.key?(:'FieldLabels')
    if (value = attributes[:'FieldLabels']).is_a?(Array)
      self.field_labels = value
    end
  end

  if attributes.key?(:'DateTimeFormat')
    self.date_time_format = attributes[:'DateTimeFormat']
  end

  if attributes.key?(:'TimeZoneOffset')
    self.time_zone_offset = attributes[:'TimeZoneOffset']
  end

end

Instance Attribute Details

#date_time_format ⇒ Object

Time Format (can be include TimeZone) for example: ‘MM d yyyy HH:mm tt’, if not set - current system format is used



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

def date_time_format
  @date_time_format
end

#field_labels ⇒ Object

The list of supported email message field labels: 1. Field: "Anniversary" - default label is "Anniversary". 2. Field: "Attachments" - default label is "Attachments". 3. Field: "Bcc" - default label is "Bcc". 4. Field: "Birthday" - default label is "Birthday". 5. Field: "Business" - default label is "Business". 6. Field: "BusinessAddress" - default label is "Business Address". 7. Field: "BusinessFax" - default label is "Business Fax". 8. Field: "BusinessHomepage" - default label is "BusinessHomePage". 9. Field: "Cc" - default label is "Cc". 10. Field: "Company" - default label is "Company". 11. Field: "Department" - default label is "Department". 12. Field: "Email" - default label is "Email". 13. Field: "EmailDisplayAs" - default label is "Email Display As". 14. Field: "Email2" - default label is "Email2". 15. Field: "Email2DisplayAs" - default label is "Email2 Display As". 16. Field: "Email3" - default label is "Email3". 17. Field: "Email3DisplayAs" - default label is "Email3 Display As". 18. Field: "End" - default label is "End". 19. Field: "FirstName" - default label is "First Name". 20. Field: "From" - default label is "From". 21. Field: "FullName" - default label is "Full Name". 22. Field: "Gender" - default label is "Gender". 23. Field: "Hobbies" - default label is "Hobbies". 24. Field: "Home" - default label is "Home". 25. Field: "HomeAddress" - default label is "Home Address". 26. Field: "Importance" - default label is "Importance". 27. Field: "JobTitle" - default label is "Job Title". 28. Field: "LastName" - default label is "Last Name". 29. Field: "Location" - default label is "Location". 30. Field: "MiddleName" - default label is "Middle Name". 31. Field: "Mobile" - default label is "Mobile". 32. Field: "Organizer" - default label is "Organizer". 33. Field: "OtherAddress" - default label is "Other Address". 34. Field: "PersonalHomepage" - default label is "PersonalHomePage". 35. Field: "Profession" - default label is "Profession". 36. Field: "Recurrence" - default label is "Recurrence". 37. Field: "RecurrencePattern" - default label is "Recurrence Pattern". 38. Field: "RequiredAttendees" - default label is "Required Attendees". 39. Field: "Sent" - default label is "Sent". 40. Field: "ShowTimeAs" - default label is "Show Time As". 41. Field: "SpousePartner" - default label is "Spouse/Partner". 42. Field: "Start" - default label is "Start". 43. Field: "Subject" - default label is "Subject". 44. Field: "To" - default label is "To". 45. Field: "UserField1" - default label is "User Field 1". 46. Field: "UserField2" - default label is "User Field 2". 47. Field: "UserField3" - default label is "User Field 3". 48. Field: "UserField4" - default label is "User Field 4".



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

def field_labels
  @field_labels
end

#page_size ⇒ Object

The size of the output page when rendering as PDF or image.



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

def page_size
  @page_size
end

#time_zone_offset ⇒ Object

Message time zone offset. Format should be compatible with .net TimeSpan



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

def time_zone_offset
  @time_zone_offset
end

Class Method Details

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
 
# File 'lib/groupdocs_viewer_cloud/models/email_options.rb', line 68

def self.attribute_map
  {
    :'page_size' => :'PageSize',
    :'field_labels' => :'FieldLabels',
    :'date_time_format' => :'DateTimeFormat',
    :'time_zone_offset' => :'TimeZoneOffset'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
 
# File 'lib/groupdocs_viewer_cloud/models/email_options.rb', line 78

def self.swagger_types
  {
    :'page_size' => :'String',
    :'field_labels' => :'Array<FieldLabel>',
    :'date_time_format' => :'String',
    :'time_zone_offset' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



151
152
153
154
155
156
157
158
 
# File 'lib/groupdocs_viewer_cloud/models/email_options.rb', line 151

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      page_size == other.page_size &&
      field_labels == other.field_labels &&
      date_time_format == other.date_time_format &&
      time_zone_offset == other.time_zone_offset
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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/groupdocs_viewer_cloud/models/email_options.rb', line 205

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



272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/groupdocs_viewer_cloud/models/email_options.rb', line 272

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



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/groupdocs_viewer_cloud/models/email_options.rb', line 181

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


162
163
164
 
# File 'lib/groupdocs_viewer_cloud/models/email_options.rb', line 162

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



168
169
170
 
# File 'lib/groupdocs_viewer_cloud/models/email_options.rb', line 168

def hash
  [page_size, field_labels, date_time_format, time_zone_offset].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



117
118
119
120
121
122
123
124
 
# File 'lib/groupdocs_viewer_cloud/models/email_options.rb', line 117

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



252
253
254
 
# File 'lib/groupdocs_viewer_cloud/models/email_options.rb', line 252

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



258
259
260
261
262
263
264
265
266
 
# File 'lib/groupdocs_viewer_cloud/models/email_options.rb', line 258

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



246
247
248
 
# File 'lib/groupdocs_viewer_cloud/models/email_options.rb', line 246

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



174
175
176
 
# File 'lib/groupdocs_viewer_cloud/models/email_options.rb', line 174

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



128
129
130
131
132
133
 
# File 'lib/groupdocs_viewer_cloud/models/email_options.rb', line 128

def valid?
  return false if @page_size.nil?
  page_size_validator = EnumAttributeValidator.new('String', ["Unspecified", "Letter", "Ledger", "A0", "A1", "A2", "A3", "A4"])
  return false unless page_size_validator.valid?(@page_size)
  return true
end