Loading...
Searching...
No Matches
DataProvider::DataProviderAppInfo Struct Reference

Application information hash. More...

`#include <DataProviderActionCatalog.qc.dox.h>`

## Public Attributes

string | desc
| Description of the application with markdown formatting.
string | display_name
| The display name for the application.
bool | dynamic = False
| Was the application added dynamically?
bool | hidden = False
| Should this app be hidden in the front end?
*hash< auto > | info
| User-defined info about the app.
string | legal
| Any legal text, links, copyright notice(s), or disclaimer(s) related to the use of the app; markdown supported.
data | logo
| The application logo.
string | logo_file_name
| The logo file name.
string | logo_mime_type
| The mime type for `logo`.
string | name
| Unique application name.
*string | scheme
| Connection scheme for the application.
string | short_desc
| A short description for the app, plain text formatting.
bool | supports_apis = False
| If the apps supports API actions.
bool | supports_create = False
| If the apps supports create actions.
bool | supports_delete = False
| If the apps supports delete actions.
bool | supports_events = False
| If the apps supports event actions.
bool | supports_find = False
| If the apps supports find actions.
bool | supports_find_single = False
| If the apps supports find_single actions.
bool | supports_messages = False
| If the apps supports message actions.
bool | supports_update = False
| If the apps supports update actions.
bool | supports_upsert = False
| If the apps supports upsert actions.

## Detailed Description

Application information hash.

Note that action paths are relative from the data provider created from the connection and optionally the subtype

If both `scheme` and `action.cls` are missing, it implies that the data provider will be implicitly provided by the context where the action is used

## Member Data Documentation

## logo

data DataProvider::DataProviderAppInfo::logo

The application logo.

Must be an SVG or PNG; all logos must be square, and PNG must be 200x200 px

## logo_mime_type

string DataProvider::DataProviderAppInfo::logo_mime_type

The mime type for `logo`.

Must be one of:

- SVG: `image/svg+xml`
- PNG: `image/png`

## name

string DataProvider::DataProviderAppInfo::name

Unique application name.

This technical name should have no spaces and be in camel case or all caps by convention

## scheme

*string DataProvider::DataProviderAppInfo::scheme

Connection scheme for the application.

This is the connection scheme for the `ConnectionProvider` module and indicates that the given connection type produces a data provider which will be the base data provider for application actions

## supports_apis

bool DataProvider::DataProviderAppInfo::supports_apis = False

If the apps supports API actions.

This attribute is filled automatically when actions are registered

## supports_create

bool DataProvider::DataProviderAppInfo::supports_create = False

If the apps supports create actions.

This attribute is filled automatically when actions are registered

## supports_delete

bool DataProvider::DataProviderAppInfo::supports_delete = False

If the apps supports delete actions.

This attribute is filled automatically when actions are registered

## supports_events

bool DataProvider::DataProviderAppInfo::supports_events = False

If the apps supports event actions.

This attribute is filled automatically when actions are registered

## supports_find

bool DataProvider::DataProviderAppInfo::supports_find = False

If the apps supports find actions.

This attribute is filled automatically when actions are registered

## supports_find_single

bool DataProvider::DataProviderAppInfo::supports_find_single = False

If the apps supports find_single actions.

This attribute is filled automatically when actions are registered

## supports_messages

bool DataProvider::DataProviderAppInfo::supports_messages = False

If the apps supports message actions.

This attribute is filled automatically when actions are registered

## supports_update

bool DataProvider::DataProviderAppInfo::supports_update = False

If the apps supports update actions.

This attribute is filled automatically when actions are registered

## supports_upsert

bool DataProvider::DataProviderAppInfo::supports_upsert = False

If the apps supports upsert actions.

This attribute is filled automatically when actions are registered