AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Public Attributes | List of all members
alexaClientSDK::avsCommon::avs::CapabilityConfiguration::Properties Struct Reference

#include <CapabilityConfiguration.h>

Collaboration diagram for alexaClientSDK::avsCommon::avs::CapabilityConfiguration::Properties:
Collaboration graph
[legend]

Public Member Functions

 Properties (bool isRetrievableIn=false, bool isProactivelyReportedIn=false, const std::vector< std::string > &supportedListIn=std::vector< std::string >(), const avsCommon::utils::Optional< bool > &isNonControllableIn=avsCommon::utils::Optional< bool >())
 

Public Attributes

bool isRetrievable
 boolean indicating if the capability properties can be retrieved using the ReportState Directive. More...
 
bool isProactivelyReported
 boolean indicating if the capability properties are proactively reported using the ChangeReport Event. More...
 
std::vector< std::string > supportedList
 The list of supported properties of the capability agent. More...
 
avsCommon::utils::Optional< bool > isNonControllable
 The optional nonControllable properties flag. More...
 

Detailed Description

Structure representing the Capability Properties field.

Constructor & Destructor Documentation

◆ Properties()

alexaClientSDK::avsCommon::avs::CapabilityConfiguration::Properties::Properties ( bool  isRetrievableIn = false,
bool  isProactivelyReportedIn = false,
const std::vector< std::string > &  supportedListIn = std::vector<std::string>(),
const avsCommon::utils::Optional< bool > &  isNonControllableIn = avsCommon::utils::Optional<bool>() 
)

Constructor.

Parameters
isRetrievableInthe isRetrievable properties flag.
isProactivelyReportedInthe isProactivelyReported properties flag.
supportedListInthe list of Supported property names.
isNonControllableInthe optional isNonControllable properties flag.

Member Data Documentation

◆ isNonControllable

avsCommon::utils::Optional<bool> alexaClientSDK::avsCommon::avs::CapabilityConfiguration::Properties::isNonControllable

The optional nonControllable properties flag.

◆ isProactivelyReported

bool alexaClientSDK::avsCommon::avs::CapabilityConfiguration::Properties::isProactivelyReported

boolean indicating if the capability properties are proactively reported using the ChangeReport Event.

◆ isRetrievable

bool alexaClientSDK::avsCommon::avs::CapabilityConfiguration::Properties::isRetrievable

boolean indicating if the capability properties can be retrieved using the ReportState Directive.

◆ supportedList

std::vector<std::string> alexaClientSDK::avsCommon::avs::CapabilityConfiguration::Properties::supportedList

The list of supported properties of the capability agent.


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

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