EndpointBuilderInterface.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

#ifndef ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_ENDPOINTS_ENDPOINTBUILDERINTERFACE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_ENDPOINTS_ENDPOINTBUILDERINTERFACE_H_

#include <memory>
#include <string>

#include "AVSCommon/SDKInterfaces/CapabilityConfigurationInterface.h"
#include "AVSCommon/SDKInterfaces/DirectiveHandlerInterface.h"
#include "AVSCommon/SDKInterfaces/Endpoints/EndpointCapabilitiesBuilderInterface.h"
#include "AVSCommon/SDKInterfaces/Endpoints/EndpointCapabilitiesRegistrarInterface.h"
#include "AVSCommon/SDKInterfaces/Endpoints/EndpointInterface.h"
#include "AVSCommon/SDKInterfaces/ModeController/ModeControllerAttributes.h"
#include "AVSCommon/SDKInterfaces/ModeController/ModeControllerInterface.h"
#include "AVSCommon/SDKInterfaces/PowerController/PowerControllerInterface.h"
#include "AVSCommon/SDKInterfaces/RangeController/RangeControllerAttributes.h"
#include "AVSCommon/SDKInterfaces/RangeController/RangeControllerInterface.h"
#include "AVSCommon/SDKInterfaces/ToggleController/ToggleControllerAttributes.h"
#include "AVSCommon/SDKInterfaces/ToggleController/ToggleControllerInterface.h"

#include "AVSCommon/Utils/Optional.h"

namespace alexaClientSDK {
namespace avsCommon {
namespace sdkInterfaces {
namespace endpoints {

class EndpointBuilderInterface : public EndpointCapabilitiesRegistrarInterface {
public:
    virtual ~EndpointBuilderInterface() = default;

    virtual EndpointBuilderInterface& withDerivedEndpointId(const std::string& suffix) = 0;

    virtual EndpointBuilderInterface& withDeviceRegistration() = 0;

    virtual EndpointBuilderInterface& withEndpointId(const EndpointIdentifier& endpointId) = 0;

    virtual EndpointBuilderInterface& withFriendlyName(const std::string& friendlyName) = 0;

    virtual EndpointBuilderInterface& withDescription(const std::string& description) = 0;

    virtual EndpointBuilderInterface& withManufacturerName(const std::string& manufacturerName) = 0;

    virtual EndpointBuilderInterface& withDisplayCategory(const std::vector<std::string>& displayCategories) = 0;

    virtual EndpointBuilderInterface& withAdditionalAttributes(
        const std::string& manufacturer,
        const std::string& model,
        const std::string& serialNumber,
        const std::string& firmwareVersion,
        const std::string& softwareVersion,
        const std::string& customIdentifier) = 0;

    virtual EndpointBuilderInterface& withConnections(
        const std::vector<std::map<std::string, std::string>>& connections) = 0;

    virtual EndpointBuilderInterface& withCookies(const std::map<std::string, std::string>& cookies) = 0;

    virtual EndpointBuilderInterface& withPowerController(
        std::shared_ptr<avsCommon::sdkInterfaces::powerController::PowerControllerInterface> powerController,
        bool isProactivelyReported,
        bool isRetrievable) = 0;

    virtual EndpointBuilderInterface& withToggleController(
        std::shared_ptr<avsCommon::sdkInterfaces::toggleController::ToggleControllerInterface> toggleController,
        const std::string& instance,
        const avsCommon::sdkInterfaces::toggleController::ToggleControllerAttributes& toggleControllerAttributes,
        bool isProactivelyReported,
        bool isRetrievable,
        bool isNonControllable = false) = 0;

    virtual EndpointBuilderInterface& withModeController(
        std::shared_ptr<avsCommon::sdkInterfaces::modeController::ModeControllerInterface> modeController,
        const std::string& instance,
        const avsCommon::sdkInterfaces::modeController::ModeControllerAttributes& modeControllerAttributes,
        bool isProactivelyReported,
        bool isRetrievable,
        bool isNonControllable = false) = 0;

    virtual EndpointBuilderInterface& withRangeController(
        std::shared_ptr<avsCommon::sdkInterfaces::rangeController::RangeControllerInterface> rangeController,
        const std::string& instance,
        const avsCommon::sdkInterfaces::rangeController::RangeControllerAttributes& rangeControllerAttributes,
        bool isProactivelyReported,
        bool isRetrievable,
        bool isNonControllable = false) = 0;

    virtual EndpointBuilderInterface& withEndpointCapabilitiesBuilder(
        const std::shared_ptr<avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesBuilderInterface>&
            endpointCapabilitiesBuilder) = 0;

    virtual std::unique_ptr<EndpointInterface> build() = 0;
};

}  // namespace endpoints
}  // namespace sdkInterfaces
}  // namespace avsCommon
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_ENDPOINTS_ENDPOINTBUILDERINTERFACE_H_