Class: GroupDocsViewerCloud::PdfViewInfo

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

Overview

Represents view information for PDF document

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PdfViewInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_view_info.rb', line 53

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

end

Instance Attribute Details

#printing_allowed ⇒ Object

Indicates if printing of the document is allowed



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

def printing_allowed
  @printing_allowed
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_view_info.rb', line 38

def self.attribute_map
  {
    :'printing_allowed' => :'PrintingAllowed'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_view_info.rb', line 45

def self.swagger_types
  {
    :'printing_allowed' => :'BOOLEAN'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



85
86
87
88
89
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_view_info.rb', line 85

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



136
137
138
139
140
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
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_view_info.rb', line 136

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



203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_view_info.rb', line 203

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



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_view_info.rb', line 112

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


93
94
95
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_view_info.rb', line 93

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



99
100
101
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_view_info.rb', line 99

def hash
  [printing_allowed].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



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

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



183
184
185
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_view_info.rb', line 183

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



189
190
191
192
193
194
195
196
197
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_view_info.rb', line 189

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



177
178
179
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_view_info.rb', line 177

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



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

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



78
79
80
81
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_view_info.rb', line 78

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