Class: SlackWebApi::AdminConversationsSearchSchema

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

Overview

Schema for successful response of admin.conversations.search

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(channels:, next_cursor:, additional_properties: nil) ⇒ AdminConversationsSearchSchema

Returns a new instance of AdminConversationsSearchSchema.



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

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

  @channels = channels
  @next_cursor = next_cursor
  @additional_properties = additional_properties
end

Instance Attribute Details

#channels ⇒ Array[ChannelObject]

TODO: Write general description for this method

Returns:



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

def channels
  @channels
end

#next_cursor ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def next_cursor
  @next_cursor
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/slack_web_api/models/admin_conversations_search_schema.rb', line 48

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  # Parameter is an array, so we need to iterate through it
  channels = nil
  unless hash['channels'].nil?
    channels = []
    hash['channels'].each do |structure|
      channels << (ChannelObject.from_hash(structure) if structure)
    end
  end

  channels = nil unless hash.key?('channels')
  next_cursor = hash.key?('next_cursor') ? hash['next_cursor'] : 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.
  AdminConversationsSearchSchema.new(channels: channels,
                                     next_cursor: next_cursor,
                                     additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/slack_web_api/models/admin_conversations_search_schema.rb', line 21

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['channels'] = 'channels'
  @_hash['next_cursor'] = 'next_cursor'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



29
30
31
 
# File 'lib/slack_web_api/models/admin_conversations_search_schema.rb', line 29

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



85
86
87
88
89
 
# File 'lib/slack_web_api/models/admin_conversations_search_schema.rb', line 85

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



78
79
80
81
82
 
# File 'lib/slack_web_api/models/admin_conversations_search_schema.rb', line 78

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