ConnectionProvider::ConnectionDataInfo Struct Reference

Connection information hash containing only serializable data. More...

#include <ConnectionProvider.qm.dox.h>

Public Attributes
*string	app
	Any application name associated with the connection.
bool	children_can_support_apis = False
	if the data provider or any of its children support requests (APIs)
bool	children_can_support_messages = False
	if the data provider or any of its children support messages
bool	children_can_support_observers = False
	if the data provider or any of its children support events
bool	children_can_support_records = False
	if the data provider or any of its children support records
bool	children_can_support_transactions = False
	if the data provider or any of its children support transaction management
string	customization_status
	The current customization status for the connection.
*date	customization_timestamp
	The timestamp of the last customization for the connection.
*hash< string, *hash< string, hash< auto > > >	dataprovider_subtypes
	Data provider subtype information.
bool	debug_data
	a boolean value indicating whether the connection should be subject to data debugging
string	desc
	the connection description
string	display_name
	the display name
bool	enabled
	a boolean value indicating if the connection should be enabled or not
*hash< string, bool >	features
	connection-defined feature hash
bool	has_provider = False
	if the connection supports the data provider API
*date	last_check
	the date/time value of the last connection check (or NOTHING if not checked)
bool	locked
	a boolean value indicating whether the connection is locked or not
bool	loopback
	a boolean vaue indicating if the connection is a loopback connection
bool	monitor
	a boolean vaue indicating if the connection should be monitored or not
string	name
	the connection name
bool	needs_auth
	True if the connection requires OAuth2 authorization before it can be used
*hash	opts
	the original options used to create the object
string	short_desc
	the connection short description in plain text
string	status
	a string giving the connection's status
bool	supports_customization
	Indicates if the connection supports customization or not.
hash< auto >	tags
	user-defined key-value pairs associated with the connection
string	type
	the connection type
bool	up = False
	a boolean vaue indicating the connection is known to be up (will be False if not checked)
*date	updated
	the date/time value of the update (or NOTHING if not updated)
string	url
	the URL for the connection including the password
hash	url_hash
	a hash of URL information as returned by parse_url()

Detailed Description

Connection information hash containing only serializable data.

As returned by AbstractConnection::getDataInfo()

Since

ConnectionProvider 2.0

Member Data Documentation

customization_status

string ConnectionProvider::ConnectionDataInfo::customization_status

The current customization status for the connection.

See also

Connection Customization Statuses for allowed values

debug_data

bool ConnectionProvider::ConnectionDataInfo::debug_data

a boolean value indicating whether the connection should be subject to data debugging

This flag does not affect anything by default, it is for user re-implementations

enabled

bool ConnectionProvider::ConnectionDataInfo::enabled

a boolean value indicating if the connection should be enabled or not

This flag does not affect anything by default, it is for user re-implementations

locked

bool ConnectionProvider::ConnectionDataInfo::locked

a boolean value indicating whether the connection is locked or not

This flag does not affect anything by default, it is for user re-implementations

needs_auth

bool ConnectionProvider::ConnectionDataInfo::needs_auth

True if the connection requires OAuth2 authorization before it can be used

False if already authorized, or the connection does not support authorization

url

string ConnectionProvider::ConnectionDataInfo::url

the URL for the connection including the password

if any present and the with_password argument is True