echomap::CancelProjectLoadNotification Struct Reference

A notification indicating that a pending Project load should be cancelled. More...

#include <CancelProjectLoadNotification.hpp>

Public Member Functions
	CancelProjectLoadNotification (id_type project_id)
	Create a new CancelProjectLoadNotification to indicate that the identified Project should be cancelled.
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 partially loaded Project to cancel.

Detailed Description

A notification indicating that a pending Project load should be cancelled.

Produced by the IndividualUploadModal if the user states a preference to cancel a VFS mapping.

Definition at line 25 of file CancelProjectLoadNotification.hpp.

Constructor & Destructor Documentation

CancelProjectLoadNotification()

echomap::CancelProjectLoadNotification::CancelProjectLoadNotification ( id_type project_id )

explicit

Create a new CancelProjectLoadNotification to indicate that the identified Project should be cancelled.

Parameters

project_id

The ID of the partially loaded Project to cancel.

Definition at line 18 of file CancelProjectLoadNotification.cpp.

  :
    project_id(project_id)
{
}

Member Function Documentation

verify_project()

void echomap::CancelProjectLoadNotification::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 25 of file CancelProjectLoadNotification.cpp.

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

Member Data Documentation

project_id

id_type echomap::CancelProjectLoadNotification::project_id

The ID of the partially loaded Project to cancel.

Definition at line 42 of file CancelProjectLoadNotification.hpp.

---

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

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