| Qore DiscordDataProvider Module Reference 2.0

Loading...
Searching...
No Matches
DiscordDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
24
26 namespace DiscordDataProvider {
28 const AppName = "Discord";
29
31 class DiscordDataProvider : public DiscordDataProviderBase {
32
33 public:
35 static hash<DataProviderInfo> ProviderInfo = <DataProviderInfo>{
36 "type": "DiscordDataProvider",
37 "supports_children": True,
38 "constructor_options": ConstructorOptions,
39 "children_can_support_apis": True,
40 };
41
43 const ConstructorOptions = ...;
44
45
46 protected:
47 static hash<string, code> dynamic_children;
48
49 const ChildMap = ...;
50
51
52 public:
53
55 constructor(*hash<auto> options);
56
57
59 constructor(DiscordRestClient rest) ;
60
61
63 constructor(DiscordRestConnection conn) ;
64
65
67
70 static registerChild(string name, code generator);
71
73 static DiscordRestClient::DiscordRestClient getRestConnection(*hash<auto> options);
74
76 string getName();
77
78
80 *string getDesc();
81
82
84 *list<hash<DataProvider::DataProviderSummaryInfo>> getChildProviderSummaryInfo();
85
86
88
90 protected:
91 *list<string> getChildProviderNamesImpl();
92 public:
93
94
96
100 protected:
101 *DataProvider::AbstractDataProvider getChildProviderImpl(string name);
102 public:
103
104
106 protected:
107 hash<DataProvider::DataProviderInfo> getStaticInfoImpl();
108 public:
109
110};
111};
DiscordDataProvider::DiscordDataProviderBase
The Discord data provider base class.
Definition DiscordDataProviderBase.qc.dox.h:28
DiscordDataProvider::DiscordDataProviderBase::rest
*DiscordRestClient rest
The REST client object for API calls.
Definition DiscordDataProviderBase.qc.dox.h:43
DiscordDataProvider::DiscordDataProviderBase::conn
*DiscordRestConnection conn
The connection object used to create the REST client.
Definition DiscordDataProviderBase.qc.dox.h:40
DiscordDataProvider::DiscordDataProvider::constructor
constructor(*hash< auto > options)
Creates the object from constructor options.
DiscordDataProvider::DiscordDataProvider::constructor
constructor(DiscordRestClient rest)
Creates the object from a DiscordRestClient.
DiscordDataProvider::DiscordDataProvider::getStaticInfoImpl
hash< DataProvider::DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
DiscordDataProvider::DiscordDataProvider::getChildProviderSummaryInfo
*list< hash< DataProvider::DataProviderSummaryInfo > > getChildProviderSummaryInfo()
Return data provider summary info.
DiscordDataProvider::DiscordDataProvider::getRestConnection
static DiscordRestClient::DiscordRestClient getRestConnection(*hash< auto > options)
Returns a DiscordRestClient connection from the options.
DiscordDataProvider::DiscordDataProvider::registerChild
static registerChild(string name, code generator)
Registers a child data provider.
DiscordDataProvider::DiscordDataProvider::getDesc
*string getDesc()
Returns the data provider description.
DiscordDataProvider::DiscordDataProvider::constructor
constructor(DiscordRestConnection conn)
Creates the object from a DiscordRestClient.
DiscordDataProvider::DiscordDataProvider::getName
string getName()
Returns the data provider name.
DiscordDataProvider::DiscordDataProvider::ProviderInfo
static hash< DataProviderInfo > ProviderInfo
Provider info.
Definition DiscordDataProvider.qc.dox.h:35
DiscordDataProvider::DiscordDataProvider::getChildProviderImpl
*DataProvider::AbstractDataProvider getChildProviderImpl(string name)
Returns the given child provider or NOTHING if the given child is unknown.
DiscordDataProvider::DiscordDataProvider::getChildProviderNamesImpl
*list< string > getChildProviderNamesImpl()
Returns a list of child data provider names, if any.
DiscordDataProvider::DiscordDataProvider::ConstructorOptions
const ConstructorOptions
Constructor options.
Definition DiscordDataProvider.qc.dox.h:43
DiscordDataProvider
Qore DiscordDataProvider module definition.
Definition DiscordDataProvider.qc.dox.h:26
DiscordDataProvider::AppName
const AppName
Discord application name.
Definition DiscordDataProvider.qc.dox.h:28