Qore DiscordDataProvider Module Reference 2.0
Loading...
Searching...
No Matches
DiscordGuildsDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
26namespace DiscordDataProvider {
29
30public:
32 static hash<DataProviderInfo> ProviderInfo = <DataProviderInfo>{
33 "name": "guilds",
34 "desc": "Discord guilds data provider; parent provider for REST APIs related to specific Discord "
35 "guilds",
36 "type": "DiscordGuildsDataProvider",
37 "constructor_options": DiscordDataProvider::ConstructorOptions,
38 "supports_children": True,
39 "children_can_support_apis": True,
40 "children_identical": True,
41 };
42
44 static hash<DataProviderSummaryInfo> ProviderSummaryInfo = cast<hash<DataProviderSummaryInfo>>(ProviderInfo{
45 AbstractDataProvider::DataProviderSummaryInfoKeys
46 });
47
48protected:
50 hash<string, hash<auto>> guilds;
51
53 Qore::Thread::Mutex lck();
54
55public:
56
58 constructor(*hash<auto> options);
59
60
62 constructor(DiscordRestClient::DiscordRestClient rest) ;
63
64
66 string getName();
67
68
70 *string getDesc();
71
72
74 *list<hash<DataProvider::DataProviderSummaryInfo>> getChildProviderSummaryInfo();
75
76
78
80protected:
82public:
83
84
86
90protected:
92public:
93
94
96protected:
97 hash<DataProvider::DataProviderInfo> getStaticInfoImpl();
98public:
99
100
102protected:
103 hash<string, hash<auto>> getAllGuilds();
104public:
105
106};
107};
The Discord data provider base class.
Definition DiscordDataProviderBase.qc.dox.h:28
*DiscordRestClient rest
The REST client object for API calls.
Definition DiscordDataProviderBase.qc.dox.h:43
const ConstructorOptions
Constructor options.
Definition DiscordDataProvider.qc.dox.h:43
The parent class for REST APIs related to specific Discord guilds.
Definition DiscordGuildsDataProvider.qc.dox.h:28
*list< hash< DataProvider::DataProviderSummaryInfo > > getChildProviderSummaryInfo()
Return data provider summary info.
Qore::Thread::Mutex lck()
Metadata mutex.
static hash< DataProviderInfo > ProviderInfo
Provider info.
Definition DiscordGuildsDataProvider.qc.dox.h:32
hash< string, hash< auto > > guilds
Guild list.
Definition DiscordGuildsDataProvider.qc.dox.h:50
string getName()
Returns the data provider name.
*string getDesc()
Returns the data provider description.
static hash< DataProviderSummaryInfo > ProviderSummaryInfo
Provider summary info.
Definition DiscordGuildsDataProvider.qc.dox.h:44
constructor(DiscordRestClient::DiscordRestClient rest)
Creates the object from a REST connection.
hash< string, hash< auto > > getAllGuilds()
Returns access info for all tables.
*list< string > getChildProviderNamesImpl()
Returns a list of child data provider names, if any.
constructor(*hash< auto > options)
Creates the object from constructor options.
*DiscordDataProviderBase getChildProviderImpl(string name)
Returns the given child provider or nothing if the given child is unknown.
hash< DataProvider::DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
Qore DiscordDataProvider module definition.
Definition DiscordDataProvider.qc.dox.h:26