LicenseSpring C++ SDK
Easily add Software Licensing to your application
Loading...
Searching...
No Matches
LicenseSpring::CustomField Class Reference

Class for storing key-value data field. More...

#include <LicenseSpring/CustomField.h>

Public Member Functions

 CustomField ()=default
 Default constructor, creates empty data field.
 
 CustomField (const std::string &name, const std::string &value)
 Constructs data field with given name (key) and value.
 
const std::string & fieldName () const
 Getter method for data field name.
 
void setFieldName (const std::string &name)
 Setter method for data field name.
 
const std::string & fieldValue () const
 Getter method for data field value.
 
void setFieldValue (const std::string &value)
 Setter method for data field value.
 
bool operator== (const CustomField &other) const
 Equality operator to compare two CustomField objects.
 

Detailed Description

Class for storing key-value data field.

See also
License::customFields(), to obtain CustomField objects from your license.

Definition at line 17 of file CustomField.h.

Constructor & Destructor Documentation

◆ CustomField() [1/2]

LicenseSpring::CustomField::CustomField ( )
default

Default constructor, creates empty data field.

◆ CustomField() [2/2]

LicenseSpring::CustomField::CustomField ( const std::string &  name,
const std::string &  value 
)
inline

Constructs data field with given name (key) and value.

Parameters
nameName (key) of key-value data field
valueValue of key-value data field

Definition at line 26 of file CustomField.h.

Member Function Documentation

◆ fieldName()

const std::string & LicenseSpring::CustomField::fieldName ( ) const
inline

Getter method for data field name.

Returns
CustomField name.

Definition at line 30 of file CustomField.h.

◆ setFieldName()

void LicenseSpring::CustomField::setFieldName ( const std::string &  name)
inline

Setter method for data field name.

Parameters
nameCustomField name

Definition at line 34 of file CustomField.h.

◆ fieldValue()

const std::string & LicenseSpring::CustomField::fieldValue ( ) const
inline

Getter method for data field value.

Returns
CustomField value.

Definition at line 38 of file CustomField.h.

◆ setFieldValue()

void LicenseSpring::CustomField::setFieldValue ( const std::string &  value)
inline

Setter method for data field value.

Parameters
valueCustomField value

Definition at line 42 of file CustomField.h.

◆ operator==()

bool LicenseSpring::CustomField::operator== ( const CustomField other) const
inline

Equality operator to compare two CustomField objects.

Parameters
otherThe other CustomField object to compare with
Returns
True if both objects have the same name and value.

Definition at line 47 of file CustomField.h.


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