ichatroom.h

Go to the documentation of this file.

/********************************************************************************************
 * Twitch Broadcasting SDK
 *
 * This software is supplied under the terms of a license agreement with Twitch Interactive, Inc. and
 * may not be copied or used except in accordance with the terms of that agreement
 * Copyright (c) 2017 Twitch Interactive, Inc.
 *********************************************************************************************/

#pragma once

#include "twitchsdk/chat/chattypes.h"

namespace ttv
{
    namespace chat
    {
        class IChatRoom;
    }
}


class ttv::chat::IChatRoom
{
public:
    
    using DeleteRoomCallback = std::function<void(TTV_ErrorCode ec)>;
    
    using SendMessageCallback = std::function<void(TTV_ErrorCode ec, SendRoomMessageError&& error, ChatRoomMessage&& message)>;
    
    using EditMessageCallback = std::function<void(TTV_ErrorCode ec, ChatRoomMessage&& message)>;
    
    using DeleteMessageCallback = std::function<void(TTV_ErrorCode ec)>;
    
    using FetchMessagesCallback = std::function<void(TTV_ErrorCode ec, std::vector<ChatRoomMessage>&& messages, std::string&& nextCursor, bool moreMessages)>;
    
    using UpdateRoomInfoCallback = std::function<void(TTV_ErrorCode ec, UpdateRoomError&& error, ChatRoomInfo&& info)>;
    
    using UpdateRoomModesCallback = std::function<void(TTV_ErrorCode ec, UpdateRoomModesError&& error, ChatRoomInfo&& info)>;
    
    using UpdateRoomViewCallback = std::function<void(TTV_ErrorCode ec, ChatRoomInfo&& info)>;
    
    using FetchRoomInfoCallback = std::function<void(TTV_ErrorCode ec, ChatRoomInfo&& info)>;
    
    virtual ~IChatRoom() = default;
    
    virtual TTV_ErrorCode Dispose() = 0;

    virtual TTV_ErrorCode DeleteRoom(const DeleteRoomCallback& callback) = 0;
    
    virtual TTV_ErrorCode SendMessage(const std::string& message, ChatRoomMessage& placeholderMessage, const SendMessageCallback& callback) = 0;
    
    virtual TTV_ErrorCode EditMessage(const std::string& messageId, const std::string& message, ChatRoomMessage& placeholderMessage, const EditMessageCallback& callback) = 0;
    
    virtual TTV_ErrorCode DeleteMessage(const std::string& messageId, const DeleteMessageCallback& callback) = 0;
    
    virtual TTV_ErrorCode FetchMessagesBeforeCursor(const std::string& cursor, uint32_t limit, const FetchMessagesCallback& callback) = 0;
    
    virtual TTV_ErrorCode FetchMessagesAfterCursor(const std::string& cursor, uint32_t limit, const FetchMessagesCallback& callback) = 0;
    
    virtual TTV_ErrorCode FetchMessagesBeforeTimestamp(Timestamp timestamp, uint32_t limit, const FetchMessagesCallback& callback) = 0;
    
    virtual TTV_ErrorCode FetchMessagesAfterTimestamp(Timestamp timestamp, uint32_t limit, const FetchMessagesCallback& callback) = 0;

    virtual TTV_ErrorCode FetchRoomInfo(const FetchRoomInfoCallback& callback) = 0;

    virtual TTV_ErrorCode SetRoomName(const std::string& name, const UpdateRoomInfoCallback& callback) = 0;
    
    virtual TTV_ErrorCode SetTopic(const std::string& topic, const UpdateRoomInfoCallback& callback) = 0;
    
    virtual TTV_ErrorCode SetPreviewable(bool isPreviewable, const UpdateRoomInfoCallback& callback) = 0;
    
    virtual TTV_ErrorCode SetMinimumAllowedRole(RoomRole minimumAllowedRole, const UpdateRoomInfoCallback& callback) = 0;
    
    virtual TTV_ErrorCode EnableSlowMode(uint32_t durationSeconds, const UpdateRoomModesCallback& callback) = 0;
    
    virtual TTV_ErrorCode DisableSlowMode(const UpdateRoomModesCallback& callback) = 0;
    
    virtual TTV_ErrorCode EnableR9kMode(const UpdateRoomModesCallback& callback) = 0;
    
    virtual TTV_ErrorCode DisableR9kMode(const UpdateRoomModesCallback& callback) = 0;
    
    virtual TTV_ErrorCode EnableEmotesOnlyMode(const UpdateRoomModesCallback& callback) = 0;
    
    virtual TTV_ErrorCode DisableEmotesOnlyMode(const UpdateRoomModesCallback& callback) = 0;
    
    virtual TTV_ErrorCode SetLastReadAt(Timestamp lastReadAt, const UpdateRoomViewCallback& callback) = 0;
    
    virtual TTV_ErrorCode SetMuted(bool isMuted, const UpdateRoomViewCallback& callback) = 0;
    
    virtual TTV_ErrorCode SetArchived(bool isArchived, const UpdateRoomViewCallback& callback) = 0;
};