Class: SlackWebApi::ReactionObject

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/slack_web_api/models/reaction_object.rb

Overview

ReactionObject Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(count:, name:, users:, additional_properties: nil) ⇒ ReactionObject

Returns a new instance of ReactionObject.



43
44
45
46
47
48
49
50
51
 
# File 'lib/slack_web_api/models/reaction_object.rb', line 43

def initialize(count:, name:, users:, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @count = count
  @name = name
  @users = users
  @additional_properties = additional_properties
end

Instance Attribute Details

#count ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


14
15
16
 
# File 'lib/slack_web_api/models/reaction_object.rb', line 14

def count
  @count
end

#name ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


18
19
20
 
# File 'lib/slack_web_api/models/reaction_object.rb', line 18

def name
  @name
end

#users ⇒ Array[String]

TODO: Write general description for this method

Returns:

  • (Array[String]) 


22
23
24
 
# File 'lib/slack_web_api/models/reaction_object.rb', line 22

def users
  @users
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/slack_web_api/models/reaction_object.rb', line 54

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  count = hash.key?('count') ? hash['count'] : nil
  name = hash.key?('name') ? hash['name'] : nil
  users = hash.key?('users') ? hash['users'] : nil

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  ReactionObject.new(count: count,
                     name: name,
                     users: users,
                     additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



25
26
27
28
29
30
31
 
# File 'lib/slack_web_api/models/reaction_object.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['count'] = 'count'
  @_hash['name'] = 'name'
  @_hash['users'] = 'users'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



39
40
41
 
# File 'lib/slack_web_api/models/reaction_object.rb', line 39

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



34
35
36
 
# File 'lib/slack_web_api/models/reaction_object.rb', line 34

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



84
85
86
87
88
 
# File 'lib/slack_web_api/models/reaction_object.rb', line 84

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} count: #{@count.inspect}, name: #{@name.inspect}, users: #{@users.inspect},"\
  " additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



77
78
79
80
81
 
# File 'lib/slack_web_api/models/reaction_object.rb', line 77

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} count: #{@count}, name: #{@name}, users: #{@users}, additional_properties:"\
  " #{@additional_properties}>"
end