display_interface.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2019 SK Telecom Co., Ltd. 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.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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 __NUGU_DISPLAY_INTERFACE_H__
#define __NUGU_DISPLAY_INTERFACE_H__
 
#include <clientkit/capability_interface.hh>
 
namespace NuguCapability {
 
using namespace NuguClientKit;
 
enum class ControlDirection {
    PREVIOUS, 
    NEXT 
};
 
enum class ControlType {
    Focus, 
    Scroll, 
};
 
enum class TemplateControlType {
    TEMPLATE_PREVIOUS, 
    TEMPLATE_CLOSEALL 
};
 
typedef struct _DisplayContextInfo {
    std::string focused_item_token; 
    std::vector<std::string> visible_token_list; 
} DisplayContextInfo;
 
class IDisplayListener : virtual public ICapabilityListener {
public:
    virtual ~IDisplayListener() = default;
    virtual void renderDisplay(const std::string& id, const std::string& type, const std::string& json_payload, const std::string& dialog_id) = 0;
 
    virtual bool clearDisplay(const std::string& id, bool unconditionally, bool has_next) = 0;
 
    virtual void controlDisplay(const std::string& id, ControlType type, ControlDirection direction) = 0;
 
    virtual void updateDisplay(const std::string& id, const std::string& json_payload) = 0;
};
 
class IDisplayHandler : virtual public ICapabilityInterface {
public:
    virtual ~IDisplayHandler() = default;
 
    virtual void displayRendered(const std::string& id, const DisplayContextInfo& context_info = DisplayContextInfo {});
 
    virtual void displayCleared(const std::string& id);
 
    virtual void elementSelected(const std::string& id, const std::string& item_token, const std::string& postback = "");
 
    virtual void triggerChild(const std::string& ps_id, const std::string& data);
 
    virtual void controlTemplate(const std::string& id, TemplateControlType control_type);
 
    virtual void informControlResult(const std::string& id, ControlType type, ControlDirection direction, bool result);
 
    virtual void setDisplayListener(IDisplayListener* listener);
 
    virtual void removeDisplayListener(IDisplayListener* listener);
 
    virtual void stopRenderingTimer(const std::string& id);
 
    virtual void refreshRenderingTimer(const std::string& id);
};
 
} // NuguCapability
 
#endif /* __NUGU_DISPLAY_INTERFACE_H__ */