Class: SunshineConversationsClient::Webview

Inherits:
Object
  • Object
show all
Defined in:
lib/sunshine-conversations-client/models/webview.rb

Overview

When a webview actions is clicked/tapped, the provided URI will be loaded in a webview. Channels that do not support webviews will open the fallback URI instead.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Webview

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
143
144
145
146
147
148
149
150
 
# File 'lib/sunshine-conversations-client/models/webview.rb', line 102

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SunshineConversationsClient::Webview` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `SunshineConversationsClient::Webview`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#default ⇒ Object

Boolean value indicating whether the action is the default action for a message item in Facebook Messenger.



25
26
27
 
# File 'lib/sunshine-conversations-client/models/webview.rb', line 25

def default
  @default
end

#extra_channel_options ⇒ Object

Returns the value of attribute extra_channel_options.



30
31
32
 
# File 'lib/sunshine-conversations-client/models/webview.rb', line 30

def extra_channel_options
  @extra_channel_options
end

#fallback ⇒ Object

The fallback uri for channels that don’t support webviews. Used for actions of type webview.



36
37
38
 
# File 'lib/sunshine-conversations-client/models/webview.rb', line 36

def fallback
  @fallback
end

#metadata ⇒ Object

Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size.



28
29
30
 
# File 'lib/sunshine-conversations-client/models/webview.rb', line 28

def metadata
  @metadata
end

#open_on_receive ⇒ Object

Boolean value indicating if the webview should open automatically. Only one action per message can be set to true. Currently only supported on the Web Messenger.



39
40
41
 
# File 'lib/sunshine-conversations-client/models/webview.rb', line 39

def open_on_receive
  @open_on_receive
end

#size ⇒ Object

The size to display a webview. Used for actions of type webview.



33
34
35
 
# File 'lib/sunshine-conversations-client/models/webview.rb', line 33

def size
  @size
end

#text ⇒ Object

The button text.



22
23
24
 
# File 'lib/sunshine-conversations-client/models/webview.rb', line 22

def text
  @text
end

#type ⇒ Object

The type of action.



16
17
18
 
# File 'lib/sunshine-conversations-client/models/webview.rb', line 16

def type
  @type
end

#uri ⇒ Object

The webview URI. This is the URI that will open in the webview when clicking the button.



19
20
21
 
# File 'lib/sunshine-conversations-client/models/webview.rb', line 19

def uri
  @uri
end

Class Method Details

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/sunshine-conversations-client/models/webview.rb', line 64

def self.attribute_map
  {
    :'type' => :'type',
    :'uri' => :'uri',
    :'text' => :'text',
    :'default' => :'default',
    :'metadata' => :'metadata',
    :'extra_channel_options' => :'extraChannelOptions',
    :'size' => :'size',
    :'fallback' => :'fallback',
    :'open_on_receive' => :'openOnReceive'
  }
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



228
229
230
 
# File 'lib/sunshine-conversations-client/models/webview.rb', line 228

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



94
95
96
97
98
 
# File 'lib/sunshine-conversations-client/models/webview.rb', line 94

def self.openapi_nullable
  Set.new([
    :'metadata',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/sunshine-conversations-client/models/webview.rb', line 79

def self.openapi_types
  {
    :'type' => :'String',
    :'uri' => :'String',
    :'text' => :'String',
    :'default' => :'Boolean',
    :'metadata' => :'Object',
    :'extra_channel_options' => :'ExtraChannelOptions',
    :'size' => :'String',
    :'fallback' => :'String',
    :'open_on_receive' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/sunshine-conversations-client/models/webview.rb', line 199

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      uri == o.uri &&
      text == o.text &&
      default == o.default &&
      metadata == o.metadata &&
      extra_channel_options == o.extra_channel_options &&
      size == o.size &&
      fallback == o.fallback &&
      open_on_receive == o.open_on_receive
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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/sunshine-conversations-client/models/webview.rb', line 256

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
    SunshineConversationsClient.const_get(type).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



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/sunshine-conversations-client/models/webview.rb', line 325

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



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/sunshine-conversations-client/models/webview.rb', line 235

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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


215
216
217
 
# File 'lib/sunshine-conversations-client/models/webview.rb', line 215

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



221
222
223
 
# File 'lib/sunshine-conversations-client/models/webview.rb', line 221

def hash
  [type, uri, text, default, metadata, extra_channel_options, size, fallback, open_on_receive].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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/sunshine-conversations-client/models/webview.rb', line 154

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

  if @uri.nil?
    invalid_properties.push('invalid value for "uri", uri cannot be nil.')
  end

  if @text.nil?
    invalid_properties.push('invalid value for "text", text cannot be nil.')
  end

  if @fallback.nil?
    invalid_properties.push('invalid value for "fallback", fallback 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



301
302
303
 
# File 'lib/sunshine-conversations-client/models/webview.rb', line 301

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



307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/sunshine-conversations-client/models/webview.rb', line 307

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    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



295
296
297
 
# File 'lib/sunshine-conversations-client/models/webview.rb', line 295

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



177
178
179
180
181
182
183
184
185
 
# File 'lib/sunshine-conversations-client/models/webview.rb', line 177

def valid?
  return false if @type.nil?
  return false if @uri.nil?
  return false if @text.nil?
  size_validator = EnumAttributeValidator.new('String', ["compact", "tall", "full"])
  return false unless size_validator.valid?(@size)
  return false if @fallback.nil?
  true
end