![]() |
Qore DiscordWebSocketClient Module Reference 1.0
|
class for Discord websocket connections; returns an object of class DiscordWebSocketClient More...
Public Member Functions | |
| constructor (hash< auto > config, *hash< auto > attr) | |
| creates the DiscordWebSocketConnection connection object | |
| constructor (string name, string description, *string url, hash< auto > attributes={}, hash< auto > options={}) | |
| creates the DiscordWebSocketConnection connection object | |
| string | getType () |
returns "discordwss" | |
Static Public Member Functions | |
| static string | discoverUrl () |
| Discover the Discord gateway URL. | |
Protected Member Functions | |
| DiscordWebSocketClient | getImpl (bool connect=True, *hash< auto > rtopts) |
| returns a DiscordWebSocketClient object | |
| setRealUrl (*string url) | |
| Called by the constructor to set the real URL. | |
class for Discord websocket connections; returns an object of class DiscordWebSocketClient
Supports all the options of the WebSocketConnection class; note that the token option is required by this class and is used as the gateway token after connecting and not as an HTTP authentication token
| DiscordWebSocketClient::DiscordWebSocketConnection::constructor | ( | hash< auto > | config, |
| *hash< auto > | attr ) |
creates the DiscordWebSocketConnection connection object
| config | with the following keys:
|
| attr | optional connection attributes
|
| CONNECTION-OPTION-ERROR | missing or invalid connection option or attribute |
| DiscordWebSocketClient::DiscordWebSocketConnection::constructor | ( | string | name, |
| string | description, | ||
| *string | url, | ||
| hash< auto > | attributes = {}, | ||
| hash< auto > | options = {} ) |
creates the DiscordWebSocketConnection connection object
| name | the name of the connection |
| description | connection description |
| url | connection URL; if not provided, then the URL will be discovered automatically |
| attributes | various attributes. See below |
| options | connection options |
See AbstractConnection::constructor() for attributes and options reference.
| CONNECTION-OPTION-ERROR | missing or invalid connection option |
|
protected |
returns a DiscordWebSocketClient object
| connect | if True, then WebSocketClient::connect() is called |
| rtopts | runtime options |
|
protected |
Called by the constructor to set the real URL.
@path the new URL
sets the real WS URL for WebSocket-based connections