PresentationOptions.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_PRESENTATIONOPTIONS_H_
#define ACSDKALEXAPRESENTATIONINTERFACES_PRESENTATIONOPTIONS_H_

#include <chrono>
#include <string>
#include <vector>

namespace alexaClientSDK {
namespace acsdkAlexaPresentationInterfaces {

enum class VisualFocusBehavior {
    MAY_BACKGROUND,

    MUST_DISMISS,

    ALWAYS_FOREGROUND
};

enum class PresentationLifespan {
    TRANSIENT,

    SHORT,

    LONG,

    PERMANENT
};

struct PresentationOptions {
    std::string windowId;

    std::chrono::milliseconds timeout;

    VisualFocusBehavior visualFocusBehavior;

    std::string interface;

    std::string token;

    PresentationLifespan lifespan;

    std::chrono::steady_clock::time_point documentReceivedTimestamp;
};

}  // namespace acsdkAlexaPresentationInterfaces
}  // namespace alexaClientSDK

#endif  // ACSDKALEXAPRESENTATIONINTERFACES_PRESENTATIONOPTIONS_H_