morph 0.1.0
Asynchronous bridge between GUI thread and business models
Loading...
Searching...
No Matches
morph::ui::author::ActionFacts< Action > Struct Template Reference

Catalog facts of an action that its C++ type does not show. Specialise it for an action whose reply rows carry server-calculated fields, whose reply carries a secret, or which sends a credential. More...

#include <author.hpp>

Static Public Member Functions

static std::vector< std::string > calculatedFields ()
 The reply-row fields the server calculates; an optimistic write may not name them.
static std::vector< std::string > secretFields ()
 The reply fields the server marks secret.

Static Public Attributes

static constexpr bool credential = false
 Whether the action sends a credential.

Detailed Description

template<typename Action>
struct morph::ui::author::ActionFacts< Action >

Catalog facts of an action that its C++ type does not show. Specialise it for an action whose reply rows carry server-calculated fields, whose reply carries a secret, or which sends a credential.

Template Parameters
ActionThe action type.

Definition at line 79 of file author.hpp.

Member Function Documentation

◆ calculatedFields()

template<typename Action>
std::vector< std::string > morph::ui::author::ActionFacts< Action >::calculatedFields ( )
inlinestaticnodiscard

The reply-row fields the server calculates; an optimistic write may not name them.

Returns
The field names.

Definition at line 85 of file author.hpp.

◆ secretFields()

template<typename Action>
std::vector< std::string > morph::ui::author::ActionFacts< Action >::secretFields ( )
inlinestaticnodiscard

The reply fields the server marks secret.

Returns
The field names.

Definition at line 89 of file author.hpp.

Member Data Documentation

◆ credential

template<typename Action>
bool morph::ui::author::ActionFacts< Action >::credential = false
staticconstexpr

Whether the action sends a credential.

Definition at line 81 of file author.hpp.


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