Class: LibDiscord::Response

Inherits:

Struct

• Object
• Struct
• LibDiscord::Response

Defined in:

lib/lib_discord/client.rb

Overview

A Response is returned from any Client public instance method call in which the HTTP request sent to Discord receives a response.

Instance Attribute Summary

• #body ⇒ String readonly

  Raw HTTP response body.

• #code ⇒ String readonly

  HTTP response code.

• #message ⇒ String readonly

  HTTP response message.

• #parsed ⇒ Object^? readonly

  Object representation of the HTTP response body parsed with JSON.parse if the HTTP response’s content-type is application/json, nil otherwise.

• #success? ⇒ Boolean readonly

  true if the HTTP response code is 2xx, false otherwise.

Instance Attribute Details

#body ⇒ String (readonly)

Returns raw HTTP response body.

Returns:

• (String) —

  raw HTTP response body.

# File 'lib/lib_discord/client.rb', line 2728

Response = Struct.new(
  :success?,
  :body,
  :parsed,
  :code,
  :message,
  keyword_init: true
)

#code ⇒ String (readonly)

Returns HTTP response code.

Returns:

• (String) —

  HTTP response code.

# File 'lib/lib_discord/client.rb', line 2728

Response = Struct.new(
  :success?,
  :body,
  :parsed,
  :code,
  :message,
  keyword_init: true
)

#message ⇒ String (readonly)

Returns HTTP response message.

Returns:

• (String) —

  HTTP response message.

See Also:

• Net::HTTPResponse

# File 'lib/lib_discord/client.rb', line 2728

Response = Struct.new(
  :success?,
  :body,
  :parsed,
  :code,
  :message,
  keyword_init: true
)

#parsed ⇒ Object^? (readonly)

Returns object representation of the HTTP response body parsed with JSON.parse if the HTTP response’s content-type is application/json, nil otherwise.

Returns:

• (Object, nil) —

  object representation of the HTTP response body parsed with JSON.parse if the HTTP response’s content-type is application/json, nil otherwise.

See Also:

• JSON#parse

# File 'lib/lib_discord/client.rb', line 2728

Response = Struct.new(
  :success?,
  :body,
  :parsed,
  :code,
  :message,
  keyword_init: true
)

#success? ⇒ Boolean (readonly)

Returns true if the HTTP response code is 2xx, false otherwise.

Returns:

• (Boolean) —

  true if the HTTP response code is 2xx, false otherwise.

# File 'lib/lib_discord/client.rb', line 2728

Response = Struct.new(
  :success?,
  :body,
  :parsed,
  :code,
  :message,
  keyword_init: true
)