Module: Vox::HTTP::Routes::Gateway

Defined in:

lib/vox/http/routes/gateway.rb

Overview

Mixin for gateway routes, used for retriving information about connecting to the gateway.

Instance Method Summary

• #get_gateway ⇒ Hash<:url, String>

  Fetch the URL to use for a gateway connection.

• #get_gateway_bot ⇒ Hash{ :url => String, :shards => Integer, :session_start_limit => Hash<Symbol, Integer>}

  Fetch the URL to use for a gateway connection, with additional sharding information.

Instance Method Details

#get_gateway ⇒ Hash<:url, String>

Fetch the URL to use for a gateway connection.

Returns:

• (Hash<:url, String>) —

  An object with one key ‘url` that maps to the URL for connecting to the gateway.

View On Discord's Docs:

• discord.com/developers/docs/topics/gateway#get-gateway

# File 'lib/vox/http/routes/gateway.rb', line 17

def get_gateway
  request(Route.new(:GET, '/gateway'))
end

#get_gateway_bot ⇒ Hash{ :url => String, :shards => Integer, :session_start_limit => Hash<Symbol, Integer>}

Fetch the URL to use for a gateway connection, with additional sharding information.

Returns:

• (Hash{ :url => String, :shards => Integer, :session_start_limit => Hash<Symbol, Integer>}) —

  An object that includes the URL to connect to the gateway with, the recommended number of shards, as well as a [session start limit](discord.com/developers/docs/topics/gateway#session-start-limit-object-session-start-limit-structure) object.

View On Discord's Docs:

• discord.com/developers/docs/topics/gateway#get-gateway-bot

# File 'lib/vox/http/routes/gateway.rb', line 27

def get_gateway_bot
  request(Route.new(:GET, '/gateway/bot'))
end