Class: Bandwidth::DeferredResult

Inherits:
BaseModel show all
Defined in:
lib/bandwidth/messaging_lib/messaging/models/deferred_result.rb

Overview

DeferredResult Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(result = nil, set_or_expired = nil) ⇒ DeferredResult

Returns a new instance of DeferredResult.



41
42
43
44
45
 
# File 'lib/bandwidth/messaging_lib/messaging/models/deferred_result.rb', line 41

def initialize(result = nil,
               set_or_expired = nil)
  @result = result unless result == SKIP
  @set_or_expired = set_or_expired unless set_or_expired == SKIP
end

Instance Attribute Details

#result ⇒ Object

TODO: Write general description for this method

Returns:

  • (Object) 


14
15
16
 
# File 'lib/bandwidth/messaging_lib/messaging/models/deferred_result.rb', line 14

def result
  @result
end

#set_or_expired ⇒ Boolean

TODO: Write general description for this method

Returns:

  • (Boolean) 


18
19
20
 
# File 'lib/bandwidth/messaging_lib/messaging/models/deferred_result.rb', line 18

def set_or_expired
  @set_or_expired
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/bandwidth/messaging_lib/messaging/models/deferred_result.rb', line 48

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  result = hash.key?('result') ? hash['result'] : SKIP
  set_or_expired = hash.key?('setOrExpired') ? hash['setOrExpired'] : SKIP

  # Create object from extracted values.
  DeferredResult.new(result,
                     set_or_expired)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/bandwidth/messaging_lib/messaging/models/deferred_result.rb', line 21

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['result'] = 'result'
  @_hash['set_or_expired'] = 'setOrExpired'
  @_hash
end

Instance Method Details

#nullables ⇒ Object

An array for nullable fields



37
38
39
 
# File 'lib/bandwidth/messaging_lib/messaging/models/deferred_result.rb', line 37

def nullables
  []
end

#optionals ⇒ Object

An array for optional fields



29
30
31
32
33
34
 
# File 'lib/bandwidth/messaging_lib/messaging/models/deferred_result.rb', line 29

def optionals
  %w[
    result
    set_or_expired
  ]
end