APLDocumentSessionInterface.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_APLDOCUMENTSESSIONINTERFACE_H_
#define ACSDK_APLCAPABILITYCOMMONINTERFACES_APLDOCUMENTSESSIONINTERFACE_H_

#include <chrono>
#include <string>

#include <AVSCommon/SDKInterfaces/ContextRequestToken.h>
#include <acsdk/PresentationOrchestratorInterfaces/PresentationTypes.h>

#include "PresentationSession.h"
#include "PresentationOptions.h"

namespace alexaClientSDK {
namespace aplCapabilityCommonInterfaces {

class APLDocumentSessionInterface {
public:
    virtual ~APLDocumentSessionInterface() = default;

    virtual void clearDocument() = 0;

    virtual void executeCommands(const std::string& commands) = 0;

    virtual void dataSourceUpdate(const std::string& sourceType, const std::string& payload) = 0;

    virtual void interruptCommandSequence() = 0;

    virtual void provideDocumentContext(const avsCommon::sdkInterfaces::ContextRequestToken stateRequestToken) = 0;

    virtual void requestForeground() = 0;

    virtual void updateTimeout(std::chrono::milliseconds timeout) = 0;

    virtual void stopTimeout() = 0;

    virtual void resetTimeout() = 0;

    virtual void updateLifespan(presentationOrchestratorInterfaces::PresentationLifespan lifespan) = 0;

    virtual PresentationToken getToken() const = 0;

    virtual bool isForegroundFocused() = 0;
};

}  // namespace aplCapabilityCommonInterfaces
}  // namespace alexaClientSDK

#endif  // ACSDK_APLCAPABILITYCOMMONINTERFACES_APLDOCUMENTSESSIONINTERFACE_H_