Class: SlackWebApi::ConversationsInviteErrorSchema1Exception

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

Overview

Schema for error response from conversations.invite method

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(reason, response) ⇒ ConversationsInviteErrorSchema1Exception

The constructor.

Parameters:

  • reason (String) —

    The reason for raising an exception.

  • response (HttpResponse) —

    The HttpReponse of the API call.



39
40
41
42
43
 
# File 'lib/slack_web_api/exceptions/conversations_invite_error_schema1_exception.rb', line 39

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_invite_error_schema1_exception.rb', line 14

def callstack
  @callstack
end

#error ⇒ Error35

Note: PHP callstack is only visible in dev/qa

Returns:



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

def error
  @error
end

#errors ⇒ Array[ErrorsIsReturnedWhenAnErrorAssociatesAnUser]

Note: PHP callstack is only visible in dev/qa

Returns:



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

def errors
  @errors
end

#needed ⇒ String

Note: PHP callstack is only visible in dev/qa

Returns:

  • (String) 


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

def needed
  @needed
end

#ok ⇒ String (readonly)

Note: PHP callstack is only visible in dev/qa

Returns:

  • (String) 


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

def ok
  @ok
end

#provided ⇒ String

Note: PHP callstack is only visible in dev/qa

Returns:

  • (String) 


34
35
36
 
# File 'lib/slack_web_api/exceptions/conversations_invite_error_schema1_exception.rb', line 34

def provided
  @provided
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



75
76
77
78
79
80
 
# File 'lib/slack_web_api/exceptions/conversations_invite_error_schema1_exception.rb', line 75

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



68
69
70
71
72
 
# File 'lib/slack_web_api/exceptions/conversations_invite_error_schema1_exception.rb', line 68

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} callstack: #{@callstack}, error: #{@error}, errors: #{@errors}, 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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/slack_web_api/exceptions/conversations_invite_error_schema1_exception.rb', line 48

def unbox(hash)
  return nil unless hash

  @callstack = hash.key?('callstack') ? hash['callstack'] : SKIP
  @error = hash.key?('error') ? hash['error'] : SKIP
  # Parameter is an array, so we need to iterate through it
  @errors = nil
  unless hash['errors'].nil?
    @errors = []
    hash['errors'].each do |structure|
      @errors << (ErrorsIsReturnedWhenAnErrorAssociatesAnUser.from_hash(structure) if structure)
    end
  end

  @errors = SKIP unless hash.key?('errors')
  @needed = hash.key?('needed') ? hash['needed'] : SKIP
  @provided = hash.key?('provided') ? hash['provided'] : SKIP
end