Class: ESIClient::GetCharactersCharacterIdChatChannels200Ok

Inherits:
Object
  • Object
show all
Defined in:
lib/esi_client/models/get_characters_character_id_chat_channels_200_ok.rb

Overview

200 ok object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetCharactersCharacterIdChatChannels200Ok

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
128
129
130
131
132
133
134
135
 
# File 'lib/esi_client/models/get_characters_character_id_chat_channels_200_ok.rb', line 82

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'channel_id')
    self.channel_id = attributes[:'channel_id']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'owner_id')
    self.owner_id = attributes[:'owner_id']
  end

  if attributes.has_key?(:'comparison_key')
    self.comparison_key = attributes[:'comparison_key']
  end

  if attributes.has_key?(:'has_password')
    self.has_password = attributes[:'has_password']
  end

  if attributes.has_key?(:'motd')
    self.motd = attributes[:'motd']
  end

  if attributes.has_key?(:'allowed')
    if (value = attributes[:'allowed']).is_a?(Array)
      self.allowed = value
    end
  end

  if attributes.has_key?(:'operators')
    if (value = attributes[:'operators']).is_a?(Array)
      self.operators = value
    end
  end

  if attributes.has_key?(:'blocked')
    if (value = attributes[:'blocked']).is_a?(Array)
      self.blocked = value
    end
  end

  if attributes.has_key?(:'muted')
    if (value = attributes[:'muted']).is_a?(Array)
      self.muted = value
    end
  end
end

Instance Attribute Details

#allowed ⇒ Object

allowed array



37
38
39
 
# File 'lib/esi_client/models/get_characters_character_id_chat_channels_200_ok.rb', line 37

def allowed
  @allowed
end

#blocked ⇒ Object

blocked array



43
44
45
 
# File 'lib/esi_client/models/get_characters_character_id_chat_channels_200_ok.rb', line 43

def blocked
  @blocked
end

#channel_id ⇒ Object

Unique channel ID. Always negative for player-created channels. Permanent (CCP created) channels have a positive ID, but don’t appear in the API



19
20
21
 
# File 'lib/esi_client/models/get_characters_character_id_chat_channels_200_ok.rb', line 19

def channel_id
  @channel_id
end

#comparison_key ⇒ Object

Normalized, unique string used to compare channel names



28
29
30
 
# File 'lib/esi_client/models/get_characters_character_id_chat_channels_200_ok.rb', line 28

def comparison_key
  @comparison_key
end

#has_password ⇒ Object

If this is a password protected channel



31
32
33
 
# File 'lib/esi_client/models/get_characters_character_id_chat_channels_200_ok.rb', line 31

def has_password
  @has_password
end

#motd ⇒ Object

Message of the day for this channel



34
35
36
 
# File 'lib/esi_client/models/get_characters_character_id_chat_channels_200_ok.rb', line 34

def motd
  @motd
end

#muted ⇒ Object

muted array



46
47
48
 
# File 'lib/esi_client/models/get_characters_character_id_chat_channels_200_ok.rb', line 46

def muted
  @muted
end

#name ⇒ Object

Displayed name of channel



22
23
24
 
# File 'lib/esi_client/models/get_characters_character_id_chat_channels_200_ok.rb', line 22

def name
  @name
end

#operators ⇒ Object

operators array



40
41
42
 
# File 'lib/esi_client/models/get_characters_character_id_chat_channels_200_ok.rb', line 40

def operators
  @operators
end

#owner_id ⇒ Object

owner_id integer



25
26
27
 
# File 'lib/esi_client/models/get_characters_character_id_chat_channels_200_ok.rb', line 25

def owner_id
  @owner_id
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/esi_client/models/get_characters_character_id_chat_channels_200_ok.rb', line 49

def self.attribute_map
  {
    :'channel_id' => :'channel_id',
    :'name' => :'name',
    :'owner_id' => :'owner_id',
    :'comparison_key' => :'comparison_key',
    :'has_password' => :'has_password',
    :'motd' => :'motd',
    :'allowed' => :'allowed',
    :'operators' => :'operators',
    :'blocked' => :'blocked',
    :'muted' => :'muted'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/esi_client/models/get_characters_character_id_chat_channels_200_ok.rb', line 65

def self.swagger_types
  {
    :'channel_id' => :'Integer',
    :'name' => :'String',
    :'owner_id' => :'Integer',
    :'comparison_key' => :'String',
    :'has_password' => :'BOOLEAN',
    :'motd' => :'String',
    :'allowed' => :'Array<GetCharactersCharacterIdChatChannelsAllowed>',
    :'operators' => :'Array<GetCharactersCharacterIdChatChannelsOperator>',
    :'blocked' => :'Array<GetCharactersCharacterIdChatChannelsBlocked>',
    :'muted' => :'Array<GetCharactersCharacterIdChatChannelsMuted>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/esi_client/models/get_characters_character_id_chat_channels_200_ok.rb', line 202

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      channel_id == o.channel_id &&
      name == o.name &&
      owner_id == o.owner_id &&
      comparison_key == o.comparison_key &&
      has_password == o.has_password &&
      motd == o.motd &&
      allowed == o.allowed &&
      operators == o.operators &&
      blocked == o.blocked &&
      muted == o.muted
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



253
254
255
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
 
# File 'lib/esi_client/models/get_characters_character_id_chat_channels_200_ok.rb', line 253

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
    temp_model = ESIClient.const_get(type).new
    temp_model.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



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/esi_client/models/get_characters_character_id_chat_channels_200_ok.rb', line 319

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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/esi_client/models/get_characters_character_id_chat_channels_200_ok.rb', line 232

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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


219
220
221
 
# File 'lib/esi_client/models/get_characters_character_id_chat_channels_200_ok.rb', line 219

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



225
226
227
 
# File 'lib/esi_client/models/get_characters_character_id_chat_channels_200_ok.rb', line 225

def hash
  [channel_id, name, owner_id, comparison_key, has_password, motd, allowed, operators, blocked, muted].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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/esi_client/models/get_characters_character_id_chat_channels_200_ok.rb', line 139

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

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

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

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

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

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

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

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

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

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



299
300
301
 
# File 'lib/esi_client/models/get_characters_character_id_chat_channels_200_ok.rb', line 299

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



305
306
307
308
309
310
311
312
313
 
# File 'lib/esi_client/models/get_characters_character_id_chat_channels_200_ok.rb', line 305

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



293
294
295
 
# File 'lib/esi_client/models/get_characters_character_id_chat_channels_200_ok.rb', line 293

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



186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/esi_client/models/get_characters_character_id_chat_channels_200_ok.rb', line 186

def valid?
  return false if @channel_id.nil?
  return false if @name.nil?
  return false if @owner_id.nil?
  return false if @comparison_key.nil?
  return false if @has_password.nil?
  return false if @motd.nil?
  return false if @allowed.nil?
  return false if @operators.nil?
  return false if @blocked.nil?
  return false if @muted.nil?
  true
end