AlexaLauncherInterface.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 ACSDKALEXALAUNCHERINTERFACES_ALEXALAUNCHERINTERFACE_H_
#define ACSDKALEXALAUNCHERINTERFACES_ALEXALAUNCHERINTERFACE_H_

#include <string>
#include <memory>

#include "acsdkAlexaLauncherInterfaces/AlexaLauncherTargetState.h"
#include "acsdkAlexaLauncherInterfaces/AlexaLauncherObserverInterface.h"

namespace alexaClientSDK {
namespace acsdkAlexaLauncherInterfaces {

class AlexaLauncherInterface {
public:
    struct Response {
        enum class Type {
            SUCCESS,

            CONFIRMATION_REQUIRED,

            ALREADY_IN_OPERATION,

            INSUFFICIENT_PERMISSIONS,

            INTERNAL_ERROR,

            INVALID_VALUE,

            NOT_SUPPORTED_IN_CURRENT_MODE
        };

        Response() : type(Type::INTERNAL_ERROR), errorMessage("") {
        }

        Response(Type responseType, std::string message) : type(responseType), errorMessage(std::move(message)) {
        }

        Type type;

        std::string errorMessage;
    };

    virtual ~AlexaLauncherInterface() = default;

    virtual Response launchTarget(const acsdkAlexaLauncherInterfaces::TargetState& targetState) = 0;

    virtual acsdkAlexaLauncherInterfaces::TargetState getLauncherTargetState() = 0;

    virtual bool addObserver(const std::weak_ptr<AlexaLauncherObserverInterface>& observer) = 0;

    virtual void removeObserver(const std::weak_ptr<AlexaLauncherObserverInterface>& observer) = 0;
};

}  // namespace acsdkAlexaLauncherInterfaces
}  // namespace alexaClientSDK

#endif  // ACSDKALEXALAUNCHERINTERFACES_ALEXALAUNCHERINTERFACE_H_