Class: SlackWebApi::ResponseMetadata

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

Overview

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

Returns a new instance of ResponseMetadata.



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

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

  @next_cursor = next_cursor
  @additional_properties = additional_properties
end

Instance Attribute Details

#next_cursor ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def next_cursor
  @next_cursor
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/slack_web_api/models/response_metadata.rb', line 42

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  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.
  ResponseMetadata.new(next_cursor: next_cursor,
                       additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



17
18
19
20
21
 
# File 'lib/slack_web_api/models/response_metadata.rb', line 17

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

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



24
25
26
 
# File 'lib/slack_web_api/models/response_metadata.rb', line 24

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



68
69
70
71
72
 
# File 'lib/slack_web_api/models/response_metadata.rb', line 68

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



61
62
63
64
65
 
# File 'lib/slack_web_api/models/response_metadata.rb', line 61

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