echomap::CompleteProjectLoadNotification Struct Reference

A notification indicating that a pending Project is ready to be loaded. More...

#include <CompleteProjectLoadNotification.hpp>

Public Member Functions
	CompleteProjectLoadNotification (id_type project_id)
	Create a CompleteProjectLoadNotification to indicate that the referenced Project is ready to be loaded.
void	verify_project (const PartialProject *context) const
	Verify that the given Project matches the intended target.

Public Attributes
id_type	project_id
	The ID of the Project to be loaded.

Detailed Description

A notification indicating that a pending Project is ready to be loaded.

Produced by the IndividualUploadModal once the user has prepared a sufficient set of VFS mappings, such that all externally sourced files are associated with uploads in the WebAssembly VFS.

Definition at line 30 of file CompleteProjectLoadNotification.hpp.

Constructor & Destructor Documentation

CompleteProjectLoadNotification()

echomap::CompleteProjectLoadNotification::CompleteProjectLoadNotification ( id_type project_id )

explicit

Create a CompleteProjectLoadNotification to indicate that the referenced Project is ready to be loaded.

Parameters

project_id

The ID of the Project to be loaded.

Definition at line 20 of file CompleteProjectLoadNotification.cpp.

  :
    project_id(project_id)
{
}

Member Function Documentation

verify_project()

void echomap::CompleteProjectLoadNotification::verify_project

(

const PartialProject *

context

)

const

Verify that the given Project matches the intended target.

Parameters

context

The context to which the notification will apply.

Exceptions

IgnoredWarning

The notification does not apply to the given context and should be ignored.

Definition at line 27 of file CompleteProjectLoadNotification.cpp.

{
    if (context == nullptr)
        throw IgnoredWarning("Dropping CompleteProjectLoadNotification due to empty project.");
 
    if (context->get_id() != project_id)
        throw IgnoredWarning(
                std::format(
                        "Dropping CompleteProjectLoadNotification due to invalid project: requested {}, but have {}.",
                        project_id,
                        context->get_id()
                )
        );
}

Member Data Documentation

project_id

id_type echomap::CompleteProjectLoadNotification::project_id

The ID of the Project to be loaded.

Definition at line 47 of file CompleteProjectLoadNotification.hpp.

---

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

• src/notifications/web/CompleteProjectLoadNotification.hpp
• src/notifications/web/CompleteProjectLoadNotification.cpp