Class: SlackWebApi::ConversationsHistorySuccessSchema

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

Overview

Schema for successful response from conversations.history method

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(channel_actions_count:, channel_actions_ts:, has_more:, messages:, pin_count:, additional_properties: nil) ⇒ ConversationsHistorySuccessSchema

Returns a new instance of ConversationsHistorySuccessSchema.



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/slack_web_api/models/conversations_history_success_schema.rb', line 58

def initialize(channel_actions_count:, channel_actions_ts:, has_more:,
               messages:, pin_count:, additional_properties: nil)
  # Add additional model properties to the instance

  additional_properties = {} if additional_properties.nil?

  @channel_actions_count = channel_actions_count
  @channel_actions_ts = channel_actions_ts
  @has_more = has_more
  @messages = messages
  @ok = 'True'
  @pin_count = pin_count
  @additional_properties = additional_properties
end

Instance Attribute Details

#channel_actions_count ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def channel_actions_count
  @channel_actions_count
end

#channel_actions_ts ⇒ Object

TODO: Write general description for this method

Returns:

  • (Object) 


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

def channel_actions_ts
  @channel_actions_ts
end

#has_more ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


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

def has_more
  @has_more
end

#messages ⇒ Array[MessageObject]

TODO: Write general description for this method

Returns:



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

def messages
  @messages
end

#ok ⇒ String (readonly)

TODO: Write general description for this method

Returns:

  • (String) 


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

def ok
  @ok
end

#pin_count ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def pin_count
  @pin_count
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
 
# File 'lib/slack_web_api/models/conversations_history_success_schema.rb', line 73

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  channel_actions_count =
    hash.key?('channel_actions_count') ? hash['channel_actions_count'] : nil
  channel_actions_ts =
    hash.key?('channel_actions_ts') ? hash['channel_actions_ts'] : nil
  has_more = hash.key?('has_more') ? hash['has_more'] : nil
  # Parameter is an array, so we need to iterate through it

  messages = nil
  unless hash['messages'].nil?
    messages = []
    hash['messages'].each do |structure|
      messages << (MessageObject.from_hash(structure) if structure)
    end
  end

  messages = nil unless hash.key?('messages')
  pin_count = hash.key?('pin_count') ? hash['pin_count'] : 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.

  ConversationsHistorySuccessSchema.new(channel_actions_count: channel_actions_count,
                                        channel_actions_ts: channel_actions_ts,
                                        has_more: has_more,
                                        messages: messages,
                                        pin_count: pin_count,
                                        additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/slack_web_api/models/conversations_history_success_schema.rb', line 37

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['channel_actions_count'] = 'channel_actions_count'
  @_hash['channel_actions_ts'] = 'channel_actions_ts'
  @_hash['has_more'] = 'has_more'
  @_hash['messages'] = 'messages'
  @_hash['ok'] = 'ok'
  @_hash['pin_count'] = 'pin_count'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



54
55
56
 
# File 'lib/slack_web_api/models/conversations_history_success_schema.rb', line 54

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



49
50
51
 
# File 'lib/slack_web_api/models/conversations_history_success_schema.rb', line 49

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



119
120
121
122
123
124
125
 
# File 'lib/slack_web_api/models/conversations_history_success_schema.rb', line 119

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} channel_actions_count: #{@channel_actions_count.inspect},"\
  " channel_actions_ts: #{@channel_actions_ts.inspect}, has_more: #{@has_more.inspect},"\
  " messages: #{@messages.inspect}, ok: #{@ok.inspect}, pin_count: #{@pin_count.inspect},"\
  " additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



111
112
113
114
115
116
 
# File 'lib/slack_web_api/models/conversations_history_success_schema.rb', line 111

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} channel_actions_count: #{@channel_actions_count}, channel_actions_ts:"\
  " #{@channel_actions_ts}, has_more: #{@has_more}, messages: #{@messages}, ok: #{@ok},"\
  " pin_count: #{@pin_count}, additional_properties: #{@additional_properties}>"
end