DeviceSetupInterface.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 ACSDKDEVICESETUPINTERFACES_DEVICESETUPINTERFACE_H_
#define ACSDKDEVICESETUPINTERFACES_DEVICESETUPINTERFACE_H_

#include <future>
#include <memory>
#include <ostream>
#include <string>

namespace alexaClientSDK {
namespace acsdkDeviceSetupInterfaces {

enum class AssistedSetup {
    NONE,
    ALEXA_COMPANION_APPLICATION
};

inline std::string assistedSetupToString(AssistedSetup assistedSetup) {
    switch (assistedSetup) {
        case AssistedSetup::NONE:
            return "NONE";
        case AssistedSetup::ALEXA_COMPANION_APPLICATION:
            return "ALEXA_COMPANION_APPLICATION";
    }

    return "UNKNOWN";
}

inline std::ostream& operator<<(std::ostream& stream, AssistedSetup assistedSetup) {
    return stream << assistedSetupToString(assistedSetup);
}

class DeviceSetupInterface {
public:
    virtual ~DeviceSetupInterface() = default;

    virtual std::future<bool> sendDeviceSetupComplete(AssistedSetup assistedSetup) = 0;
};

}  // namespace acsdkDeviceSetupInterfaces
}  // namespace alexaClientSDK

#endif  // ACSDKDEVICESETUPINTERFACES_DEVICESETUPINTERFACE_H_