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

#include <AlexaChannelControllerFactory.h>

Static Public Member Functions

static avsCommon::utils::Optional< ChannelControllerCapabilityAgentData > create (const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier &endpointId, const std::shared_ptr< alexaChannelControllerInterfaces::ChannelControllerInterface > &channelController, const std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > &contextManager, const std::shared_ptr< avsCommon::sdkInterfaces::AlexaInterfaceMessageSenderInterface > &responseSender, const std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &exceptionSender, bool isProactivelyReported, bool isRetrievable)

Detailed Description

This factory can be used to create a AlexaChannelControllerFactory object which could be a parameter for Capability Agent construction.

Member Function Documentation

◆ create()

static avsCommon::utils::Optional<ChannelControllerCapabilityAgentData> alexaClientSDK::alexaChannelController::AlexaChannelControllerFactory::create ( const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier endpointId,
const std::shared_ptr< alexaChannelControllerInterfaces::ChannelControllerInterface > &  channelController,
const std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > &  contextManager,
const std::shared_ptr< avsCommon::sdkInterfaces::AlexaInterfaceMessageSenderInterface > &  responseSender,
const std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &  exceptionSender,
bool  isProactivelyReported,
bool  isRetrievable 

Creates a new ChannelController capability agent configuration.

endpointIdA endpoint to which this capability is associated.
channelControllerAn interface that this object will use to perform the channel controller operations.
contextManagerAn interface to which this object will send property state updates.
responseSenderAn interface that this object will use to send the response to AVS.
exceptionSenderAn interface to report exceptions to AVS.
isProactivelyReportedWhether the channel properties change is proactively reported to AVS in a change report.
isRetrievableWhether the channel properties can be retrieved when AVS sends a state report request to the endpoint.
An Optional object containing an instance of ChannelControllerCapabilityAgentData object if successful, otherwise an Optional object with no valid value.

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

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