The body of a ui-catalog reply: the catalog filtered for the principal, and the facts a client's load-time validation reads (ui::Catalog). More...

#include <bundle.hpp>

Public Member Functions
Catalog	facts () const
	The facts as the lookups load-time validation takes. A lookup the reply carried no facts for is left empty, so its rules are skipped.

Public Attributes
std::vector< CatalogEntry >	entries
	The entries the principal sees, in registration order.
std::vector< std::string >	permitted
	The action ids the principal may run, which {"can": …} reads.
std::optional< std::map< std::string, ModelInfo, std::less<> > >	models
	The model facts by type id; absent when the server has none to give.
std::optional< std::map< std::string, ActionInfo, std::less<> > >	actions
	The action facts by action id; absent when the server has none to give.
std::optional< std::map< std::string, std::string, std::less<> > >	views
	The v-* view documents a collection node builds from, by the action of their v-query; absent when the server has none to give.
std::optional< std::map< std::string, std::string, std::less<> > >	wizards
	The w-* wizard documents a wizard node builds from, by the action of their first step; absent when the server has none to give.

Detailed Description

The body of a ui-catalog reply: the catalog filtered for the principal, and the facts a client's load-time validation reads (ui::Catalog).

Definition at line 280 of file bundle.hpp.

Member Function Documentation

◆ facts()

Catalog morph::ui::CatalogReply::facts ( ) const

inlinenodiscard

The facts as the lookups load-time validation takes. A lookup the reply carried no facts for is left empty, so its rules are skipped.

Returns: The catalog.

Definition at line 299 of file bundle.hpp.

Member Data Documentation

◆ entries

std::vector<CatalogEntry> morph::ui::CatalogReply::entries

The entries the principal sees, in registration order.

Definition at line 282 of file bundle.hpp.

◆ permitted

std::vector<std::string> morph::ui::CatalogReply::permitted

The action ids the principal may run, which {"can": …} reads.

Definition at line 284 of file bundle.hpp.

◆ models

std::optional<std::map<std::string, ModelInfo, std::less<> > > morph::ui::CatalogReply::models

The model facts by type id; absent when the server has none to give.

Definition at line 286 of file bundle.hpp.

◆ actions

std::optional<std::map<std::string, ActionInfo, std::less<> > > morph::ui::CatalogReply::actions

The action facts by action id; absent when the server has none to give.

Definition at line 288 of file bundle.hpp.

◆ views

std::optional<std::map<std::string, std::string, std::less<> > > morph::ui::CatalogReply::views

The v-* view documents a collection node builds from, by the action of their v-query; absent when the server has none to give.

Definition at line 291 of file bundle.hpp.

◆ wizards

std::optional<std::map<std::string, std::string, std::less<> > > morph::ui::CatalogReply::wizards

The w-* wizard documents a wizard node builds from, by the action of their first step; absent when the server has none to give.

Definition at line 294 of file bundle.hpp.

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

morph/ui/bundle.hpp

Public Member Functions

Public Attributes