APLViewhostObserverInterface.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_ALEXAPRESENTATION_APLVIEWHOSTOBSERVERINTERFACE_H_
#define ALEXA_CLIENT_SDK_LIBIPCSERVERSAMPLEAPP_INCLUDE_IPCSERVERSAMPLEAPP_ALEXAPRESENTATION_APLVIEWHOSTOBSERVERINTERFACE_H_

#include <memory>
#include <string>

#include <APLClient/AplCommandExecutionEvent.h>

namespace alexaClientSDK {
namespace sampleApplications {
namespace ipcServerSampleApp {
class APLViewhostObserverInterface {
public:
    virtual ~APLViewhostObserverInterface() = default;

    virtual void onCommandExecutionComplete(
        const std::string& token,
        APLClient::AplCommandExecutionEvent event,
        const std::string& message) = 0;

    virtual void onRenderDocumentComplete(
        const std::string& token,
        bool result,
        const std::string& error,
        const std::chrono::steady_clock::time_point& timestamp) = 0;

    virtual void onSendEvent(
        const std::string& token,
        const std::string& arguments,
        const std::string& components,
        const std::string& source) = 0;

    virtual void onVisualContextAvailable(
        const unsigned int requestToken,
        const std::string& token,
        const std::string& version,
        const std::string& visualContext,
        const std::string& datasourceContext) {
        // no-op by default for backwards compatibility
    }

    virtual void onDataSourceUpdateComplete(const std::string& token, bool result, const std::string& error) {
        // no-op by default for backwards compatibility
    }

    virtual void onDataSourceFetch(
        const std::string& token,
        const std::string& dataSourceType,
        const std::string& payload) {
        // no-op by default for backwards compatibility
    }

    virtual void onRuntimeError(const std::string& token, const std::string& payload) {
        // no-op by default for backwards compatibility
    }

    virtual void onDocumentFinished(const std::string& token) {
        // no-op by default for backwards compatibility
    }

    virtual void onOpenURL(const std::string& token, const std::string& url) {
        // no-op by default for compatibility
    }

    virtual void onDocumentCleared(const std::string& token) {
        // no-op by default for compatibility
    }

    virtual void onSetDocumentIdleTimeout(const std::string& token, const std::chrono::milliseconds& timeout) = 0;
};

using APLViewhostObserverInterfacePtr = std::shared_ptr<APLViewhostObserverInterface>;
}  // namespace ipcServerSampleApp
}  // namespace sampleApplications
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_LIBIPCSERVERSAMPLEAPP_INCLUDE_IPCSERVERSAMPLEAPP_ALEXAPRESENTATION_APLVIEWHOSTOBSERVERINTERFACE_H_