AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Static Public Member Functions | List of all members
alexaClientSDK::sampleApplications::ipcServerSampleApp::ConfigValidator Class Reference

#include <ConfigValidator.h>

Public Member Functions

 ConfigValidator ()
 
 ~ConfigValidator ()=default
 
bool validate (avsCommon::utils::configuration::ConfigurationNode &configuration, rapidjson::Document &jsonSchema)
 

Static Public Member Functions

static std::shared_ptr< ConfigValidatorcreate ()
 

Constructor & Destructor Documentation

◆ ConfigValidator()

alexaClientSDK::sampleApplications::ipcServerSampleApp::ConfigValidator::ConfigValidator ( )

Constructor.

◆ ~ConfigValidator()

alexaClientSDK::sampleApplications::ipcServerSampleApp::ConfigValidator::~ConfigValidator ( )
default

Default destructor.

Member Function Documentation

◆ create()

static std::shared_ptr<ConfigValidator> alexaClientSDK::sampleApplications::ipcServerSampleApp::ConfigValidator::create ( )
static

Create a new ConfigValidator.

Returns
The ConfigValidator object

◆ validate()

bool alexaClientSDK::sampleApplications::ipcServerSampleApp::ConfigValidator::validate ( avsCommon::utils::configuration::ConfigurationNode configuration,
rapidjson::Document &  jsonSchema 
)

Validates a configuration node using the json schema file.

Parameters
configurationThe ConfigurationNode configuration object. The configuration object will be validated against the schema file for errors.
jsonSchemaThe json schema that contains the representation of the configuration object. This schema is expected to comply with JSON Schema Draft v4 specification which is currently the latest version of JSON Schema supported by rapidjson v1.1. For documentation details, refer to: http://json-schema.org/specification.html
Returns
boolean Indicates if validation of the configuration object was successful

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

AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0