APLCapabilityAgentObserverInterface.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 ACSDK_APLCAPABILITYCOMMONINTERFACES_APLCAPABILITYAGENTOBSERVERINTERFACE_H_
#define ACSDK_APLCAPABILITYCOMMONINTERFACES_APLCAPABILITYAGENTOBSERVERINTERFACE_H_

#include <chrono>
#include <string>

#include "PresentationSession.h"
#include "APLCapabilityAgentInterface.h"
#include "APLTimeoutType.h"
#include "PresentationToken.h"

namespace alexaClientSDK {
namespace aplCapabilityCommonInterfaces {
class APLCapabilityAgentObserverInterface {
public:
    virtual ~APLCapabilityAgentObserverInterface() = default;

    virtual void onRenderDocument(
        const std::string& document,
        const std::string& datasource,
        const PresentationToken& token,
        const std::string& windowId,
        const APLTimeoutType timeoutType,
        const std::string& interfaceName,
        const std::string& supportedViewports,
        const PresentationSession& presentationSession,
        const std::chrono::steady_clock::time_point& receiveTime,
        std::shared_ptr<APLCapabilityAgentInterface> agent) = 0;

    virtual void onExecuteCommands(const std::string& jsonPayload, const PresentationToken& token) = 0;

    virtual void onDataSourceUpdate(
        const std::string& sourceType,
        const std::string& jsonPayload,
        const PresentationToken& token) = 0;

    virtual void onShowDocument(const PresentationToken& token) = 0;
};

}  // namespace aplCapabilityCommonInterfaces
}  // namespace alexaClientSDK

#endif  // ACSDK_APLCAPABILITYCOMMONINTERFACES_APLCAPABILITYAGENTOBSERVERINTERFACE_H_