Class: SlackWebApi::MessageObject1

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

Overview

MessageObject1 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(text:, attachments: SKIP, blocks: SKIP, additional_properties: nil) ⇒ MessageObject1

Returns a new instance of MessageObject1.



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/slack_web_api/models/message_object1.rb', line 46

def initialize(text:, attachments: SKIP, blocks: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance

  additional_properties = {} if additional_properties.nil?

  @attachments = attachments unless attachments == SKIP
  @blocks = blocks unless blocks == SKIP
  @text = text
  @additional_properties = additional_properties
end

Instance Attribute Details

#attachments ⇒ Array[Object]

TODO: Write general description for this method

Returns:

  • (Array[Object]) 


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

def attachments
  @attachments
end

#blocks ⇒ Object

TODO: Write general description for this method

Returns:

  • (Object) 


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

def blocks
  @blocks
end

#text ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def text
  @text
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/slack_web_api/models/message_object1.rb', line 58

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  text = hash.key?('text') ? hash['text'] : nil
  attachments = hash.key?('attachments') ? hash['attachments'] : SKIP
  blocks = hash.key?('blocks') ? hash['blocks'] : 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.

  MessageObject1.new(text: text,
                     attachments: attachments,
                     blocks: blocks,
                     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/message_object1.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['attachments'] = 'attachments'
  @_hash['blocks'] = 'blocks'
  @_hash['text'] = 'text'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



42
43
44
 
# File 'lib/slack_web_api/models/message_object1.rb', line 42

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



34
35
36
37
38
39
 
# File 'lib/slack_web_api/models/message_object1.rb', line 34

def self.optionals
  %w[
    attachments
    blocks
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



88
89
90
91
92
 
# File 'lib/slack_web_api/models/message_object1.rb', line 88

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



81
82
83
84
85
 
# File 'lib/slack_web_api/models/message_object1.rb', line 81

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