Class: Comet::Office365CustomSettingV2

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

Overview

This type is available in Comet 21.9.xx and later.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Office365CustomSettingV2

Returns a new instance of Office365CustomSettingV2.



50
51
52
 
# File 'lib/comet/models/office_365custom_setting_v2.rb', line 50

def initialize
  clear
end

Instance Attribute Details

#backup_options ⇒ Object

Key is the ID of User, Group, or Site Value is a bitset of the SERVICE_ constants, to select which services to back up for members



30
31
32
 
# File 'lib/comet/models/office_365custom_setting_v2.rb', line 30

def backup_options
  @backup_options
end

#filter_member_options ⇒ Object

Key is the ID of a Group or Team Site Value is a bitset of the SERVICE_ constants, to select which services to back up for members



45
46
47
 
# File 'lib/comet/models/office_365custom_setting_v2.rb', line 45

def filter_member_options
  @filter_member_options
end

#filter_mode ⇒ Object

If true, exclude all filtered IDs and Members. Backup everything else



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

def filter_mode
  @filter_mode
end

#filter_options ⇒ Object

Key is the ID of a User, Group, or Site Value is a bitset of the SERVICE_ constants, to select which services to back up for members



40
41
42
 
# File 'lib/comet/models/office_365custom_setting_v2.rb', line 40

def filter_options
  @filter_options
end

#member_backup_options ⇒ Object

Key is the ID of a Group or Team Site Value is a bitset of the SERVICE_ constants, to select which services to back up for members



35
36
37
 
# File 'lib/comet/models/office_365custom_setting_v2.rb', line 35

def member_backup_options
  @member_backup_options
end

#organization ⇒ Object

Deprecated.

This member has been deprecated since Comet version 24.12.2

If true, then backup everything except the selected users (group members are still included)



21
22
23
 
# File 'lib/comet/models/office_365custom_setting_v2.rb', line 21

def organization
  @organization
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



48
49
50
 
# File 'lib/comet/models/office_365custom_setting_v2.rb', line 48

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



54
55
56
57
58
59
60
 
# File 'lib/comet/models/office_365custom_setting_v2.rb', line 54

def clear
  @backup_options = {}
  @member_backup_options = {}
  @filter_options = {}
  @filter_member_options = {}
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


70
71
72
73
74
75
76
77
78
79
80
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
 
# File 'lib/comet/models/office_365custom_setting_v2.rb', line 70

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 'Organization'
      @organization = v
    when 'FilterMode'
      @filter_mode = v
    when 'BackupOptions'
      @backup_options = {}
      if v.nil?
        @backup_options = {}
      else
        v.each do |k1, v1|
          raise TypeError, "'v1' expected Numeric, got #{v1.class}" unless v1.is_a? Numeric

          @backup_options[k1] = v1
        end
      end
    when 'MemberBackupOptions'
      @member_backup_options = {}
      if v.nil?
        @member_backup_options = {}
      else
        v.each do |k1, v1|
          raise TypeError, "'v1' expected Numeric, got #{v1.class}" unless v1.is_a? Numeric

          @member_backup_options[k1] = v1
        end
      end
    when 'FilterOptions'
      @filter_options = {}
      if v.nil?
        @filter_options = {}
      else
        v.each do |k1, v1|
          raise TypeError, "'v1' expected Numeric, got #{v1.class}" unless v1.is_a? Numeric

          @filter_options[k1] = v1
        end
      end
    when 'FilterMemberOptions'
      @filter_member_options = {}
      if v.nil?
        @filter_member_options = {}
      else
        v.each do |k1, v1|
          raise TypeError, "'v1' expected Numeric, got #{v1.class}" unless v1.is_a? Numeric

          @filter_member_options[k1] = 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) 


63
64
65
66
67
 
# File 'lib/comet/models/office_365custom_setting_v2.rb', line 63

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



153
154
155
 
# File 'lib/comet/models/office_365custom_setting_v2.rb', line 153

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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/comet/models/office_365custom_setting_v2.rb', line 130

def to_hash
  ret = {}
  ret['Organization'] = @organization
  ret['FilterMode'] = @filter_mode
  unless @backup_options.nil?
    ret['BackupOptions'] = @backup_options
  end
  unless @member_backup_options.nil?
    ret['MemberBackupOptions'] = @member_backup_options
  end
  unless @filter_options.nil?
    ret['FilterOptions'] = @filter_options
  end
  unless @filter_member_options.nil?
    ret['FilterMemberOptions'] = @filter_member_options
  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



158
159
160
 
# File 'lib/comet/models/office_365custom_setting_v2.rb', line 158

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