A mutation (spec 5 §5). More...

#include <document.hpp>

Public Attributes
std::string	name
	The name.
std::string	path
	The declaration's JSON Pointer.
std::string	model
	The model alias it goes through.
std::string	action
	The action id it runs.
ExprPtr	body
	The body; nullptr sends an empty object.
Concurrency	concurrency = Concurrency::Exclusive
	What a run does while another is in flight.
ExprPtr	serialKey
	The queue key of serial runs.
std::optional< OptimisticDecl >	optimistic
	The row a run predicts before its reply.
Commands	onSuccess
	Commands run after a success.
Commands	onError
	Commands run after a failure.
bool	offlineQueue = false
	Whether a run that cannot reach the server is queued offline.

Detailed Description

A mutation (spec 5 §5).

Definition at line 307 of file document.hpp.

Member Data Documentation

◆ name

std::string morph::ui::MutationDecl::name

The name.

Definition at line 309 of file document.hpp.

◆ path

std::string morph::ui::MutationDecl::path

The declaration's JSON Pointer.

Definition at line 311 of file document.hpp.

◆ model

std::string morph::ui::MutationDecl::model

The model alias it goes through.

Definition at line 313 of file document.hpp.

◆ action

std::string morph::ui::MutationDecl::action

The action id it runs.

Definition at line 315 of file document.hpp.

◆ body

ExprPtr morph::ui::MutationDecl::body

The body; nullptr sends an empty object.

Definition at line 317 of file document.hpp.

◆ concurrency

Concurrency morph::ui::MutationDecl::concurrency = Concurrency::Exclusive

What a run does while another is in flight.

Definition at line 319 of file document.hpp.

◆ serialKey

ExprPtr morph::ui::MutationDecl::serialKey

The queue key of serial runs.

Definition at line 321 of file document.hpp.

◆ optimistic

std::optional<OptimisticDecl> morph::ui::MutationDecl::optimistic

The row a run predicts before its reply.

Definition at line 323 of file document.hpp.

◆ onSuccess

Commands morph::ui::MutationDecl::onSuccess

Commands run after a success.

Definition at line 325 of file document.hpp.

◆ onError

Commands morph::ui::MutationDecl::onError

Commands run after a failure.

Definition at line 327 of file document.hpp.

◆ offlineQueue

bool morph::ui::MutationDecl::offlineQueue = false

Whether a run that cannot reach the server is queued offline.

Definition at line 329 of file document.hpp.

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

morph/ui/document.hpp

Public Attributes