Class: Comet::StreamableEvent

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/streamable_event.rb

Overview

StreamableEvent is a typed class wrapper around the underlying Comet Server API data structure.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ StreamableEvent

Returns a new instance of StreamableEvent.



27
28
29
 
# File 'lib/comet/models/streamable_event.rb', line 27

def initialize
  clear
end

Instance Attribute Details

#data ⇒ Object

Returns the value of attribute data.



22
23
24
 
# File 'lib/comet/models/streamable_event.rb', line 22

def data
  @data
end

#owner_organization_id ⇒ Object

Returns the value of attribute owner_organization_id.



16
17
18
 
# File 'lib/comet/models/streamable_event.rb', line 16

def owner_organization_id
  @owner_organization_id
end

#type ⇒ Object

Returns the value of attribute type.



19
20
21
 
# File 'lib/comet/models/streamable_event.rb', line 19

def type
  @type
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



25
26
27
 
# File 'lib/comet/models/streamable_event.rb', line 25

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



31
32
33
34
35
 
# File 'lib/comet/models/streamable_event.rb', line 31

def clear
  @owner_organization_id = ''
  @type = 0
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/comet/models/streamable_event.rb', line 45

def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash

  obj.each do |k, v|
    case k
    when 'OwnerOrganizationID'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @owner_organization_id = v
    when 'Type'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @type = v
    when 'Data'
      @data = v
    else
      @unknown_json_fields[k] = v
    end
  end
end

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


38
39
40
41
42
 
# File 'lib/comet/models/streamable_event.rb', line 38

def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String

  from_hash(JSON.parse(json_string))
end

#to_h ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



81
82
83
 
# File 'lib/comet/models/streamable_event.rb', line 81

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/comet/models/streamable_event.rb', line 67

def to_hash
  ret = {}
  ret['OwnerOrganizationID'] = @owner_organization_id
  ret['Type'] = @type
  unless @data.nil?
    ret['Data'] = @data
  end
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



86
87
88
 
# File 'lib/comet/models/streamable_event.rb', line 86

def to_json(options = {})
  to_hash.to_json(options)
end