Class: RusticiSoftwareCloudV2::LaunchLinkRequestSchema

Inherits:
Object
  • Object
show all
Defined in:
lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LaunchLinkRequestSchema

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb', line 81

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

  if attributes.has_key?(:'redirectOnExitUrl')
    self.redirect_on_exit_url = attributes[:'redirectOnExitUrl']
  end

  if attributes.has_key?(:'tracking')
    self.tracking = attributes[:'tracking']
  else
    self.tracking = true
  end

  if attributes.has_key?(:'startSco')
    self.start_sco = attributes[:'startSco']
  end

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

  if attributes.has_key?(:'cssUrl')
    self.css_url = attributes[:'cssUrl']
  end

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

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

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

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

  if attributes.has_key?(:'launchAuth')
    self.launch_auth = attributes[:'launchAuth']
  end
end

Instance Attribute Details

#additionalvalues ⇒ Object

Returns the value of attribute additionalvalues.



41
42
43
 
# File 'lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb', line 41

def additionalvalues
  @additionalvalues
end

#course_tags ⇒ Object

Returns the value of attribute course_tags.



37
38
39
 
# File 'lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb', line 37

def course_tags
  @course_tags
end

#css_url ⇒ Object

A Url pointing to custom css for the player to use.



33
34
35
 
# File 'lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb', line 33

def css_url
  @css_url
end

#culture ⇒ Object

This parameter should specify a culture code. If specified, and supported, the navigation and alerts in the player will be displayed in the associated language. If not specified, the locale of the user’s browser will be used.



30
31
32
 
# File 'lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb', line 30

def culture
  @culture
end

#expiry ⇒ Object

Number of seconds from now this link will expire in. Defaults to 120s. Range 10s:300s



18
19
20
 
# File 'lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb', line 18

def expiry
  @expiry
end

#launch_auth ⇒ Object

Returns the value of attribute launch_auth.



43
44
45
 
# File 'lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb', line 43

def launch_auth
  @launch_auth
end

#learner_tags ⇒ Object

Returns the value of attribute learner_tags.



35
36
37
 
# File 'lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb', line 35

def learner_tags
  @learner_tags
end

#redirect_on_exit_url ⇒ Object

The URL the application should redirect to when the learner exits a course. Alternatively one of the following keywords can be used to redirect to: - ‘closer` - A page that automatically tries to close the browser tab/window - `blank` - A blank page - `message` - A page with a message about the course being complete If an empty string is specified, the configured setting will be used (default www.scorm.com). If an invalid url is specified, the Message.html page will be loaded.



21
22
23
 
# File 'lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb', line 21

def redirect_on_exit_url
  @redirect_on_exit_url
end

#registration_tags ⇒ Object

Returns the value of attribute registration_tags.



39
40
41
 
# File 'lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb', line 39

def registration_tags
  @registration_tags
end

#start_sco ⇒ Object

For SCORM, SCO identifier to override launch, overriding the normal sequencing.



27
28
29
 
# File 'lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb', line 27

def start_sco
  @start_sco
end

#tracking ⇒ Object

Should this launch be tracked? If false, SCORM Cloud will avoid tracking to the extent possible for the standard being used.



24
25
26
 
# File 'lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb', line 24

def tracking
  @tracking
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb', line 46

def self.attribute_map
  {
    :'expiry' => :'expiry',
    :'redirect_on_exit_url' => :'redirectOnExitUrl',
    :'tracking' => :'tracking',
    :'start_sco' => :'startSco',
    :'culture' => :'culture',
    :'css_url' => :'cssUrl',
    :'learner_tags' => :'learnerTags',
    :'course_tags' => :'courseTags',
    :'registration_tags' => :'registrationTags',
    :'additionalvalues' => :'additionalvalues',
    :'launch_auth' => :'launchAuth'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb', line 63

def self.swagger_types
  {
    :'expiry' => :'Integer',
    :'redirect_on_exit_url' => :'String',
    :'tracking' => :'BOOLEAN',
    :'start_sco' => :'String',
    :'culture' => :'String',
    :'css_url' => :'String',
    :'learner_tags' => :'Array<String>',
    :'course_tags' => :'Array<String>',
    :'registration_tags' => :'Array<String>',
    :'additionalvalues' => :'Array<ItemValuePairSchema>',
    :'launch_auth' => :'LaunchAuthSchema'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb', line 165

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      expiry == o.expiry &&
      redirect_on_exit_url == o.redirect_on_exit_url &&
      tracking == o.tracking &&
      start_sco == o.start_sco &&
      culture == o.culture &&
      css_url == o.css_url &&
      learner_tags == o.learner_tags &&
      course_tags == o.course_tags &&
      registration_tags == o.registration_tags &&
      additionalvalues == o.additionalvalues &&
      launch_auth == o.launch_auth
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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb', line 217

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 = RusticiSoftwareCloudV2.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



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb', line 283

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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb', line 196

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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


183
184
185
 
# File 'lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb', line 183

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



189
190
191
 
# File 'lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb', line 189

def hash
  [expiry, redirect_on_exit_url, tracking, start_sco, culture, css_url, learner_tags, course_tags, registration_tags, additionalvalues, launch_auth].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



146
147
148
149
150
151
152
153
 
# File 'lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb', line 146

def list_invalid_properties
  invalid_properties = Array.new
  if @redirect_on_exit_url.nil?
    invalid_properties.push('invalid value for "redirect_on_exit_url", redirect_on_exit_url cannot be nil.')
  end

  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



263
264
265
 
# File 'lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb', line 263

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



269
270
271
272
273
274
275
276
277
 
# File 'lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb', line 269

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



257
258
259
 
# File 'lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb', line 257

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



157
158
159
160
 
# File 'lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb', line 157

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