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::alexaRecordController::AlexaRecordControllerFactory Class Reference

#include <AlexaRecordControllerFactory.h>

Static Public Member Functions

static avsCommon::utils::Optional< RecordControllerCapabilityAgentData > create (const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier &endpointId, const std::shared_ptr< alexaRecordControllerInterfaces::RecordControllerInterface > &recordController, 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 isRetrievable)
 

Detailed Description

This factory can be used to create an AlexaRecordControllerFactory object which could be a parameter for Capability agent construction.

Member Function Documentation

◆ create()

static avsCommon::utils::Optional<RecordControllerCapabilityAgentData> alexaClientSDK::alexaRecordController::AlexaRecordControllerFactory::create ( const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier endpointId,
const std::shared_ptr< alexaRecordControllerInterfaces::RecordControllerInterface > &  recordController,
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  isRetrievable 
)
static

Creates a new AlexaRecordController capability agent configuration.

Parameters
endpointIdA endpoint to which this capability is associated.
recordControllerAn interface that this object will use to perform the record 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.
isRetrievableWhether properties can be retrieved when AVS sends a state report request or the endpoint responds with an Alexa response to a directive.
Returns
An Optional object containing an instance of RecordControllerCapabilityAgentData 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 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0