DataProvider action definition. More...

Public Attributes
string	action
	The unique name for the action; unique in the application.

int	action_code
	Action type code.

*string	action_val
	Message or event type.

string	app
	Name of the application that provides the action.

*string	cls
	The DataProvider class.

string	desc
	Action long description, markdown formatting.

string	display_name
	The display name for the action.

*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.

*hash< string, hash< ActionOptionInfo > >	options
	Options that can be provided without a data provider.

*hash< auto >	options_add
	Values to add to any "options" argument for record-based actions.

*AbstractDataProviderType	output_type
	Output type for the action.

string	path
	Data provider path to action.

*hash< string, hash< DataProviderPathVarInfo > >	path_vars
	Description of any path variables.

*hash< auto >	set_add
	Values to add to any "set" argument for record-based actions.

string	short_desc
	Action short description, plain text formatting.

*string	subtype
	Any data provider subtype.

*hash< auto >	where_add
	Values to add to any "where" argument for record-based actions.

Detailed Description

DataProvider action definition.

Member Data Documentation

int DataProvider::DataProviderActionInfo::action_code

Action type code.

*string DataProvider::DataProviderActionInfo::action_val

Message or event type.

if action_code is:

*string DataProvider::DataProviderActionInfo::cls

This is for the case when there is no application scheme and the application is not implied by the context.

It is an error to supply both application scheme and cls.

string DataProvider::DataProviderActionInfo::path

Data provider path to action.

The path is relative from the data provider provided by the application

*hash<string, hash<DataProviderPathVarInfo> > DataProvider::DataProviderActionInfo::path_vars

Description of any path variables.

Keys are path variables, values provide info about the path variable

*string DataProvider::DataProviderActionInfo::subtype

Any data provider subtype.

This is the value that will be passed to AbstractConnection::getDataProvider(string subtype)