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::acsdkAlexaKeypadController::AlexaKeypadControllerFactory Class Reference

#include <AlexaKeypadControllerFactory.h>

Classes

struct  AlexaKeypadControllerCapabilityAgentData
 This object used to register the capability agent to an endpoint. More...
 

Static Public Member Functions

static avsCommon::utils::Optional< AlexaKeypadControllerCapabilityAgentDatacreate (const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier &endpointId, std::shared_ptr< acsdkAlexaKeypadControllerInterfaces::AlexaKeypadControllerInterface > keypadController, const std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > &contextManager, const std::shared_ptr< avsCommon::sdkInterfaces::AlexaInterfaceMessageSenderInterface > &responseSender, const std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &exceptionSender)
 

Detailed Description

This factory can be used to create a new AlexaKeypadControllerCapabilityAgent and return a generic object that contains certain interfaces which can be used for registering this capability agent to an endpoint.

Member Function Documentation

◆ create()

static avsCommon::utils::Optional<AlexaKeypadControllerCapabilityAgentData> alexaClientSDK::acsdkAlexaKeypadController::AlexaKeypadControllerFactory::create ( const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier endpointId,
std::shared_ptr< acsdkAlexaKeypadControllerInterfaces::AlexaKeypadControllerInterface keypadController,
const std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > &  contextManager,
const std::shared_ptr< avsCommon::sdkInterfaces::AlexaInterfaceMessageSenderInterface > &  responseSender,
const std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &  exceptionSender 
)
static

Creates a new AlexaKeypadController capability agent configuration

Parameters
endpointIdA endpoint to which this capability is associated.
keypadControllerAn interface that this object will use to perform the keypad controller operations.
contextManagerAn interface to which this object will send property state updates.
responseSenderAn interface that this object will use to send the reponse to AVS.
exceptionSenderAn interface to report exceptions to AVS.
Returns
An Optional object with no valid value if the inputs are invalid, else a new AlexaKeypadControllerCapabilityAgentData object.

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