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 ACSDKALEXAPRESENTATIONINTERFACES_APLDOCUMENTSESSIONINTERFACE_H_
#define ACSDKALEXAPRESENTATIONINTERFACES_APLDOCUMENTSESSIONINTERFACE_H_

#include <acsdkAlexaPresentationInterfaces/PresentationOptions.h>

#include <chrono>
#include <string>

namespace alexaClientSDK {
namespace acsdkAlexaPresentationInterfaces {

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 unsigned int stateRequestToken) = 0;

    virtual void requestForeground() = 0;

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

    virtual std::string getToken() const = 0;

    virtual void updateLifespan(PresentationLifespan lifespan){
        // no-op for backwards compatibility
    };
};

}  // namespace acsdkAlexaPresentationInterfaces
}  // namespace alexaClientSDK

#endif  // ACSDKALEXAPRESENTATIONINTERFACES_APLDOCUMENTSESSIONINTERFACE_H_