chat_ctrl_interface.h

浏览该文件的文档.

// Copyright (c) 2022 NetEase, Inc. All rights reserved.
// Use of this source code is governed by a MIT license that can be
// found in the LICENSE file.
 
#ifndef CHAT_CTRL_INTERFACE_H
#define CHAT_CTRL_INTERFACE_H
 
#include "base_ctrl_interface.h"
#include "base_type_defines.h"
#include "error_code_defines.h"
 
namespace neroom {
 
typedef enum tagNEChatRoomMemberQueryType {
    kNormal, 
    kOnlineNormal, 
    kGuestDesc, 
    kGuestAsc 
} NEChatRoomMemberQueryType;
 
class INERoomChatController : public INEBaseController {
public:
    using NERoomChatCallback = NECallback<>;
    using NERoomChatRoomSendMessageCallback = NECallback<SharedChatMessagePtr>;
    using NERoomChatRoomMemberCallback = NECallback<std::vector<NEChatRoomMember>>;
    using NERoomFetchChatRoomMessageCallback = NECallback<std::list<SharedChatMessagePtr>>;
 
public:
    virtual ~INERoomChatController() = default;
 
    virtual NEChatroomType getChatroomType() const = 0;
 
    virtual void joinChatroom(const NERoomChatCallback& callback) = 0;
 
    virtual void leaveChatroom(const NERoomChatCallback& callback) = 0;
 
    ROOMKIT_DEPRECATED("use sendBroadcastTextMessage with new callback instead")
    virtual void sendBroadcastTextMessage(const std::string& message, const NERoomChatCallback& callback) = 0;
 
    virtual void sendBroadcastTextMessage(const std::string& message, const NERoomChatRoomSendMessageCallback& callback) = 0;
 
    ROOMKIT_DEPRECATED("use sendDirectTextMessage with new callback instead")
    virtual void sendDirectTextMessage(const std::string& userUuid, const std::string& message, const NERoomChatCallback& callback) = 0;
 
    virtual void sendDirectTextMessage(const std::string& userUuid,
        const std::string& message,
        const NERoomChatRoomSendMessageCallback& callback) = 0;
 
    ROOMKIT_DEPRECATED("use sendGroupTextMessage with new callback instead")
    virtual void sendGroupTextMessage(const std::list<std::string>& userUuids, const std::string& message, const NERoomChatCallback& callback) = 0;
 
    virtual void sendGroupTextMessage(const std::list<std::string>& userUuids,
        const std::string& message,
        const NERoomChatRoomSendMessageCallback& callback) = 0;
 
    virtual void fetchChatRoomMembers(NEChatRoomMemberQueryType type, int limit, const NERoomChatRoomMemberCallback& callback) = 0;
 
    virtual void sendTextMessage(const std::string& messageUuid,
        const std::string& message,
        const std::list<std::string>& userUuids,
        const NERoomChatCallback& callback) = 0;
 
    virtual void sendTextMessage(const std::string& messageUuid,
        const std::string& message,
        const std::list<std::string>& userUuids,
        const NERoomChatRoomSendMessageCallback& callback) = 0;
 
    virtual void sendFileMessage(const std::string& messageUuid,
        const std::string& filePath,
        const std::list<std::string>& userUuids,
        const NERoomChatCallback& callback) = 0;
 
    virtual void sendFileMessage(const std::string& messageUuid,
        const std::string& filePath,
        const std::list<std::string>& userUuids,
        const NERoomChatRoomSendMessageCallback& callback) = 0;
 
    virtual void sendImageMessage(const std::string& messageUuid,
        const std::string& imagePath,
        int width,
        int height,
        const std::list<std::string>& userUuids,
        const NERoomChatCallback& callback) = 0;
 
    virtual void sendImageMessage(const std::string& messageUuid,
        const std::string& imagePath,
        int width,
        int height,
        const std::list<std::string>& userUuids,
        const NERoomChatRoomSendMessageCallback& callback) = 0;
 
    virtual void cancelSendFileMessage(const std::string& messageUuid, const NERoomChatCallback& callback) = 0;
 
    virtual void downloadAttachment(const std::string& messageUuid,
        const std::string& fileUrl,
        const std::string& filePath,
        const NERoomChatCallback& callback) = 0;
 
    virtual void cancelDownloadAttachment(const std::string& messageUuid, const NERoomChatCallback& callback) = 0;
 
    virtual void fetchChatroomHistoryMessages(NEHistoryMessageSearchOption option, const NERoomFetchChatRoomMessageCallback& callback) = 0;
 
    virtual void recallChatroomMessage(const std::string& messageUUID, time_t messageTime, const NERoomChatCallback& callback) = 0;
 
    virtual void fetchChatroomHistoryMessagesByTags(const NEHistoryMessageSearchOptionByTags& option,
        const NERoomFetchChatRoomMessageCallback& callback) = 0;
    virtual void sendBroadcastCustomMessage(const std::string& message, const NERoomChatRoomSendMessageCallback& callback) = 0;
};
 
}  // namespace neroom
 
#endif  // CHAT_CTRL_INTERFACE_H