Class: Comet::Office365ObjectInfo

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Office365ObjectInfo

Returns a new instance of Office365ObjectInfo.



34
35
36
 
# File 'lib/comet/models/office_365object_info.rb', line 34

def initialize
  clear
end

Instance Attribute Details

#guid ⇒ Object

Returns the value of attribute guid.



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

def guid
  @guid
end

#members ⇒ Object

Returns the value of attribute members.



29
30
31
 
# File 'lib/comet/models/office_365object_info.rb', line 29

def members
  @members
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



32
33
34
 
# File 'lib/comet/models/office_365object_info.rb', line 32

def unknown_json_fields
  @unknown_json_fields
end

#value ⇒ Object

May be an email address or a SharePoint site URL



26
27
28
 
# File 'lib/comet/models/office_365object_info.rb', line 26

def value
  @value
end

Instance Method Details

#clear ⇒ Object 



38
39
40
41
42
43
44
45
 
# File 'lib/comet/models/office_365object_info.rb', line 38

def clear
  @guid = ''
  @name = ''
  @type = ''
  @value = ''
  @members = []
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/comet/models/office_365object_info.rb', line 55

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 'GUID'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @guid = v
    when 'Name'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

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

      @type = v
    when 'Value'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @value = v
    when 'Members'
      if v.nil?
        @members = []
      else
        @members = Array.new(v.length)
        v.each_with_index do |v1, i1|
          raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String

          @members[i1] = v1
        end
      end
    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) 


48
49
50
51
52
 
# File 'lib/comet/models/office_365object_info.rb', line 48

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



108
109
110
 
# File 'lib/comet/models/office_365object_info.rb', line 108

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



94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/comet/models/office_365object_info.rb', line 94

def to_hash
  ret = {}
  ret['GUID'] = @guid
  ret['Name'] = @name
  ret['Type'] = @type
  ret['Value'] = @value
  ret['Members'] = @members
  @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



113
114
115
 
# File 'lib/comet/models/office_365object_info.rb', line 113

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