nx_metadata_sdk 1.0 Metadata SDK

Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
nx::sdk::ISettingsResponse Class Referenceabstract
Inheritance diagram for nx::sdk::ISettingsResponse:

## Public Member Functions
Ptr< IStringMap > | values () const
Ptr< IStringMap > | errors () const
Public Member Functions inherited from nx::sdk::Interface< ISettingsResponse >
virtual IRefCountable * | queryInterface (const InterfaceId *id)
Ptr< Interface > | queryInterface ()
Ptr< const Interface > | queryInterface () const
Public Member Functions inherited from nx::sdk::IRefCountable
virtual | ~IRefCountable ()=default
template<class Interface >
Ptr< Interface > | queryInterface ()
template<class Interface >
Ptr< const Interface > | queryInterface () const
virtual int | addRef () const =0
virtual int | releaseRef () const =0
int | refCountThreadUnsafe () const

## Static Public Member Functions
static auto | interfaceId ()
Static Public Member Functions inherited from nx::sdk::IRefCountable
static auto | interfaceId ()

## Protected Member Functions
virtual IStringMap * | getValues () const =0
virtual IStringMap * | getErrors () const =0
Protected Member Functions inherited from nx::sdk::Interface< ISettingsResponse >
virtual IRefCountable * | queryInterface (const IRefCountable::InterfaceId *id) override
IRefCountable * | queryInterfaceSupportingDeprecatedId (const IRefCountable::InterfaceId *id, const Uuid &deprecatedInterfaceId)

## Additional Inherited Members
Static Protected Member Functions inherited from nx::sdk::IRefCountable
template<int len>
static constexpr const InterfaceId * | makeId (const char(&charArray)[len])
template<class TemplateInstance , class TemplateArg , int len>
static const InterfaceId * | makeIdForTemplate (const char(&baseIdCharArray)[len])

## Member Function Documentation

## ◆ getErrors()

virtual IStringMap* nx::sdk::ISettingsResponse::getErrors | ( |  | ) | const
| protected pure virtual

Returns
  Map of errors that happened while obtaining setting values, indexed by setting ids. Each value must be a human-readable error message in English.

Implemented in nx::sdk::SettingsResponse.

## ◆ getValues()

virtual IStringMap* nx::sdk::ISettingsResponse::getValues | ( |  | ) | const
| protected pure virtual

Returns
  Map of setting values, indexed by setting ids.

Implemented in nx::sdk::SettingsResponse.

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

- src/nx/sdk/i_settings_response.h