Class: GroupDocsConversionCloud::PpsmLoadOptions
- Inherits:
-
Object
- Object
- GroupDocsConversionCloud::PpsmLoadOptions
- Defined in:
- lib/groupdocs_conversion_cloud/models/ppsm_load_options.rb
Overview
Ppsm load options
Instance Attribute Summary collapse
-
#default_font ⇒ Object
Default font for rendering the presentation.
-
#font_substitutes ⇒ Object
Substitute specific fonts when converting Slides document.
-
#format ⇒ Object
The format of input file, ("docx", for example).
-
#hide_comments ⇒ Object
Hide comments.
-
#password ⇒ Object
Set password to unprotect protected document.
-
#show_hidden_slides ⇒ Object
Show hidden slides.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ PpsmLoadOptions
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#uncap(str) ⇒ Object
Downcases first letter.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ PpsmLoadOptions
Initializes the object
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
# File 'lib/groupdocs_conversion_cloud/models/ppsm_load_options.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?(:'Format') self.format = attributes[:'Format'] end if attributes.key?(:'DefaultFont') self.default_font = attributes[:'DefaultFont'] end if attributes.key?(:'FontSubstitutes') if (value = attributes[:'FontSubstitutes']).is_a?(Hash) self.font_substitutes = value end end if attributes.key?(:'Password') self.password = attributes[:'Password'] end if attributes.key?(:'HideComments') self.hide_comments = attributes[:'HideComments'] end if attributes.key?(:'ShowHiddenSlides') self. = attributes[:'ShowHiddenSlides'] end end |
Instance Attribute Details
#default_font ⇒ Object
Default font for rendering the presentation. The following font will be used if a presentation font is missing.
38 39 40 |
# File 'lib/groupdocs_conversion_cloud/models/ppsm_load_options.rb', line 38 def default_font @default_font end |
#font_substitutes ⇒ Object
Substitute specific fonts when converting Slides document.
41 42 43 |
# File 'lib/groupdocs_conversion_cloud/models/ppsm_load_options.rb', line 41 def font_substitutes @font_substitutes end |
#format ⇒ Object
The format of input file, ("docx", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions. In regular conversion, the input file format taken from the input file name and this field ignored.
35 36 37 |
# File 'lib/groupdocs_conversion_cloud/models/ppsm_load_options.rb', line 35 def format @format end |
#hide_comments ⇒ Object
Hide comments
47 48 49 |
# File 'lib/groupdocs_conversion_cloud/models/ppsm_load_options.rb', line 47 def hide_comments @hide_comments end |
#password ⇒ Object
Set password to unprotect protected document
44 45 46 |
# File 'lib/groupdocs_conversion_cloud/models/ppsm_load_options.rb', line 44 def password @password end |
#show_hidden_slides ⇒ Object
Show hidden slides
50 51 52 |
# File 'lib/groupdocs_conversion_cloud/models/ppsm_load_options.rb', line 50 def @show_hidden_slides end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
53 54 55 56 57 58 59 60 61 62 |
# File 'lib/groupdocs_conversion_cloud/models/ppsm_load_options.rb', line 53 def self.attribute_map { :'format' => :'Format', :'default_font' => :'DefaultFont', :'font_substitutes' => :'FontSubstitutes', :'password' => :'Password', :'hide_comments' => :'HideComments', :'show_hidden_slides' => :'ShowHiddenSlides' } end |
.swagger_types ⇒ Object
Attribute type mapping.
65 66 67 68 69 70 71 72 73 74 |
# File 'lib/groupdocs_conversion_cloud/models/ppsm_load_options.rb', line 65 def self.swagger_types { :'format' => :'String', :'default_font' => :'String', :'font_substitutes' => :'Hash<String, String>', :'password' => :'String', :'hide_comments' => :'BOOLEAN', :'show_hidden_slides' => :'BOOLEAN' } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
137 138 139 140 141 142 143 144 145 146 |
# File 'lib/groupdocs_conversion_cloud/models/ppsm_load_options.rb', line 137 def ==(other) return true if self.equal?(other) self.class == other.class && format == other.format && default_font == other.default_font && font_substitutes == other.font_substitutes && password == other.password && hide_comments == other.hide_comments && == other. end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
193 194 195 196 197 198 199 200 201 202 203 204 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 |
# File 'lib/groupdocs_conversion_cloud/models/ppsm_load_options.rb', line 193 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 = GroupDocsConversionCloud.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
260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'lib/groupdocs_conversion_cloud/models/ppsm_load_options.rb', line 260 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
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 |
# File 'lib/groupdocs_conversion_cloud/models/ppsm_load_options.rb', line 169 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
150 151 152 |
# File 'lib/groupdocs_conversion_cloud/models/ppsm_load_options.rb', line 150 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
156 157 158 |
# File 'lib/groupdocs_conversion_cloud/models/ppsm_load_options.rb', line 156 def hash [format, default_font, font_substitutes, password, hide_comments, ].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
114 115 116 117 118 119 120 121 122 123 124 125 |
# File 'lib/groupdocs_conversion_cloud/models/ppsm_load_options.rb', line 114 def list_invalid_properties invalid_properties = [] if @hide_comments.nil? invalid_properties.push("invalid value for 'hide_comments', hide_comments cannot be nil.") end if @show_hidden_slides.nil? invalid_properties.push("invalid value for 'show_hidden_slides', show_hidden_slides cannot be nil.") end return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
240 241 242 |
# File 'lib/groupdocs_conversion_cloud/models/ppsm_load_options.rb', line 240 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
246 247 248 249 250 251 252 253 254 |
# File 'lib/groupdocs_conversion_cloud/models/ppsm_load_options.rb', line 246 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
234 235 236 |
# File 'lib/groupdocs_conversion_cloud/models/ppsm_load_options.rb', line 234 def to_s to_hash.to_s end |
#uncap(str) ⇒ Object
Downcases first letter.
162 163 164 |
# File 'lib/groupdocs_conversion_cloud/models/ppsm_load_options.rb', line 162 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
129 130 131 132 133 |
# File 'lib/groupdocs_conversion_cloud/models/ppsm_load_options.rb', line 129 def valid? return false if @hide_comments.nil? return false if @show_hidden_slides.nil? return true end |