APLCapabilityAgentInterface.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_APLCAPABILITYAGENTINTERFACE_H_
#define ACSDK_APLCAPABILITYCOMMONINTERFACES_APLCAPABILITYAGENTINTERFACE_H_

#include <chrono>
#include <memory>
#include <string>

#include <AVSCommon/SDKInterfaces/ContextRequestToken.h>
#include <AVSCommon/SDKInterfaces/GUIActivityEvent.h>

#include "PresentationSession.h"
#include "APLEventPayload.h"
#include "PresentationToken.h"
#include "APLCommandExecutionEvent.h"

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

    virtual void onActiveDocumentChanged(const PresentationToken& token, const PresentationSession& session) = 0;

    virtual void clearExecuteCommands(
        const PresentationToken& token = std::string(),
        const bool markAsFailed = true) = 0;

    virtual void sendUserEvent(const aplEventPayload::UserEvent& payload) = 0;

    virtual void sendDataSourceFetchRequestEvent(const aplEventPayload::DataSourceFetch& payload) = 0;

    virtual void sendRuntimeErrorEvent(const aplEventPayload::RuntimeError& payload) = 0;

    virtual void onVisualContextAvailable(
        avsCommon::sdkInterfaces::ContextRequestToken requestToken,
        const aplEventPayload::VisualContext& visualContext) = 0;

    virtual void processRenderDocumentResult(
        const PresentationToken& token,
        const bool result,
        const std::string& error) = 0;

    virtual void processExecuteCommandsResult(
        const PresentationToken& token,
        APLCommandExecutionEvent event,
        const std::string& error) = 0;

    virtual void recordRenderComplete(const std::chrono::steady_clock::time_point& timestamp) = 0;

    virtual void proactiveStateReport() = 0;
};
}  // namespace aplCapabilityCommonInterfaces
}  // namespace alexaClientSDK
#endif  // ACSDK_APLCAPABILITYCOMMONINTERFACES_APLCAPABILITYAGENTINTERFACE_H_