Nickvision::Notifications::NotificationSentEventArgs Class Reference

An event argument for when a notification is sent. More...

#include <notificationsenteventargs.h>

Inheritance diagram for Nickvision::Notifications::NotificationSentEventArgs:

Public Member Functions
	NotificationSentEventArgs (const std::string &message, NotificationSeverity severity, const std::string &action="", const std::string &actionParam="") noexcept
	Constructs a NotificationSentEventArgs.
const std::string &	getMessage () const noexcept
	Gets the message of the notification.
NotificationSeverity	getSeverity () const noexcept
	Gets the severity of the notification.
const std::string &	getAction () const noexcept
	Gets the optional action of the notification.
const std::string &	getActionParam () const noexcept
	Gets the parameter of the optional action.
Public Member Functions inherited from Nickvision::Events::EventArgs
	EventArgs () noexcept=default
	Constructs an EventArgs.

Protected Attributes
std::string	m_message
NotificationSeverity	m_severity
std::string	m_action
std::string	m_actionParam

Detailed Description

An event argument for when a notification is sent.

Constructor & Destructor Documentation

NotificationSentEventArgs()

Nickvision::Notifications::NotificationSentEventArgs::NotificationSentEventArgs ( const std::string & message, NotificationSeverity severity, const std::string & action = "", const std::string & actionParam = "" )

noexcept

Constructs a NotificationSentEventArgs.

Parameters

message	The message of the notification
severity	The severity of the notification
action	An additional action for the notification
actionParam	The parameter of the additional action

Member Function Documentation

getAction()

const std::string & Nickvision::Notifications::NotificationSentEventArgs::getAction ( ) const

noexcept

Gets the optional action of the notification.

Returns

The optional action of the notification

getActionParam()

const std::string & Nickvision::Notifications::NotificationSentEventArgs::getActionParam ( ) const

noexcept

Gets the parameter of the optional action.

Returns

The parameter of the optional action

getMessage()

const std::string & Nickvision::Notifications::NotificationSentEventArgs::getMessage ( ) const

noexcept

Gets the message of the notification.

Returns

The message of the notification

getSeverity()

NotificationSeverity Nickvision::Notifications::NotificationSentEventArgs::getSeverity ( ) const

noexcept

Gets the severity of the notification.

Returns

The severity of the notification

Member Data Documentation

m_action

std::string Nickvision::Notifications::NotificationSentEventArgs::m_action

protected

m_actionParam

std::string Nickvision::Notifications::NotificationSentEventArgs::m_actionParam

protected

m_message

std::string Nickvision::Notifications::NotificationSentEventArgs::m_message

protected

m_severity

NotificationSeverity Nickvision::Notifications::NotificationSentEventArgs::m_severity

protected

---

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

• include/notifications/notificationsenteventargs.h