Request the creation of a persistent update based on the uuid of a transient update::UpdateDescriptor object. More...

Inheritance diagram for Leosac::Module::WebSockAPI::CreateUpdate:

Collaboration diagram for Leosac::Module::WebSockAPI::CreateUpdate:

Public Member Functions
	CreateUpdate (RequestContext ctx)

Public Member Functions inherited from Leosac::Module::WebSockAPI::MethodHandler
	MethodHandler (RequestContext ctx)

virtual	~MethodHandler ()=default

json	process (const ClientMessage &msg)
	The public `process()` method. More...

UserSecurityContext &	security_context ()

ExecutionContext	exec_context ()
	Returns a representation of the execution context of this request. More...

Static Public Member Functions
static MethodHandlerUPtr	create (RequestContext)

Static Public Member Functions inherited from Leosac::Module::WebSockAPI::MethodHandler
static MethodHandlerUPtr	create (RequestContext)
	An example method that should be implemented in all subclasses. More...

Protected Member Functions
std::vector< ActionActionParam >	required_permission (const json &req) const override
	Return a list of "Action" / "ActionParam" that must pass before the request is processed. More...

Private Member Functions
virtual json	process_impl (const json &req) override
	The API method implementation. More...

Additional Inherited Members
Public Types inherited from Leosac::Module::WebSockAPI::MethodHandler
using	Factory = MethodHandlerUPtr(*)(RequestContext)

Protected Attributes inherited from Leosac::Module::WebSockAPI::MethodHandler
RequestContext	ctx_

Detailed Description

Request the creation of a persistent update based on the uuid of a transient update::UpdateDescriptor object.

Request: { descriptor_uuid: xxxx-yyy-.... }

Definition at line 42 of file CreateUpdate.hpp.

Constructor & Destructor Documentation

Leosac::Module::WebSockAPI::CreateUpdate::CreateUpdate ( RequestContext ctx )

Definition at line 31 of file CreateUpdate.cpp.

MethodHandlerUPtr Leosac::Module::WebSockAPI::CreateUpdate::create ( RequestContext ctx )

static

Definition at line 36 of file CreateUpdate.cpp.

json Leosac::Module::WebSockAPI::CreateUpdate::process_impl ( const json & req )

overrideprivatevirtual

The API method implementation.

Returns: A json object that will be assigned to the content key in the JSON message sent to the client.

Definition at line 50 of file CreateUpdate.cpp.

std::vector< ActionActionParam > Leosac::Module::WebSockAPI::CreateUpdate::required_permission ( const json & req ) const

overrideprotectedvirtual

Return a list of "Action" / "ActionParam" that must pass before the request is processed.

Definition at line 41 of file CreateUpdate.cpp.

The documentation for this class was generated from the following files: