text_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_TEXT_INTERFACE_H__
#define __NUGU_TEXT_INTERFACE_H__
 
#include <clientkit/capability_interface.hh>
#include <nugu.h>
 
namespace NuguCapability {
 
using namespace NuguClientKit;
 
#define NUGU_SERVER_RESPONSE_TIMEOUT_SEC 10 
enum class TextState {
    IDLE, 
    BUSY 
};
 
enum class TextError {
    RESPONSE_TIMEOUT 
};
 
typedef struct _TextAttribute {
    int response_timeout; 
} TextAttribute;
 
class NUGU_API ITextListener : virtual public ICapabilityListener {
public:
    virtual ~ITextListener() = default;
 
    virtual void onState(TextState state, const std::string& dialog_id) = 0;
 
    virtual void onComplete(const std::string& dialog_id) = 0;
 
    virtual void onError(TextError error, const std::string& dialog_id) = 0;
 
    virtual bool handleTextCommand(const std::string& text, const std::string& token) = 0;
};
 
class NUGU_API ITextHandler : virtual public ICapabilityInterface {
public:
    virtual ~ITextHandler() = default;
 
    virtual std::string requestTextInput(const std::string& text, const std::string& token = "", const std::string& source = "", bool include_dialog_attribute = true) = 0;
 
    virtual void setAttribute(TextAttribute&& attribute) = 0;
};
 
} // NuguCapability
 
#endif /* __NUGU_TEXT_INTERFACE_H__ */