PLCnext API Documentation 25.0.2.69
Public Member Functions | List of all members
Arp::System::NmPayload::Security::SecurityNotificationInfo Class Reference

Provides information fields for recipients The exact field keys and values are chosen by every specific security notification More...

#include <SecurityNotificationInfo.hpp>

Public Member Functions

 SecurityNotificationInfo (void)
 Default constructor.
 
 SecurityNotificationInfo (const SecurityNotificationInfo &arg)
 Default copy constructor.
 
 SecurityNotificationInfo (SecurityNotificationInfo &&arg) noexcept
 Default move constructor.
 
SecurityNotificationInfo & operator= (const SecurityNotificationInfo &arg)
 Default copy-assignment operator.
 
SecurityNotificationInfo & operator= (SecurityNotificationInfo &&arg) noexcept
 Default move-assignment operator.
 
 ~SecurityNotificationInfo (void)
 Default destructor.
 
String GetJsonEncoding () const
 Overrides all infos with the values from the given string More...
 
void SetJsonString (const String &json)
 Overrides all infos with the values from the given string More...
 
void AddInfo (const String &key, const String &value)
 Adds Info to this object More...
 
String GetInfo (const String &key) const
 Retrieves stored data from the given field More...
 
Impl & GetImpl (void)
 For internal use only.
 
const Impl & GetImpl (void) const
 

Detailed Description

Provides information fields for recipients The exact field keys and values are chosen by every specific security notification

Member Function Documentation

◆ AddInfo()

void Arp::System::NmPayload::Security::SecurityNotificationInfo::AddInfo ( const String &  key,
const String &  value 
)

Adds Info to this object

Parameters
keykey for later lookup
valuevalue for this info

◆ GetInfo()

String Arp::System::NmPayload::Security::SecurityNotificationInfo::GetInfo ( const String &  key) const

Retrieves stored data from the given field

Parameters
keykey to lookup data from

◆ GetJsonEncoding()

String Arp::System::NmPayload::Security::SecurityNotificationInfo::GetJsonEncoding ( ) const

Overrides all infos with the values from the given string

Parameters
jsonJSON formatted string to extract data from

◆ SetJsonString()

void Arp::System::NmPayload::Security::SecurityNotificationInfo::SetJsonString ( const String &  json)

Overrides all infos with the values from the given string

Parameters
jsonJSON formatted string to extract data from

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