Class: SlackWebApi::ConversationsJoinSuccessSchema

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

Overview

Schema for successful response from conversations.join 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:, response_metadata: SKIP, warning: SKIP, additional_properties: nil) ⇒ ConversationsJoinSuccessSchema

Returns a new instance of ConversationsJoinSuccessSchema.



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/slack_web_api/models/conversations_join_success_schema.rb', line 51

def initialize(channel:, response_metadata: SKIP, warning: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance

  additional_properties = {} if additional_properties.nil?

  @channel = channel
  @ok = 'True'
  @response_metadata = response_metadata unless response_metadata == SKIP
  @warning = warning unless warning == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#channel ⇒ Object

TODO: Write general description for this method

Returns:

  • (Object) 


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

def channel
  @channel
end

#ok ⇒ String (readonly)

TODO: Write general description for this method

Returns:

  • (String) 


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

def ok
  @ok
end

#response_metadata ⇒ ResponseMetadata3

TODO: Write general description for this method

Returns:



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

def response_metadata
  @response_metadata
end

#warning ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def warning
  @warning
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/slack_web_api/models/conversations_join_success_schema.rb', line 64

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  channel = hash.key?('channel') ? hash['channel'] : nil
  response_metadata = ResponseMetadata3.from_hash(hash['response_metadata']) if
    hash['response_metadata']
  warning = hash.key?('warning') ? hash['warning'] : 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.

  ConversationsJoinSuccessSchema.new(channel: channel,
                                     response_metadata: response_metadata,
                                     warning: warning,
                                     additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



29
30
31
32
33
34
35
36
 
# File 'lib/slack_web_api/models/conversations_join_success_schema.rb', line 29

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['channel'] = 'channel'
  @_hash['ok'] = 'ok'
  @_hash['response_metadata'] = 'response_metadata'
  @_hash['warning'] = 'warning'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



47
48
49
 
# File 'lib/slack_web_api/models/conversations_join_success_schema.rb', line 47

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



39
40
41
42
43
44
 
# File 'lib/slack_web_api/models/conversations_join_success_schema.rb', line 39

def self.optionals
  %w[
    response_metadata
    warning
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



95
96
97
98
99
100
 
# File 'lib/slack_web_api/models/conversations_join_success_schema.rb', line 95

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



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

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