Loading...
Searching...
No Matches
DataProviderActionCatalog.qc.dox.h
// -*- mode: c++; indent-tabs-mode: nil -*-
namespace DataProvider {
public struct DataProviderAppInfo {
string name;
string display_name;
string short_desc;
string desc;
string legal;
*string scheme;
data logo;
string logo_file_name;
string logo_mime_type;
bool supports_events = False;
bool supports_apis = False;
bool supports_messages = False;
bool supports_find = False;
bool supports_find_single = False;
bool supports_create = False;
bool supports_upsert = False;
bool supports_update = False;
bool supports_delete = False;
bool dynamic = False;
bool hidden = False;
*hash<auto> info;
};
const DPAT_EVENT = 1;
const DPAT_API = 2;
const DPAT_SEND_MESSAGE = 3;
const DPAT_FIND = 4;
const DPAT_FIND_SINGLE = 5;
const DPAT_CREATE = 6;
const DPAT_UPSERT = 7;
const DPAT_UPDATE = 8;
const DPAT_DELETE = 9;
const ActionCodeFlagMap = ...;
const AppActionFlags = ActionCodeFlagMap.values();
const ActionAttrMap = ...;
const ActionNameMap = ...;
public struct ActionOptionInfo {
AbstractDataProviderType type;
string display_name;
string short_desc;
string desc;
bool required;
*list<string> required_groups;
auto default_value;
bool sensitive;
bool multiselect;
*softlist<hash<AllowedValueInfo>> allowed_values;
bool allowed_values_creatable;
*softlist<hash<AllowedValueInfo>> element_allowed_values;
bool element_allowed_values_creatable;
auto example_value;
*softlist<softstring> depends_on;
*string ref_data;
*string element_ref_data;
*string default_ref_data;
*string dynamic_type;
bool preselected;
bool readonly;
bool disabled;
*string loc;
bool structural_determinate;
*softlist<softstring> on_change;
};
public struct DataProviderPathVarInfo {
string display_name;
string short_desc;
string desc;
*string example_value;
};
public struct DataProviderActionInfo {
string app;
string action;
*string subtype;
string path;
*hash<string, hash<DataProviderPathVarInfo>> path_vars;
string display_name;
string short_desc;
string desc;
int action_code;
*string action_val;
*string cls;
*hash<auto> where_add;
*hash<auto> options_add;
*hash<auto> set_add;
*hash<string, hash<ActionOptionInfo>> options;
bool data_dependent_options = False;
*AbstractDataProviderType output_type;
bool has_dynamic_options;
*code get_output_type;
*code get_dynamic_options;
};
class DataProviderActionCatalog {
public:
const RequiredAppKeys = ...;
const RequiredActionKeys = ...;
protected:
static Mutex lck();
static hash<string, hash<DataProviderAppInfo>> appcache;
static hash<string, hash<DataProviderActionInfo>> top_actionmap;
static hash<string, hash<string, hash<DataProviderActionInfo>>> app_actionmap;
static hash<string, list<hash<DataProviderActionInfo>>> smap;
static hash<string, hash<string, bool>> resolve_output_types;
static hash<string, code> initmap;
static hash<string, hash<string, code>> initactionmap;
const DefaultDescription = "";
public:
static registerPendingApp(string app, code init);
static registerPendingAppAction(string app, string action, code init);
static registerApp(hash<DataProviderAppInfo> app);
static *hash<DataProviderAppInfo> deregisterDynamicApp(string name);
static registerAction(hash<DataProviderActionInfo> action);
static *int checkName(string name);
static int compareActions(hash<DataProviderActionInfo> act0, hash<DataProviderActionInfo> act1);
static int compareOptions(*hash<string, hash<ActionOptionInfo>> opt0, *hash<string, hash<ActionOptionInfo>> opt1);
static int compareBaseTypes(*Type t0, *Type t1);
static *list<hash<DataProviderAppInfo>> getAllAppsNoInit();
static *list<hash<DataProviderAppInfo>> getAllApps();
static *hash<DataProviderAppInfo> getApp(string app);
static hash<DataProviderAppInfo> getAppEx(string app);
static *list<hash<DataProviderAppInfo>> searchAppRegex(string regex_pattern, int regex_options = RE_Caseless);
static *list<hash<DataProviderAppInfo>> searchAppSubstr(string substr, bool ignore_case = True);
static *list<hash<DataProviderActionInfo>> getActionsForScheme(string scheme);
static *hash<string, hash<DataProviderActionInfo>> getActionHash(string app);
static *hash<string, hash<DataProviderActionInfo>> getActionHashEx(string app);
static *list<hash<DataProviderActionInfo>> getActions(string app);
static list<hash<DataProviderActionInfo>> getActionsEx(string app);
static *list<hash<DataProviderActionInfo>> getAllActions();
static *hash<DataProviderActionInfo> getAppAction(string app, string action);
static hash<DataProviderActionInfo> getAppActionEx(string app, string action);
static AbstractDataProvider getDataProviderForAction(hash<DataProviderActionInfo> action, *reference<hash<auto>> options);
static *list<hash<DataProviderActionInfo>> searchAppActionRegex(string app, string regex_pattern, int regex_options = RE_Caseless);
static *list<hash<DataProviderActionInfo>> searchAppActionSubstr(string app, string substr, bool ignore_case = True);
static *list<hash<DataProviderActionInfo>> searchAppActionRegexEx(string app, string regex_pattern, int regex_options = RE_Caseless);
static *list<hash<DataProviderActionInfo>> searchAppActionSubstrEx(string app, string substr, bool ignore_case = True);
static *list<hash<DataProviderActionInfo>> searchActionRegex(string regex_pattern, int regex_options = RE_Caseless);
static *list<hash<DataProviderActionInfo>> searchActionSubstr(string substr, bool ignore_case = True);
static hash<string, hash<ActionOptionInfo>> getActionOptionFromFields(hash<auto> fields, *hash<auto> additional_fields);
static hash<DataProviderActionInfo> checkAppActionOptions(string app, string action);
protected:
static string normalizePath(string path);
public:
protected:
static resolveOutputTypes();
public:
private:
static *bool deregisterApp(string name);
public:
private:
static *bool deregisterAppIntern(string name);
public:
protected:
static doInit(code init);
public:
};
};
DataProvider::AbstractDataProvider
The AbstractDataProvider class.
Definition AbstractDataProvider.qc.dox.h:917
DataProvider::AbstractDataProviderType
describes a data type
Definition AbstractDataProviderType.qc.dox.h:139
DataProvider::DataProviderActionCatalog
DataProvider action and application catalog class.
Definition DataProviderActionCatalog.qc.dox.h:372
DataProvider::DataProviderActionCatalog::app_actionmap
static hash< string, hash< string, hash< DataProviderActionInfo > > > app_actionmap
Action cache, the key is the application key, the second key is the action string.
Definition DataProviderActionCatalog.qc.dox.h:394
DataProvider::DataProviderActionCatalog::registerApp
static registerApp(hash< DataProviderAppInfo > app)
Registers a data provider application.
DataProvider::DataProviderActionCatalog::DefaultDescription
const DefaultDescription
Default description.
Definition DataProviderActionCatalog.qc.dox.h:409
DataProvider::DataProviderActionCatalog::getActionHash
static *hash< string, hash< DataProviderActionInfo > > getActionHash(string app)
Returns a hash of all actions for the given application.
DataProvider::DataProviderActionCatalog::normalizePath
static string normalizePath(string path)
Returns a normalized path to ensure that comparisons always work.
DataProvider::DataProviderActionCatalog::searchAppActionSubstr
static *list< hash< DataProviderActionInfo > > searchAppActionSubstr(string app, string substr, bool ignore_case=True)
Searches for application actions whose descriptions match a substring.
DataProvider::DataProviderActionCatalog::checkName
static *int checkName(string name)
Checks for a valid name.
DataProvider::DataProviderActionCatalog::registerPendingAppAction
static registerPendingAppAction(string app, string action, code init)
Registers an app action for deferred initialization / initialization on demand.
DataProvider::DataProviderActionCatalog::getAppEx
static hash< DataProviderAppInfo > getAppEx(string app)
Returns the application definition for the given application name.
DataProvider::DataProviderActionCatalog::resolve_output_types
static hash< string, hash< string, bool > > resolve_output_types
Set of actions requiring output type resolution; app -> action -> True.
Definition DataProviderActionCatalog.qc.dox.h:400
DataProvider::DataProviderActionCatalog::compareBaseTypes
static int compareBaseTypes(*Type t0, *Type t1)
Compares two types for equality.
DataProvider::DataProviderActionCatalog::getAllApps
static *list< hash< DataProviderAppInfo > > getAllApps()
Returns all applications in the cache.
DataProvider::DataProviderActionCatalog::deregisterDynamicApp
static *hash< DataProviderAppInfo > deregisterDynamicApp(string name)
Removes a dynamic data provider application.
DataProvider::DataProviderActionCatalog::searchAppSubstr
static *list< hash< DataProviderAppInfo > > searchAppSubstr(string substr, bool ignore_case=True)
Searches for applications whose names or descriptions match a substring.
DataProvider::DataProviderActionCatalog::checkAppActionOptions
static hash< DataProviderActionInfo > checkAppActionOptions(string app, string action)
Check that the action has had its options initialized if necessary and return the possibly updated ac...
DataProvider::DataProviderActionCatalog::registerPendingApp
static registerPendingApp(string app, code init)
Registers an app for deferred initialization / initialization on demand.
DataProvider::DataProviderActionCatalog::initactionmap
static hash< string, hash< string, code > > initactionmap
Pending application action init handler map: app -> action -> init handler.
Definition DataProviderActionCatalog.qc.dox.h:406
DataProvider::DataProviderActionCatalog::doInit
static doInit(code init)
Runs initialization and catches exceptions.
DataProvider::DataProviderActionCatalog::compareActions
static int compareActions(hash< DataProviderActionInfo > act0, hash< DataProviderActionInfo > act1)
Compares two actions for equality.
DataProvider::DataProviderActionCatalog::lck
static Mutex lck()
Mutex for atomic operations.
DataProvider::DataProviderActionCatalog::getDataProviderForAction
static AbstractDataProvider getDataProviderForAction(hash< DataProviderActionInfo > action, *reference< hash< auto > > options)
Returns a data provider option for the given action and options.
DataProvider::DataProviderActionCatalog::searchAppActionSubstrEx
static *list< hash< DataProviderActionInfo > > searchAppActionSubstrEx(string app, string substr, bool ignore_case=True)
Searches for application actions whose descriptions match a substring.
DataProvider::DataProviderActionCatalog::searchAppRegex
static *list< hash< DataProviderAppInfo > > searchAppRegex(string regex_pattern, int regex_options=RE_Caseless)
Searches for applications whose names or descriptions match a regular expression pattern.
DataProvider::DataProviderActionCatalog::RequiredAppKeys
const RequiredAppKeys
Required application key set.
Definition DataProviderActionCatalog.qc.dox.h:376
DataProvider::DataProviderActionCatalog::getAppActionEx
static hash< DataProviderActionInfo > getAppActionEx(string app, string action)
Returns the application definition for the given application name.
DataProvider::DataProviderActionCatalog::getApp
static *hash< DataProviderAppInfo > getApp(string app)
Returns the application definition for the given application name.
DataProvider::DataProviderActionCatalog::searchAppActionRegexEx
static *list< hash< DataProviderActionInfo > > searchAppActionRegexEx(string app, string regex_pattern, int regex_options=RE_Caseless)
Searches for application actions whose descriptions match a regular expression pattern.
DataProvider::DataProviderActionCatalog::getActionsForScheme
static *list< hash< DataProviderActionInfo > > getActionsForScheme(string scheme)
Returns all actions for a particular connection scheme.
DataProvider::DataProviderActionCatalog::initmap
static hash< string, code > initmap
Pending application init handler map: app -> init handler.
Definition DataProviderActionCatalog.qc.dox.h:403
DataProvider::DataProviderActionCatalog::getActionOptionFromFields
static hash< string, hash< ActionOptionInfo > > getActionOptionFromFields(hash< auto > fields, *hash< auto > additional_fields)
Converts field definitions into option descriptions.
DataProvider::DataProviderActionCatalog::getAppAction
static *hash< DataProviderActionInfo > getAppAction(string app, string action)
Returns the action definition for the given application and action.
DataProvider::DataProviderActionCatalog::searchActionSubstr
static *list< hash< DataProviderActionInfo > > searchActionSubstr(string substr, bool ignore_case=True)
Searches for actions whose descriptions match a substring.
DataProvider::DataProviderActionCatalog::top_actionmap
static hash< string, hash< DataProviderActionInfo > > top_actionmap
Master action cache, the key <app>/<action>
Definition DataProviderActionCatalog.qc.dox.h:391
DataProvider::DataProviderActionCatalog::smap
static hash< string, list< hash< DataProviderActionInfo > > > smap
Scheme map; keys are connection schemes.
Definition DataProviderActionCatalog.qc.dox.h:397
DataProvider::DataProviderActionCatalog::compareOptions
static int compareOptions(*hash< string, hash< ActionOptionInfo > > opt0, *hash< string, hash< ActionOptionInfo > > opt1)
Compares two option hashes for equality.
DataProvider::DataProviderActionCatalog::getActions
static *list< hash< DataProviderActionInfo > > getActions(string app)
Returns all actions for the given application.
DataProvider::DataProviderActionCatalog::searchAppActionRegex
static *list< hash< DataProviderActionInfo > > searchAppActionRegex(string app, string regex_pattern, int regex_options=RE_Caseless)
Searches for application actions whose descriptions match a regular expression pattern.
DataProvider::DataProviderActionCatalog::deregisterAppIntern
static *bool deregisterAppIntern(string name)
Deregisters an app and all its actions if an exception occurs during the other module's initializatio...
DataProvider::DataProviderActionCatalog::getAllActions
static *list< hash< DataProviderActionInfo > > getAllActions()
Returns all actions in the cache.
DataProvider::DataProviderActionCatalog::getAllAppsNoInit
static *list< hash< DataProviderAppInfo > > getAllAppsNoInit()
Returns all applications in the cache without initializing actions.
DataProvider::DataProviderActionCatalog::searchActionRegex
static *list< hash< DataProviderActionInfo > > searchActionRegex(string regex_pattern, int regex_options=RE_Caseless)
Searches for actions whose descriptions match a regular expression pattern.
DataProvider::DataProviderActionCatalog::deregisterApp
static *bool deregisterApp(string name)
Deregisters an app and all its actions if an exception occurs during the other module's initializatio...
DataProvider::DataProviderActionCatalog::RequiredActionKeys
const RequiredActionKeys
Required action key set (without action_code and path_vars, which are checked separately)
Definition DataProviderActionCatalog.qc.dox.h:380
DataProvider::DataProviderActionCatalog::appcache
static hash< string, hash< DataProviderAppInfo > > appcache
Top-level master application cache keyed by application name.
Definition DataProviderActionCatalog.qc.dox.h:388
DataProvider::DataProviderActionCatalog::getActionsEx
static list< hash< DataProviderActionInfo > > getActionsEx(string app)
Returns all actions for the given application; throws an exception if the app is not registered.
DataProvider::DataProviderActionCatalog::resolveOutputTypes
static resolveOutputTypes()
Resolves output fypes in actions.
DataProvider::DataProviderActionCatalog::getActionHashEx
static *hash< string, hash< DataProviderActionInfo > > getActionHashEx(string app)
Returns a hash of all actions for the given application.
DataProvider::DataProviderActionCatalog::registerAction
static registerAction(hash< DataProviderActionInfo > action)
Registers a data provider action.
DataProvider::DPAT_API
const DPAT_API
Data Provider Action Type: make an API call.
Definition DataProviderActionCatalog.qc.dox.h:136
DataProvider::DPAT_FIND_SINGLE
const DPAT_FIND_SINGLE
Data Provider Action Type: find a single record.
Definition DataProviderActionCatalog.qc.dox.h:145
DataProvider::DPAT_SEND_MESSAGE
const DPAT_SEND_MESSAGE
Data Provider Action Type: send a message.
Definition DataProviderActionCatalog.qc.dox.h:139
DataProvider::DPAT_EVENT
const DPAT_EVENT
Definition DataProviderActionCatalog.qc.dox.h:133
DataProvider::DPAT_UPDATE
const DPAT_UPDATE
Data Provider Action Type: update a record.
Definition DataProviderActionCatalog.qc.dox.h:154
DataProvider::DPAT_DELETE
const DPAT_DELETE
Data Provider Action Type: delete a record.
Definition DataProviderActionCatalog.qc.dox.h:157
DataProvider::DPAT_UPSERT
const DPAT_UPSERT
Data Provider Action Type: upsert a record.
Definition DataProviderActionCatalog.qc.dox.h:151
DataProvider::DPAT_CREATE
const DPAT_CREATE
Data Provider Action Type: create a record.
Definition DataProviderActionCatalog.qc.dox.h:148
DataProvider::DPAT_FIND
const DPAT_FIND
Data Provider Action Type: find all matching records.
Definition DataProviderActionCatalog.qc.dox.h:142
DataProvider
Qore AbstractDataField class definition.
Definition AbstractDataField.qc.dox.h:27
DataProvider::ActionNameMap
const ActionNameMap
Maps action type codes to a user-friendly name.
Definition DataProviderActionCatalog.qc.dox.h:172
DataProvider::ActionAttrMap
const ActionAttrMap
Maps action type codes to a data provider attribute string.
Definition DataProviderActionCatalog.qc.dox.h:168
DataProvider::ActionCodeFlagMap
const ActionCodeFlagMap
Maps action type codes to app action flags.
Definition DataProviderActionCatalog.qc.dox.h:161
DataProvider::AppActionFlags
const AppActionFlags
List of app action flags.
Definition DataProviderActionCatalog.qc.dox.h:165
DataProvider::ActionOptionInfo
Data provider action option definition.
Definition DataProviderActionCatalog.qc.dox.h:176
DataProvider::ActionOptionInfo::structural_determinate
bool structural_determinate
Does the value of this option determine the structure of other options?
Definition DataProviderActionCatalog.qc.dox.h:271
DataProvider::ActionOptionInfo::example_value
auto example_value
An optional example value for the option.
Definition DataProviderActionCatalog.qc.dox.h:219
DataProvider::ActionOptionInfo::element_allowed_values
*softlist< hash< AllowedValueInfo > > element_allowed_values
List of allowed values for elements of list types (enum)
Definition DataProviderActionCatalog.qc.dox.h:213
DataProvider::ActionOptionInfo::type
AbstractDataProviderType type
Data type of the option.
Definition DataProviderActionCatalog.qc.dox.h:178
DataProvider::ActionOptionInfo::readonly
bool readonly
Is this option read-only?
Definition DataProviderActionCatalog.qc.dox.h:256
DataProvider::ActionOptionInfo::depends_on
*softlist< softstring > depends_on
A list of other options that must be set before this option can be chosen.
Definition DataProviderActionCatalog.qc.dox.h:226
DataProvider::ActionOptionInfo::default_ref_data
*string default_ref_data
A tag allowing the default value to be returned dynamically as reference data.
Definition DataProviderActionCatalog.qc.dox.h:247
DataProvider::ActionOptionInfo::allowed_values
*softlist< hash< AllowedValueInfo > > allowed_values
List of allowed values (enum)
Definition DataProviderActionCatalog.qc.dox.h:207
DataProvider::ActionOptionInfo::loc
*string loc
Option location for record-based data providers and data providers provided by a class.
Definition DataProviderActionCatalog.qc.dox.h:268
DataProvider::ActionOptionInfo::on_change
*softlist< softstring > on_change
Any information about how to react to changes.
Definition DataProviderActionCatalog.qc.dox.h:274
DataProvider::ActionOptionInfo::required
bool required
Is the option required or not?
Definition DataProviderActionCatalog.qc.dox.h:190
DataProvider::ActionOptionInfo::disabled
bool disabled
Is this option disabled?
Definition DataProviderActionCatalog.qc.dox.h:259
DataProvider::ActionOptionInfo::default_value
auto default_value
Any default value for the option.
Definition DataProviderActionCatalog.qc.dox.h:198
DataProvider::ActionOptionInfo::dynamic_type
*string dynamic_type
A tag allowing the type of the option to be retrieved at runtime.
Definition DataProviderActionCatalog.qc.dox.h:250
DataProvider::ActionOptionInfo::short_desc
string short_desc
Short description of the option in plain text.
Definition DataProviderActionCatalog.qc.dox.h:184
DataProvider::ActionOptionInfo::required_groups
*list< string > required_groups
Is the option part of a required group?
Definition DataProviderActionCatalog.qc.dox.h:195
DataProvider::ActionOptionInfo::preselected
bool preselected
If the option should be preselected.
Definition DataProviderActionCatalog.qc.dox.h:253
DataProvider::ActionOptionInfo::desc
string desc
Description of the option with markdown rendering.
Definition DataProviderActionCatalog.qc.dox.h:187
DataProvider::ActionOptionInfo::allowed_values_creatable
bool allowed_values_creatable
Does the option accept values not defined in allowed_values too?
Definition DataProviderActionCatalog.qc.dox.h:210
DataProvider::ActionOptionInfo::element_ref_data
*string element_ref_data
A tag allowing element allowed values to be returned dynamically as element reference data.
Definition DataProviderActionCatalog.qc.dox.h:240
DataProvider::ActionOptionInfo::sensitive
bool sensitive
Is the option value sensitive?
Definition DataProviderActionCatalog.qc.dox.h:201
DataProvider::ActionOptionInfo::ref_data
*string ref_data
A tag allowing allowed values to be returned dynamically as reference data.
Definition DataProviderActionCatalog.qc.dox.h:233
DataProvider::ActionOptionInfo::multiselect
bool multiselect
Are allowed values elements of the list's element type that indicate what values the list can have?
Definition DataProviderActionCatalog.qc.dox.h:204
DataProvider::ActionOptionInfo::display_name
string display_name
Display name of the option.
Definition DataProviderActionCatalog.qc.dox.h:181
DataProvider::ActionOptionInfo::element_allowed_values_creatable
bool element_allowed_values_creatable
Does the option accept values not defined in element_allowed_values too?
Definition DataProviderActionCatalog.qc.dox.h:216
DataProvider::DataProviderActionInfo
DataProvider action definition.
Definition DataProviderActionCatalog.qc.dox.h:293
DataProvider::DataProviderActionInfo::short_desc
string short_desc
Action short description, plain text formatting.
Definition DataProviderActionCatalog.qc.dox.h:319
DataProvider::DataProviderActionInfo::data_dependent_options
bool data_dependent_options
Do options depend on the data for the call?
Definition DataProviderActionCatalog.qc.dox.h:356
DataProvider::DataProviderActionInfo::action_val
*string action_val
Message or event type.
Definition DataProviderActionCatalog.qc.dox.h:334
DataProvider::DataProviderActionInfo::get_output_type
*code get_output_type
In case the output type is expensive to acquire or requires I/O, this closure can be used to set it.
Definition DataProviderActionCatalog.qc.dox.h:365
DataProvider::DataProviderActionInfo::set_add
*hash< auto > set_add
Values to add to any "set" argument for record-based actions.
Definition DataProviderActionCatalog.qc.dox.h:350
DataProvider::DataProviderActionInfo::path
string path
Data provider path to action.
Definition DataProviderActionCatalog.qc.dox.h:308
DataProvider::DataProviderActionInfo::display_name
string display_name
The display name for the action.
Definition DataProviderActionCatalog.qc.dox.h:316
DataProvider::DataProviderActionInfo::output_type
*AbstractDataProviderType output_type
Output type for the action.
Definition DataProviderActionCatalog.qc.dox.h:359
DataProvider::DataProviderActionInfo::action_code
int action_code
Action type code.
Definition DataProviderActionCatalog.qc.dox.h:327
DataProvider::DataProviderActionInfo::app
string app
Name of the application that provides the action.
Definition DataProviderActionCatalog.qc.dox.h:295
DataProvider::DataProviderActionInfo::where_add
*hash< auto > where_add
Values to add to any "where" argument for record-based actions.
Definition DataProviderActionCatalog.qc.dox.h:344
DataProvider::DataProviderActionInfo::has_dynamic_options
bool has_dynamic_options
Does the action support dynamic options?
Definition DataProviderActionCatalog.qc.dox.h:362
DataProvider::DataProviderActionInfo::subtype
*string subtype
Any data provider subtype.
Definition DataProviderActionCatalog.qc.dox.h:303
DataProvider::DataProviderActionInfo::desc
string desc
Action long description, markdown formatting.
Definition DataProviderActionCatalog.qc.dox.h:322
DataProvider::DataProviderActionInfo::path_vars
*hash< string, hash< DataProviderPathVarInfo > > path_vars
Description of any path variables.
Definition DataProviderActionCatalog.qc.dox.h:313
DataProvider::DataProviderActionInfo::options_add
*hash< auto > options_add
Values to add to any "options" argument for record-based actions.
Definition DataProviderActionCatalog.qc.dox.h:347
DataProvider::DataProviderActionInfo::options
*hash< string, hash< ActionOptionInfo > > options
Options that can be provided without a data provider.
Definition DataProviderActionCatalog.qc.dox.h:353
DataProvider::DataProviderActionInfo::cls
*string cls
The DataProvider class.
Definition DataProviderActionCatalog.qc.dox.h:341
DataProvider::DataProviderActionInfo::get_dynamic_options
*code get_dynamic_options
For the case when options should be generated dynamically.
Definition DataProviderActionCatalog.qc.dox.h:368
DataProvider::DataProviderActionInfo::action
string action
The unique name for the action; unique in the application.
Definition DataProviderActionCatalog.qc.dox.h:298
DataProvider::DataProviderAppInfo
Application information hash.
Definition DataProviderActionCatalog.qc.dox.h:33
DataProvider::DataProviderAppInfo::short_desc
string short_desc
A short description for the app, plain text formatting.
Definition DataProviderActionCatalog.qc.dox.h:43
DataProvider::DataProviderAppInfo::logo
data logo
The application logo.
Definition DataProviderActionCatalog.qc.dox.h:60
DataProvider::DataProviderAppInfo::supports_messages
bool supports_messages
If the apps supports message actions.
Definition DataProviderActionCatalog.qc.dox.h:85
DataProvider::DataProviderAppInfo::desc
string desc
Description of the application with markdown formatting.
Definition DataProviderActionCatalog.qc.dox.h:46
DataProvider::DataProviderAppInfo::display_name
string display_name
The display name for the application.
Definition DataProviderActionCatalog.qc.dox.h:40
DataProvider::DataProviderAppInfo::info
*hash< auto > info
User-defined info about the app.
Definition DataProviderActionCatalog.qc.dox.h:124
DataProvider::DataProviderAppInfo::dynamic
bool dynamic
Was the application added dynamically?
Definition DataProviderActionCatalog.qc.dox.h:118
DataProvider::DataProviderAppInfo::hidden
bool hidden
Should this app be hidden in the front end?
Definition DataProviderActionCatalog.qc.dox.h:121
DataProvider::DataProviderAppInfo::supports_update
bool supports_update
If the apps supports update actions.
Definition DataProviderActionCatalog.qc.dox.h:110
DataProvider::DataProviderAppInfo::logo_mime_type
string logo_mime_type
The mime type for logo.
Definition DataProviderActionCatalog.qc.dox.h:70
DataProvider::DataProviderAppInfo::scheme
*string scheme
Connection scheme for the application.
Definition DataProviderActionCatalog.qc.dox.h:55
DataProvider::DataProviderAppInfo::supports_events
bool supports_events
If the apps supports event actions.
Definition DataProviderActionCatalog.qc.dox.h:75
DataProvider::DataProviderAppInfo::name
string name
Unique application name.
Definition DataProviderActionCatalog.qc.dox.h:37
DataProvider::DataProviderAppInfo::legal
string legal
Any legal text, links, copyright notice(s), or disclaimer(s) related to the use of the app; markdown ...
Definition DataProviderActionCatalog.qc.dox.h:49
DataProvider::DataProviderAppInfo::supports_find_single
bool supports_find_single
If the apps supports find_single actions.
Definition DataProviderActionCatalog.qc.dox.h:95
DataProvider::DataProviderAppInfo::logo_file_name
string logo_file_name
The logo file name.
Definition DataProviderActionCatalog.qc.dox.h:63
DataProvider::DataProviderAppInfo::supports_upsert
bool supports_upsert
If the apps supports upsert actions.
Definition DataProviderActionCatalog.qc.dox.h:105
DataProvider::DataProviderAppInfo::supports_apis
bool supports_apis
If the apps supports API actions.
Definition DataProviderActionCatalog.qc.dox.h:80
DataProvider::DataProviderAppInfo::supports_create
bool supports_create
If the apps supports create actions.
Definition DataProviderActionCatalog.qc.dox.h:100
DataProvider::DataProviderAppInfo::supports_find
bool supports_find
If the apps supports find actions.
Definition DataProviderActionCatalog.qc.dox.h:90
DataProvider::DataProviderAppInfo::supports_delete
bool supports_delete
If the apps supports delete actions.
Definition DataProviderActionCatalog.qc.dox.h:115
DataProvider::DataProviderPathVarInfo
DataProvider path var info.
Definition DataProviderActionCatalog.qc.dox.h:278
DataProvider::DataProviderPathVarInfo::desc
string desc
Action long description, markdown formatting.
Definition DataProviderActionCatalog.qc.dox.h:286
DataProvider::DataProviderPathVarInfo::display_name
string display_name
The display name for the action.
Definition DataProviderActionCatalog.qc.dox.h:280
DataProvider::DataProviderPathVarInfo::example_value
*string example_value
An optional example value for the option.
Definition DataProviderActionCatalog.qc.dox.h:289
DataProvider::DataProviderPathVarInfo::short_desc
string short_desc
Action short description, plain text formatting.
Definition DataProviderActionCatalog.qc.dox.h:283