GUIClientInterface.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_LIBIPCSERVERSAMPLEAPP_INCLUDE_IPCSERVERSAMPLEAPP_GUI_GUICLIENTINTERFACE_H_
#define ALEXA_CLIENT_SDK_LIBIPCSERVERSAMPLEAPP_INCLUDE_IPCSERVERSAMPLEAPP_GUI_GUICLIENTINTERFACE_H_

#include <rapidjson/document.h>

#include <AVSCommon/AVS/FocusState.h>
#ifdef ENABLE_COMMS
#include <AVSCommon/SDKInterfaces/CallStateObserverInterface.h>
#endif
#include <AVSCommon/SDKInterfaces/ChannelObserverInterface.h>

#include <acsdk/APLCapabilityCommonInterfaces/VisualStateProviderInterface.h>

#include "IPCServerSampleApp/IPC/IPCRouter.h"
#include "IPCServerSampleApp/Messages/Message.h"

#include "GUIServerInterface.h"

namespace alexaClientSDK {
namespace sampleApplications {
namespace ipcServerSampleApp {
namespace gui {

// TODO: Elaborate the requirements for an implementation of GUIClientInterface (ARC-905)
class GUIClientInterface {
public:
    using GUIToken = uint64_t;

    virtual ~GUIClientInterface() = default;

    virtual void setGUIManager(std::shared_ptr<gui::GUIServerInterface> guiManager) = 0;

    virtual bool acquireFocus(
        std::string avsInterface,
        std::string channelName,
        avsCommon::avs::ContentType contentType,
        std::shared_ptr<avsCommon::sdkInterfaces::ChannelObserverInterface> channelObserver) = 0;

    virtual bool releaseFocus(
        std::string avsInterface,
        std::string channelName,
        std::shared_ptr<avsCommon::sdkInterfaces::ChannelObserverInterface> channelObserver) = 0;

#ifdef ENABLE_COMMS
    virtual void sendCallStateInfo(
        const avsCommon::sdkInterfaces::CallStateObserverInterface::CallStateInfo& callStateInfo) = 0;
#endif

    virtual void sendMessage(messages::MessageInterface& message) = 0;

    virtual bool finalizeClientInitialization(bool errorState) = 0;

    virtual void handleInitializeAPLRenderers(rapidjson::Document& payload) = 0;

    virtual void handleDisplayMetrics(rapidjson::Document& payload) = 0;

    virtual void handleAplEvent(rapidjson::Document& payload) = 0;

    virtual void handleRenderComplete(rapidjson::Document& payload) = 0;

    virtual void handleLocalRenderDocument(rapidjson::Document& payload) = 0;

    virtual void handleLocalExecuteCommands(rapidjson::Document& payload) = 0;

    virtual void handleLocalClearDocument(rapidjson::Document& payload) = 0;

    virtual void handleOnFocusChangedReceivedConfirmation(GUIToken token) = 0;

    virtual void focusAcquireRequest(
        const GUIToken token,
        const std::string& avsInterface,
        const std::string& channelName,
        avsCommon::avs::ContentType contentType) = 0;

    virtual void focusReleaseRequest(
        const GUIToken token,
        const std::string& avsInterface,
        const std::string& channelName) = 0;

    virtual void setLocales(const std::string& localeStr) = 0;

    virtual std::shared_ptr<ipc::IPCRouter> getIPCRouter() = 0;
};

}  // namespace gui
}  // namespace ipcServerSampleApp
}  // namespace sampleApplications
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_LIBIPCSERVERSAMPLEAPP_INCLUDE_IPCSERVERSAMPLEAPP_GUI_GUICLIENTINTERFACE_H_