PresentationInterface.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_AVS_SHARED_PRESENTATIONORCHESTRATOR_PRESENTATIONORCHESTRATORINTERFACES_INCLUDE_ACSDK_PRESENTATIONORCHESTRATORINTERFACES_PRESENTATIONINTERFACE_H_
#define ALEXA_CLIENT_SDK_AVS_SHARED_PRESENTATIONORCHESTRATOR_PRESENTATIONORCHESTRATORINTERFACES_INCLUDE_ACSDK_PRESENTATIONORCHESTRATORINTERFACES_PRESENTATIONINTERFACE_H_

#include <chrono>
#include <string>

#include "PresentationTypes.h"

namespace alexaClientSDK {
namespace presentationOrchestratorInterfaces {
class PresentationInterface {
public:
    virtual ~PresentationInterface() = default;

    static const std::chrono::milliseconds getTimeoutDisabled() {
        static const std::chrono::milliseconds TIMEOUT_DISABLED = std::chrono::milliseconds::max();
        return TIMEOUT_DISABLED;
    }

    static const std::chrono::milliseconds getTimeoutDefault() {
        static const std::chrono::milliseconds TIMEOUT_DEFAULT{-1};
        return TIMEOUT_DEFAULT;
    }

    virtual void dismiss() = 0;

    virtual void foreground() = 0;

    virtual void setMetadata(const std::string& metadata) = 0;

    virtual void setLifespan(const PresentationLifespan& lifespan) = 0;

    virtual void startTimeout() = 0;

    virtual void stopTimeout() = 0;

    virtual void setTimeout(const std::chrono::milliseconds& timeout) = 0;

    virtual PresentationState getState() = 0;
};
}  // namespace presentationOrchestratorInterfaces
}  // namespace alexaClientSDK
#endif  // ALEXA_CLIENT_SDK_AVS_SHARED_PRESENTATIONORCHESTRATOR_PRESENTATIONORCHESTRATORINTERFACES_INCLUDE_ACSDK_PRESENTATIONORCHESTRATORINTERFACES_PRESENTATIONINTERFACE_H_