Class: AsposeWordsCloud::HeaderFooterLink

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_words_cloud/models/header_footer_link.rb

Overview

HeaderFooter link element.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HeaderFooterLink

Initializes the object

Parameters:

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

    Model attributes in the form of hash



78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/aspose_words_cloud/models/header_footer_link.rb', line 78

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

  if attributes.key?(:'Type')
    self.type = attributes[:'Type']
  end
end

Instance Attribute Details

Gets or sets the link to the document.



33
34
35
 
# File 'lib/aspose_words_cloud/models/header_footer_link.rb', line 33

def link
  @link
end

#type ⇒ Object

Gets or sets the paragraph’s text.



36
37
38
 
# File 'lib/aspose_words_cloud/models/header_footer_link.rb', line 36

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



61
62
63
64
65
66
 
# File 'lib/aspose_words_cloud/models/header_footer_link.rb', line 61

def self.attribute_map
  {
    :'link' => :'Link',
    :'type' => :'Type'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
 
# File 'lib/aspose_words_cloud/models/header_footer_link.rb', line 69

def self.swagger_types
  {
    :'link' => :'WordsApiLink',
    :'type' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



119
120
121
122
123
124
 
# File 'lib/aspose_words_cloud/models/header_footer_link.rb', line 119

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



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

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Time.at(/\d/.match(value)[0].to_f).to_datetime
  when :Date
    Time.at(/\d/.match(value)[0].to_f).to_date
  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
    if value[:'$type']
        type = value[:'$type'][0..-4]
    end

    temp_model = AsposeWordsCloud.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



234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/aspose_words_cloud/models/header_footer_link.rb', line 234

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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/aspose_words_cloud/models/header_footer_link.rb', line 141

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

  self
end

#collectFilesContent(resultFilesContent) ⇒ Object 



248
249
 
# File 'lib/aspose_words_cloud/models/header_footer_link.rb', line 248

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


128
129
130
 
# File 'lib/aspose_words_cloud/models/header_footer_link.rb', line 128

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



134
135
136
 
# File 'lib/aspose_words_cloud/models/header_footer_link.rb', line 134

def hash
  [link, type].hash
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



214
215
216
 
# File 'lib/aspose_words_cloud/models/header_footer_link.rb', line 214

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



220
221
222
223
224
225
226
227
228
 
# File 'lib/aspose_words_cloud/models/header_footer_link.rb', line 220

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



208
209
210
 
# File 'lib/aspose_words_cloud/models/header_footer_link.rb', line 208

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



95
96
97
98
99
100
 
# File 'lib/aspose_words_cloud/models/header_footer_link.rb', line 95

def valid?
  type_validator = EnumAttributeValidator.new('String', ["HeaderEven", "HeaderPrimary", "FooterEven", "FooterPrimary", "HeaderFirst", "FooterFirst"])
  return false unless type_validator.valid?(@type)

  return true
end

#validate ⇒ Object

Raises:

  • (ArgumentError) 


251
252
253
254
255
256
257
 
# File 'lib/aspose_words_cloud/models/header_footer_link.rb', line 251

def validate()
  raise ArgumentError, 'Property type in HeaderFooterLink is required.' if self.type.nil?
  unless self.link.nil?
      self.link.validate
  end

end