Qore DiscordDataProvider Module Reference 2.0
Loading...
Searching...
No Matches
DiscordDataProvider::DiscordGuildDataProvider Class Reference

The parent class for Discord guild REST APIs. More...

#include <DiscordGuildDataProvider.qc.dox.h>

Inheritance diagram for DiscordDataProvider::DiscordGuildDataProvider:
[legend]

Public Member Functions

 constructor (*hash< auto > options)
 Creates the object from constructor options.
 
 constructor (DiscordRestClient::DiscordRestClient rest, hash< auto > guild)
 Creates the object from a REST connection.
 
*list< hash< DataProvider::DataProviderSummaryInfo > > getChildProviderSummaryInfo ()
 Return data provider summary info.
 
*string getDesc ()
 Returns the data provider description.
 
string getName ()
 Returns the data provider name.
 
hash< DataProvider::DataProviderInfo > getStaticInfoImpl ()
 Returns data provider static info.
 
- Public Member Functions inherited from DiscordDataProvider::DiscordDataProviderBase
 constructor ()
 Creates the object.
 
 constructor (DiscordRestClient rest, *Logger::LoggerInterface logger)
 Creates the object.
 
 constructor (DiscordRestConnection conn, *Logger::LoggerInterface logger)
 Creates the object.
 
 setLogger (*LoggerInterface logger)
 Accepts a LoggerInterface object for logging (or clears it)
 

Static Public Member Functions

static registerChild (string pathname, Reflection::Class cls)
 Register a new child data provider for Discord guilds.
 
- Static Public Member Functions inherited from DiscordDataProvider::DiscordDataProviderBase
static threadWait (date wait_period)
 Wait for a given period of time.
 

Static Public Attributes

static hash< DataProviderInfo > ProviderInfo
 Provider info.
 
static hash< DataProviderSummaryInfo > ProviderSummaryInfo
 Provider summary info.
 

Protected Member Functions

*DiscordDataProviderBase getChildProviderImpl (string name)
 Returns the given child provider or nothing if the given child is unknown.
 
*list< string > getChildProviderNamesImpl ()
 Returns a list of child data provider names, if any.
 
- Protected Member Functions inherited from DiscordDataProvider::DiscordDataProviderBase
hash< auto > doRestCommand (string method, string path, auto body, reference< hash< auto > > info)
 Makes a REST call and returns the response; handles rate limit responses.
 
hash< auto > getGuild (string id)
 Retrieves info for the given guild; must be accessible to the calling user.
 
bool retry (hash< ExceptionInfo > ex, reference< int > retries)
 Returns True if the error indicates that the operation should be retried.
 

Static Protected Member Functions

static deregisterChild (string pathname)
 Deregister the named child data provider.
 

Protected Attributes

*hash< auto > cal
 The guild's metadata.
 
hash< auto > guild
 The guild info.
 
- Protected Attributes inherited from DiscordDataProvider::DiscordDataProviderBase
*DiscordRestConnection conn
 The connection object used to create the REST client.
 
*DiscordRestClient rest
 The REST client object for API calls.
 

Additional Inherited Members

- Public Attributes inherited from DiscordDataProvider::DiscordDataProviderBase
const MaxIoRetries = 5
 Max retries.
 
const RetrySet = ...
 IO errors for REST retries.
 

Detailed Description

The parent class for Discord guild REST APIs.

Member Function Documentation

◆ getChildProviderImpl()

*DiscordDataProviderBase DiscordDataProvider::DiscordGuildDataProvider::getChildProviderImpl ( string name)
protected

Returns the given child provider or nothing if the given child is unknown.

Returns
the given child provider or nothing if the given child is unknown
See also
getChildProviderEx()

◆ getChildProviderNamesImpl()

*list< string > DiscordDataProvider::DiscordGuildDataProvider::getChildProviderNamesImpl ( )
protected

Returns a list of child data provider names, if any.

Returns
a list of child data provider names, if any