IChat.h

Go to the documentation of this file.

#ifndef GALAXY_I_CHAT_H
#define GALAXY_I_CHAT_H
 
#include "IListenerRegistrar.h"
#include "GalaxyID.h"
 
namespace galaxy
{
    namespace api
    {
        typedef uint64_t ChatRoomID;
 
        typedef uint64_t ChatMessageID;
 
        enum ChatMessageType
        {
            CHAT_MESSAGE_TYPE_UNKNOWN, 
            CHAT_MESSAGE_TYPE_CHAT_MESSAGE, 
            CHAT_MESSAGE_TYPE_GAME_INVITATION 
        };
 
        class IChatRoomWithUserRetrieveListener : public GalaxyTypeAwareListener<CHAT_ROOM_WITH_USER_RETRIEVE_LISTENER>
        {
        public:
 
            virtual void OnChatRoomWithUserRetrieveSuccess(GalaxyID userID, ChatRoomID chatRoomID) = 0;
 
            enum FailureReason
            {
                FAILURE_REASON_UNDEFINED, 
                FAILURE_REASON_FORBIDDEN, 
                FAILURE_REASON_CONNECTION_FAILURE 
            };
 
            virtual void OnChatRoomWithUserRetrieveFailure(GalaxyID userID, FailureReason failureReason) = 0;
        };
 
        typedef SelfRegisteringListener<IChatRoomWithUserRetrieveListener> GlobalChatRoomWithUserRetrieveListener;
 
        class IChatRoomMessageSendListener : public GalaxyTypeAwareListener<CHAT_ROOM_MESSAGE_SEND_LISTENER>
        {
        public:
 
            virtual void OnChatRoomMessageSendSuccess(ChatRoomID chatRoomID, uint32_t sentMessageIndex, ChatMessageID messageID, uint32_t sendTime) = 0;
 
            enum FailureReason
            {
                FAILURE_REASON_UNDEFINED, 
                FAILURE_REASON_FORBIDDEN, 
                FAILURE_REASON_CONNECTION_FAILURE 
            };
 
            virtual void OnChatRoomMessageSendFailure(ChatRoomID chatRoomID, uint32_t sentMessageIndex, FailureReason failureReason) = 0;
        };
 
        typedef SelfRegisteringListener<IChatRoomMessageSendListener> GlobalChatRoomMessageSendListener;
 
        class IChatRoomMessagesListener : public GalaxyTypeAwareListener<CHAT_ROOM_MESSAGES_LISTENER>
        {
        public:
 
            virtual void OnChatRoomMessagesReceived(ChatRoomID chatRoomID, uint32_t messageCount, uint32_t longestMessageLenght) = 0;
        };
 
        typedef SelfRegisteringListener<IChatRoomMessagesListener> GlobalChatRoomMessagesListener;
 
        class IChatRoomMessagesRetrieveListener : public GalaxyTypeAwareListener<CHAT_ROOM_MESSAGES_RETRIEVE_LISTENER>
        {
        public:
 
            virtual void OnChatRoomMessagesRetrieveSuccess(ChatRoomID chatRoomID, uint32_t messageCount, uint32_t longestMessageLenght) = 0;
 
            enum FailureReason
            {
                FAILURE_REASON_UNDEFINED, 
                FAILURE_REASON_FORBIDDEN, 
                FAILURE_REASON_CONNECTION_FAILURE 
            };
 
            virtual void OnChatRoomMessagesRetrieveFailure(ChatRoomID chatRoomID, FailureReason failureReason) = 0;
        };
 
        typedef SelfRegisteringListener<IChatRoomMessagesRetrieveListener> GlobalChatRoomMessagesRetrieveListener;
 
        class IChat
        {
        public:
 
            virtual ~IChat()
            {
            }
 
            virtual void RequestChatRoomWithUser(GalaxyID userID, IChatRoomWithUserRetrieveListener* const listener = NULL) = 0;
 
            virtual void RequestChatRoomMessages(ChatRoomID chatRoomID, uint32_t limit, ChatMessageID referenceMessageID = 0, IChatRoomMessagesRetrieveListener* const listener = NULL) = 0;
 
            virtual uint32_t SendChatRoomMessage(ChatRoomID chatRoomID, const char* msg, IChatRoomMessageSendListener* const listener = NULL) = 0;
 
            virtual uint32_t GetChatRoomMessageByIndex(uint32_t index, ChatMessageID& messageID, ChatMessageType& messageType, GalaxyID& senderID, uint32_t& sendTime, char* buffer, uint32_t bufferLength) = 0;
 
            virtual uint32_t GetChatRoomMemberCount(ChatRoomID chatRoomID) = 0;
 
            virtual GalaxyID GetChatRoomMemberUserIDByIndex(ChatRoomID chatRoomID, uint32_t index) = 0;
 
            virtual uint32_t GetChatRoomUnreadMessageCount(ChatRoomID chatRoomID) = 0;
 
            virtual void MarkChatRoomAsRead(ChatRoomID chatRoomID) = 0;
        };
 
    }
}
 
#endif