class DocuSign_eSign::DocumentHtmlDefinition

Holds the properties that define how to generate the responsive-formatted HTML for the document. See [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/) in the [eSignature concepts guide](/docs/esign-rest-api/esign101/concepts/).

Attributes

display_anchor_prefix[RW]
display_anchors[RW]
display_order[RW]
display_page_number[RW]
document_guid[RW]
document_id[RW]

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

header_label[RW]
max_screen_width[RW]
remove_empty_tags[RW]
show_mobile_optimized_toggle[RW]
source[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/docusign_esign/models/document_html_definition.rb, line 51
def self.attribute_map
  {
    :'display_anchor_prefix' => :'displayAnchorPrefix',
    :'display_anchors' => :'displayAnchors',
    :'display_order' => :'displayOrder',
    :'display_page_number' => :'displayPageNumber',
    :'document_guid' => :'documentGuid',
    :'document_id' => :'documentId',
    :'header_label' => :'headerLabel',
    :'max_screen_width' => :'maxScreenWidth',
    :'remove_empty_tags' => :'removeEmptyTags',
    :'show_mobile_optimized_toggle' => :'showMobileOptimizedToggle',
    :'source' => :'source'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/docusign_esign/models/document_html_definition.rb, line 86
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.has_key?(:'displayAnchorPrefix')
    self.display_anchor_prefix = attributes[:'displayAnchorPrefix']
  end

  if attributes.has_key?(:'displayAnchors')
    if (value = attributes[:'displayAnchors']).is_a?(Array)
      self.display_anchors = value
    end
  end

  if attributes.has_key?(:'displayOrder')
    self.display_order = attributes[:'displayOrder']
  end

  if attributes.has_key?(:'displayPageNumber')
    self.display_page_number = attributes[:'displayPageNumber']
  end

  if attributes.has_key?(:'documentGuid')
    self.document_guid = attributes[:'documentGuid']
  end

  if attributes.has_key?(:'documentId')
    self.document_id = attributes[:'documentId']
  end

  if attributes.has_key?(:'headerLabel')
    self.header_label = attributes[:'headerLabel']
  end

  if attributes.has_key?(:'maxScreenWidth')
    self.max_screen_width = attributes[:'maxScreenWidth']
  end

  if attributes.has_key?(:'removeEmptyTags')
    self.remove_empty_tags = attributes[:'removeEmptyTags']
  end

  if attributes.has_key?(:'showMobileOptimizedToggle')
    self.show_mobile_optimized_toggle = attributes[:'showMobileOptimizedToggle']
  end

  if attributes.has_key?(:'source')
    self.source = attributes[:'source']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/docusign_esign/models/document_html_definition.rb, line 68
def self.swagger_types
  {
    :'display_anchor_prefix' => :'String',
    :'display_anchors' => :'Array<DocumentHtmlDisplayAnchor>',
    :'display_order' => :'String',
    :'display_page_number' => :'String',
    :'document_guid' => :'String',
    :'document_id' => :'String',
    :'header_label' => :'String',
    :'max_screen_width' => :'String',
    :'remove_empty_tags' => :'String',
    :'show_mobile_optimized_toggle' => :'String',
    :'source' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/docusign_esign/models/document_html_definition.rb, line 154
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      display_anchor_prefix == o.display_anchor_prefix &&
      display_anchors == o.display_anchors &&
      display_order == o.display_order &&
      display_page_number == o.display_page_number &&
      document_guid == o.document_guid &&
      document_id == o.document_id &&
      header_label == o.header_label &&
      max_screen_width == o.max_screen_width &&
      remove_empty_tags == o.remove_empty_tags &&
      show_mobile_optimized_toggle == o.show_mobile_optimized_toggle &&
      source == o.source
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/docusign_esign/models/document_html_definition.rb, line 206
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
    temp_model = DocuSign_eSign.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/docusign_esign/models/document_html_definition.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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/docusign_esign/models/document_html_definition.rb, line 185
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 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
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/docusign_esign/models/document_html_definition.rb, line 172
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/docusign_esign/models/document_html_definition.rb, line 178
def hash
  [display_anchor_prefix, display_anchors, display_order, display_page_number, document_guid, document_id, header_label, max_screen_width, remove_empty_tags, show_mobile_optimized_toggle, source].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/docusign_esign/models/document_html_definition.rb, line 141
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/docusign_esign/models/document_html_definition.rb, line 252
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/docusign_esign/models/document_html_definition.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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/docusign_esign/models/document_html_definition.rb, line 246
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/docusign_esign/models/document_html_definition.rb, line 148
def valid?
  true
end