Class: AsposeEmailCloud::AttachmentBase

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose-email-cloud/models/attachment_base.rb

Overview

AttachmentBase class

Direct Known Subclasses

AlternateView, Attachment, LinkedResource

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base64_data: nil, content_id: nil, content_type: nil, headers: nil) ⇒ AttachmentBase

Initializes the object

Parameters:

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

    Attachment file content as Base64 string.

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

    Attachment content id

  • content_type (ContentType) (defaults to: nil) —

    Content type

  • headers (Hash<String, String>) (defaults to: nil) —

    Attachment headers.



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

def initialize(
  base64_data: nil,
  content_id: nil,
  content_type: nil,
  headers: nil)
  self.base64_data = base64_data if base64_data
  self.content_id = content_id if content_id
  self.content_type = content_type if content_type
  self.headers = headers if headers
end

Instance Attribute Details

#base64_data ⇒ String

Attachment file content as Base64 string.

Returns:

  • (String) 


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

def base64_data
  @base64_data
end

#content_id ⇒ String

Attachment content id

Returns:

  • (String) 


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

def content_id
  @content_id
end

#content_type ⇒ ContentType

Content type

Returns:



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

def content_type
  @content_type
end

#headers ⇒ Hash<String, String>

Attachment headers.

Returns:

  • (Hash<String, String>) 


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

def headers
  @headers
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/attachment_base.rb', line 44

def self.attribute_map
  {
    :'base64_data' => :'base64Data',
    :'content_id' => :'contentId',
    :'content_type' => :'contentType',
    :'headers' => :'headers'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'base64_data' => :'String',
    :'content_id' => :'String',
    :'content_type' => :'ContentType',
    :'headers' => :'Hash<String, String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



94
95
96
97
98
99
100
101
 
# File 'lib/aspose-email-cloud/models/attachment_base.rb', line 94

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      base64_data == o.base64_data &&
      content_id == o.content_id &&
      content_type == o.content_type &&
      headers == o.headers
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



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
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/aspose-email-cloud/models/attachment_base.rb', line 141

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



211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/aspose-email-cloud/models/attachment_base.rb', line 211

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



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/aspose-email-cloud/models/attachment_base.rb', line 118

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


105
106
107
 
# File 'lib/aspose-email-cloud/models/attachment_base.rb', line 105

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



111
112
113
 
# File 'lib/aspose-email-cloud/models/attachment_base.rb', line 111

def hash
  [base64_data, content_id, content_type, headers].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
 
# File 'lib/aspose-email-cloud/models/attachment_base.rb', line 81

def list_invalid_properties
  invalid_properties = Array.new
  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



191
192
193
 
# File 'lib/aspose-email-cloud/models/attachment_base.rb', line 191

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



197
198
199
200
201
202
203
204
205
 
# File 'lib/aspose-email-cloud/models/attachment_base.rb', line 197

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



185
186
187
 
# File 'lib/aspose-email-cloud/models/attachment_base.rb', line 185

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



88
89
90
 
# File 'lib/aspose-email-cloud/models/attachment_base.rb', line 88

def valid?
  true
end