What the catalog says about an action. More...

#include <document.hpp>

Public Attributes
std::string	modelType
	The registered type id of the model the action belongs to.
std::vector< std::string >	calculatedFields
	The fields of the action's reply rows that the server calculates; an optimistic write may not name them.
std::vector< std::string >	secretFields
	The reply fields the server marks secret.
bool	credential = false
	Whether the action sends a credential.
std::optional< std::vector< std::string > >	listFields
	When the action's result is a record, the names of its members that hold a list: what a patch or optimistic of a query of the action may name as its at. Empty when the catalog does not say, or the result is not a record.
std::optional< std::vector< ActionEffect > >	effects
	What the action declares it changes. Absent when it declared nothing, which makes it a read; present and empty is not produced by the registry.
std::vector< ActionRecordInfo >	records
	The records the action's result holds, with the paths to each. Empty when it holds none or the catalog does not say.

Detailed Description

What the catalog says about an action.

Definition at line 78 of file document.hpp.

Member Data Documentation

◆ modelType

std::string morph::ui::ActionInfo::modelType

The registered type id of the model the action belongs to.

Definition at line 80 of file document.hpp.

◆ calculatedFields

std::vector<std::string> morph::ui::ActionInfo::calculatedFields

The fields of the action's reply rows that the server calculates; an optimistic write may not name them.

Definition at line 83 of file document.hpp.

◆ secretFields

std::vector<std::string> morph::ui::ActionInfo::secretFields

The reply fields the server marks secret.

Definition at line 85 of file document.hpp.

◆ credential

bool morph::ui::ActionInfo::credential = false

Whether the action sends a credential.

Definition at line 87 of file document.hpp.

◆ listFields

std::optional<std::vector<std::string> > morph::ui::ActionInfo::listFields

When the action's result is a record, the names of its members that hold a list: what a patch or optimistic of a query of the action may name as its at. Empty when the catalog does not say, or the result is not a record.

Definition at line 91 of file document.hpp.

◆ effects

std::optional<std::vector<ActionEffect> > morph::ui::ActionInfo::effects

What the action declares it changes. Absent when it declared nothing, which makes it a read; present and empty is not produced by the registry.

Definition at line 94 of file document.hpp.

◆ records

std::vector<ActionRecordInfo> morph::ui::ActionInfo::records

The records the action's result holds, with the paths to each. Empty when it holds none or the catalog does not say.

Definition at line 97 of file document.hpp.

The documentation for this struct was generated from the following file:

morph/ui/document.hpp

Public Attributes