message_interface.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2021 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_MESSAGE_INTERFACE_H__
#define __NUGU_MESSAGE_INTERFACE_H__
 
#include <clientkit/capability.hh>
#include <nugu.h>
 
namespace NuguCapability {
 
using namespace NuguClientKit;
 
enum class MessageState {
    MESSAGE_SPEECH_START, 
    MESSAGE_SPEECH_STOP, 
    MESSAGE_SPEECH_FINISH 
};
 
class NUGU_API IMessageListener : virtual public ICapabilityListener {
public:
    virtual ~IMessageListener() = default;
 
    virtual void processSendCandidates(const std::string& payload) = 0;
 
    virtual void processSendMessage(const std::string& payload) = 0;
 
    virtual void processGetMessage(const std::string& payload) = 0;
 
    virtual void messageStateChanged(MessageState state, const std::string& received_time, const std::string& token, const std::string& dialog_id) = 0;
};
 
class NUGU_API IMessageHandler : virtual public ICapabilityInterface {
public:
    virtual ~IMessageHandler() = default;
 
    virtual void candidatesListed(const std::string& context_template, const std::string& payload) = 0;
 
    virtual void sendMessageSucceeded(const std::string& payload) = 0;
 
    virtual void sendMessageFailed(const std::string& payload) = 0;
 
    virtual void getMessageSucceeded(const std::string& payload) = 0;
 
    virtual void getMessageFailed(const std::string& payload) = 0;
};
 
} // NuguCapability
 
#endif /* __NUGU_MESSAGE_INTERFACE_H__ */