Class: SlackWebApi::Message

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

Overview

Message 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(bot_id:, team:, text:, type:, user:, bot_profile: SKIP, username: SKIP, additional_properties: nil) ⇒ Message

Returns a new instance of Message.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/slack_web_api/models/message.rb', line 66

def initialize(bot_id:, team:, text:, type:, user:, bot_profile: SKIP,
               username: SKIP, additional_properties: nil)
  # Add additional model properties to the instance

  additional_properties = {} if additional_properties.nil?

  @bot_id = bot_id
  @bot_profile = bot_profile unless bot_profile == SKIP
  @team = team
  @text = text
  @type = type
  @user = user
  @username = username unless username == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#bot_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def bot_id
  @bot_id
end

#bot_profile ⇒ BotProfileObject

TODO: Write general description for this method

Returns:



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

def bot_profile
  @bot_profile
end

#team ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def team
  @team
end

#text ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


26
27
28
 
# File 'lib/slack_web_api/models/message.rb', line 26

def text
  @text
end

#type ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


30
31
32
 
# File 'lib/slack_web_api/models/message.rb', line 30

def type
  @type
end

#user ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def user
  @user
end

#username ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


38
39
40
 
# File 'lib/slack_web_api/models/message.rb', line 38

def username
  @username
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a 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
 
# File 'lib/slack_web_api/models/message.rb', line 82

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  bot_id = hash.key?('bot_id') ? hash['bot_id'] : nil
  team = hash.key?('team') ? hash['team'] : nil
  text = hash.key?('text') ? hash['text'] : nil
  type = hash.key?('type') ? hash['type'] : nil
  user = hash.key?('user') ? hash['user'] : nil
  bot_profile = BotProfileObject.from_hash(hash['bot_profile']) if hash['bot_profile']
  username = hash.key?('username') ? hash['username'] : SKIP

  # 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.

  Message.new(bot_id: bot_id,
              team: team,
              text: text,
              type: type,
              user: user,
              bot_profile: bot_profile,
              username: username,
              additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['bot_id'] = 'bot_id'
  @_hash['bot_profile'] = 'bot_profile'
  @_hash['team'] = 'team'
  @_hash['text'] = 'text'
  @_hash['type'] = 'type'
  @_hash['user'] = 'user'
  @_hash['username'] = 'username'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



62
63
64
 
# File 'lib/slack_web_api/models/message.rb', line 62

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



54
55
56
57
58
59
 
# File 'lib/slack_web_api/models/message.rb', line 54

def self.optionals
  %w[
    bot_profile
    username
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



121
122
123
124
125
126
 
# File 'lib/slack_web_api/models/message.rb', line 121

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} bot_id: #{@bot_id.inspect}, bot_profile: #{@bot_profile.inspect}, team:"\
  " #{@team.inspect}, text: #{@text.inspect}, type: #{@type.inspect}, user: #{@user.inspect},"\
  " username: #{@username.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



113
114
115
116
117
118
 
# File 'lib/slack_web_api/models/message.rb', line 113

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} bot_id: #{@bot_id}, bot_profile: #{@bot_profile}, team: #{@team}, text:"\
  " #{@text}, type: #{@type}, user: #{@user}, username: #{@username}, additional_properties:"\
  " #{@additional_properties}>"
end