| Qore DiscordDataProvider Module Reference 2.0

Loading...
Searching...
No Matches
DiscordGuildsByNameDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
24
26 namespace DiscordDataProvider {
28 class DiscordGuildsByNameDataProvider : public DiscordDataProviderBase {
29
30 public:
32 static hash<DataProviderInfo> ProviderInfo = <DataProviderInfo>{
33 "name": "guilds-by-name",
34 "desc": "Discord guilds data provider; parent provider for REST APIs related to specific Discord "
35 "guilds indexed by name",
36 "type": "DiscordGuildsByNameDataProvider",
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
48 protected:
50 hash<string, hash<auto>> guilds;
51
53 Qore::Thread::Mutex lck();
54
55 public:
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
80 protected:
81 *list<string> getChildProviderNamesImpl();
82 public:
83
84
86
90 protected:
91 *DiscordDataProviderBase getChildProviderImpl(string name);
92 public:
93
94
96 hash<DataProvider::DataProviderInfo> getStaticInfoImpl();
97
98
100 protected:
101 hash<string, hash<auto>> getAllGuilds();
102 public:
103
104};
105};
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::DiscordDataProvider::ConstructorOptions
const ConstructorOptions
Constructor options.
Definition DiscordDataProvider.qc.dox.h:43
DiscordDataProvider::DiscordGuildsByNameDataProvider
The parent class for REST APIs related to specific Discord guilds.
Definition DiscordGuildsByNameDataProvider.qc.dox.h:28
DiscordDataProvider::DiscordGuildsByNameDataProvider::constructor
constructor(DiscordRestClient::DiscordRestClient rest)
Creates the object from a REST connection.
DiscordDataProvider::DiscordGuildsByNameDataProvider::getAllGuilds
hash< string, hash< auto > > getAllGuilds()
Returns access info for all tables.
DiscordDataProvider::DiscordGuildsByNameDataProvider::getDesc
*string getDesc()
Returns the data provider description.
DiscordDataProvider::DiscordGuildsByNameDataProvider::constructor
constructor(*hash< auto > options)
Creates the object from constructor options.
DiscordDataProvider::DiscordGuildsByNameDataProvider::getChildProviderImpl
*DiscordDataProviderBase getChildProviderImpl(string name)
Returns the given child provider or NOTHING if the given child is unknown.
DiscordDataProvider::DiscordGuildsByNameDataProvider::getChildProviderNamesImpl
*list< string > getChildProviderNamesImpl()
Returns a list of child data provider names, if any.
DiscordDataProvider::DiscordGuildsByNameDataProvider::getChildProviderSummaryInfo
*list< hash< DataProvider::DataProviderSummaryInfo > > getChildProviderSummaryInfo()
Return data provider summary info.
DiscordDataProvider::DiscordGuildsByNameDataProvider::getStaticInfoImpl
hash< DataProvider::DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
DiscordDataProvider::DiscordGuildsByNameDataProvider::guilds
hash< string, hash< auto > > guilds
Guild list.
Definition DiscordGuildsByNameDataProvider.qc.dox.h:50
DiscordDataProvider::DiscordGuildsByNameDataProvider::ProviderInfo
static hash< DataProviderInfo > ProviderInfo
Provider info.
Definition DiscordGuildsByNameDataProvider.qc.dox.h:32
DiscordDataProvider::DiscordGuildsByNameDataProvider::getName
string getName()
Returns the data provider name.
DiscordDataProvider::DiscordGuildsByNameDataProvider::lck
Qore::Thread::Mutex lck()
Metadata mutex.
DiscordDataProvider::DiscordGuildsByNameDataProvider::ProviderSummaryInfo
static hash< DataProviderSummaryInfo > ProviderSummaryInfo
Provider summary info.
Definition DiscordGuildsByNameDataProvider.qc.dox.h:44
Qore::Thread::Mutex
DiscordDataProvider
Qore DiscordDataProvider module definition.
Definition DiscordDataProvider.qc.dox.h:26