Class: SlackWebApi::ConversationsHistoryErrorSchemaException

Inherits:
APIException
  • Object
show all
Defined in:
lib/slack_web_api/exceptions/conversations_history_error_schema_exception.rb

Overview

Schema for error response from conversations.history method

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(reason, response) ⇒ ConversationsHistoryErrorSchemaException

The constructor.

Parameters:

  • reason (String) —

    The reason for raising an exception.

  • response (HttpResponse) —

    The HttpReponse of the API call.



35
36
37
38
39
 
# File 'lib/slack_web_api/exceptions/conversations_history_error_schema_exception.rb', line 35

def initialize(reason, response)
  super(reason, response)
  hash = APIHelper.json_deserialize(@response.raw_body)
  unbox(hash)
end

Instance Attribute Details

#callstack ⇒ String

Note: PHP callstack is only visible in dev/qa

Returns:

  • (String) 


14
15
16
 
# File 'lib/slack_web_api/exceptions/conversations_history_error_schema_exception.rb', line 14

def callstack
  @callstack
end

#error ⇒ Error33

Note: PHP callstack is only visible in dev/qa

Returns:



18
19
20
 
# File 'lib/slack_web_api/exceptions/conversations_history_error_schema_exception.rb', line 18

def error
  @error
end

#needed ⇒ String

Note: PHP callstack is only visible in dev/qa

Returns:

  • (String) 


22
23
24
 
# File 'lib/slack_web_api/exceptions/conversations_history_error_schema_exception.rb', line 22

def needed
  @needed
end

#ok ⇒ String (readonly)

Note: PHP callstack is only visible in dev/qa

Returns:

  • (String) 


26
27
28
 
# File 'lib/slack_web_api/exceptions/conversations_history_error_schema_exception.rb', line 26

def ok
  @ok
end

#provided ⇒ String

Note: PHP callstack is only visible in dev/qa

Returns:

  • (String) 


30
31
32
 
# File 'lib/slack_web_api/exceptions/conversations_history_error_schema_exception.rb', line 30

def provided
  @provided
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



61
62
63
64
65
 
# File 'lib/slack_web_api/exceptions/conversations_history_error_schema_exception.rb', line 61

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} callstack: #{@callstack.inspect}, error: #{@error.inspect}, needed:"\
  " #{@needed.inspect}, ok: #{@ok.inspect}, provided: #{@provided.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



54
55
56
57
58
 
# File 'lib/slack_web_api/exceptions/conversations_history_error_schema_exception.rb', line 54

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} callstack: #{@callstack}, error: #{@error}, needed: #{@needed}, ok: #{@ok},"\
  " provided: #{@provided}>"
end

#unbox(hash) ⇒ Object

Populates this object by extracting properties from a hash. response body.

Parameters:

  • hash (Hash) —

    The deserialized response sent by the server in the



44
45
46
47
48
49
50
51
 
# File 'lib/slack_web_api/exceptions/conversations_history_error_schema_exception.rb', line 44

def unbox(hash)
  return nil unless hash

  @callstack = hash.key?('callstack') ? hash['callstack'] : SKIP
  @error = hash.key?('error') ? hash['error'] : nil
  @needed = hash.key?('needed') ? hash['needed'] : SKIP
  @provided = hash.key?('provided') ? hash['provided'] : SKIP
end