IFriends.h

Go to the documentation of this file.

#ifndef GALAXY_I_FRIENDS_H
#define GALAXY_I_FRIENDS_H
 
#include "GalaxyID.h"
#include "IListenerRegistrar.h"
 
namespace galaxy
{
    namespace api
    {
        enum AvatarType
        {
            AVATAR_TYPE_NONE = 0x0000, 
            AVATAR_TYPE_SMALL = 0x0001, 
            AVATAR_TYPE_MEDIUM = 0x0002, 
            AVATAR_TYPE_LARGE = 0x0004 
        };
 
        typedef uint32_t AvatarCriteria;
 
        enum PersonaState
        {
            PERSONA_STATE_OFFLINE, 
            PERSONA_STATE_ONLINE 
        };
 
        class IPersonaDataChangedListener : public GalaxyTypeAwareListener<PERSONA_DATA_CHANGED>
        {
        public:
 
            enum PersonaStateChange
            {
                PERSONA_CHANGE_NONE = 0x0000, 
                PERSONA_CHANGE_NAME = 0x0001, 
                PERSONA_CHANGE_AVATAR = 0x0002, 
                PERSONA_CHANGE_AVATAR_DOWNLOADED_IMAGE_SMALL = 0x0004, 
                PERSONA_CHANGE_AVATAR_DOWNLOADED_IMAGE_MEDIUM = 0x0008, 
                PERSONA_CHANGE_AVATAR_DOWNLOADED_IMAGE_LARGE = 0x0010, 
                PERSONA_CHANGE_AVATAR_DOWNLOADED_IMAGE_ANY = PERSONA_CHANGE_AVATAR_DOWNLOADED_IMAGE_SMALL | PERSONA_CHANGE_AVATAR_DOWNLOADED_IMAGE_MEDIUM | PERSONA_CHANGE_AVATAR_DOWNLOADED_IMAGE_LARGE 
            };
 
            virtual void OnPersonaDataChanged(GalaxyID userID, uint32_t personaStateChange) = 0;
        };
 
        typedef SelfRegisteringListener<IPersonaDataChangedListener> GlobalPersonaDataChangedListener;
 
        class IUserInformationRetrieveListener : public GalaxyTypeAwareListener<USER_INFORMATION_RETRIEVE_LISTENER>
        {
        public:
 
            virtual void OnUserInformationRetrieveSuccess(GalaxyID userID) = 0;
 
            enum FailureReason
            {
                FAILURE_REASON_UNDEFINED, 
                FAILURE_REASON_CONNECTION_FAILURE 
            };
 
            virtual void OnUserInformationRetrieveFailure(GalaxyID userID, FailureReason failureReason) = 0;
        };
 
        typedef SelfRegisteringListener<IUserInformationRetrieveListener> GlobalUserInformationRetrieveListener;
 
        class IFriendListListener : public GalaxyTypeAwareListener<FRIEND_LIST_RETRIEVE>
        {
        public:
 
            virtual void OnFriendListRetrieveSuccess() = 0;
 
            enum FailureReason
            {
                FAILURE_REASON_UNDEFINED, 
                FAILURE_REASON_CONNECTION_FAILURE 
            };
 
            virtual void OnFriendListRetrieveFailure(FailureReason failureReason) = 0;
        };
 
        typedef SelfRegisteringListener<IFriendListListener> GlobalFriendListListener;
 
        class IFriendInvitationSendListener : public GalaxyTypeAwareListener<FRIEND_INVITATION_SEND_LISTENER>
        {
        public:
 
            virtual void OnFriendInvitationSendSuccess(GalaxyID userID) = 0;
 
            enum FailureReason
            {
                FAILURE_REASON_UNDEFINED, 
                FAILURE_REASON_USER_DOES_NOT_EXIST, 
                FAILURE_REASON_USER_ALREADY_INVITED, 
                FAILURE_REASON_USER_ALREADY_FRIEND, 
                FAILURE_REASON_CONNECTION_FAILURE 
            };
 
            virtual void OnFriendInvitationSendFailure(GalaxyID userID, FailureReason failureReason) = 0;
        };
 
        typedef SelfRegisteringListener<IFriendInvitationSendListener> GlobalFriendInvitationSendListener;
 
        class IFriendInvitationListRetrieveListener : public GalaxyTypeAwareListener<FRIEND_INVITATION_LIST_RETRIEVE_LISTENER>
        {
        public:
 
            virtual void OnFriendInvitationListRetrieveSuccess() = 0;
 
            enum FailureReason
            {
                FAILURE_REASON_UNDEFINED, 
                FAILURE_REASON_CONNECTION_FAILURE 
            };
 
            virtual void OnFriendInvitationListRetrieveFailure(FailureReason failureReason) = 0;
 
        };
 
        typedef SelfRegisteringListener<IFriendInvitationListRetrieveListener> GlobalFriendInvitationListRetrieveListener;
 
        class ISentFriendInvitationListRetrieveListener : public GalaxyTypeAwareListener<SENT_FRIEND_INVITATION_LIST_RETRIEVE_LISTENER>
        {
        public:
 
            virtual void OnSentFriendInvitationListRetrieveSuccess() = 0;
 
            enum FailureReason
            {
                FAILURE_REASON_UNDEFINED, 
                FAILURE_REASON_CONNECTION_FAILURE 
            };
 
            virtual void OnSentFriendInvitationListRetrieveFailure(FailureReason failureReason) = 0;
        };
 
        typedef SelfRegisteringListener<ISentFriendInvitationListRetrieveListener> GlobalSentFriendInvitationListRetrieveListener;
 
        class IFriendInvitationListener : public GalaxyTypeAwareListener<FRIEND_INVITATION_LISTENER>
        {
        public:
 
            virtual void OnFriendInvitationReceived(GalaxyID userID, uint32_t sendTime) = 0;
        };
 
        typedef SelfRegisteringListener<IFriendInvitationListener> GlobalFriendInvitationListener;
 
        class IFriendInvitationRespondToListener : public GalaxyTypeAwareListener<FRIEND_INVITATION_RESPOND_TO_LISTENER>
        {
        public:
 
            virtual void OnFriendInvitationRespondToSuccess(GalaxyID userID, bool accept) = 0;
 
            enum FailureReason
            {
                FAILURE_REASON_UNDEFINED, 
                FAILURE_REASON_USER_DOES_NOT_EXIST, 
                FAILURE_REASON_FRIEND_INVITATION_DOES_NOT_EXIST, 
                FAILURE_REASON_USER_ALREADY_FRIEND, 
                FAILURE_REASON_CONNECTION_FAILURE 
            };
 
            virtual void OnFriendInvitationRespondToFailure(GalaxyID userID, FailureReason failureReason) = 0;
        };
 
        typedef SelfRegisteringListener<IFriendInvitationRespondToListener> GlobalFriendInvitationRespondToListener;
 
        class IFriendAddListener : public GalaxyTypeAwareListener<FRIEND_ADD_LISTENER>
        {
        public:
 
            enum InvitationDirection
            {
                INVITATION_DIRECTION_INCOMING, 
                INVITATION_DIRECTION_OUTGOING 
            };
 
            virtual void OnFriendAdded(GalaxyID userID, InvitationDirection invitationDirection) = 0;
        };
 
        typedef SelfRegisteringListener<IFriendAddListener> GlobalFriendAddListener;
 
        class IFriendDeleteListener : public GalaxyTypeAwareListener<FRIEND_DELETE_LISTENER>
        {
        public:
 
            virtual void OnFriendDeleteSuccess(GalaxyID userID) = 0;
 
            enum FailureReason
            {
                FAILURE_REASON_UNDEFINED, 
                FAILURE_REASON_CONNECTION_FAILURE 
            };
 
            virtual void OnFriendDeleteFailure(GalaxyID userID, FailureReason failureReason) = 0;
        };
 
        typedef SelfRegisteringListener<IFriendDeleteListener> GlobalFriendDeleteListener;
 
        class IRichPresenceChangeListener : public GalaxyTypeAwareListener<RICH_PRESENCE_CHANGE_LISTENER>
        {
        public:
 
            virtual void OnRichPresenceChangeSuccess() = 0;
 
            enum FailureReason
            {
                FAILURE_REASON_UNDEFINED, 
                FAILURE_REASON_CONNECTION_FAILURE 
            };
 
            virtual void OnRichPresenceChangeFailure(FailureReason failureReason) = 0;
        };
 
        typedef SelfRegisteringListener<IRichPresenceChangeListener> GlobalRichPresenceChangeListener;
 
        class IRichPresenceListener : public GalaxyTypeAwareListener<RICH_PRESENCE_LISTENER>
        {
        public:
 
            virtual void OnRichPresenceUpdated(GalaxyID userID) = 0;
        };
 
        typedef SelfRegisteringListener<IRichPresenceListener> GlobalRichPresenceListener;
 
        class IRichPresenceRetrieveListener : public GalaxyTypeAwareListener<RICH_PRESENCE_RETRIEVE_LISTENER>
        {
        public:
 
            virtual void OnRichPresenceRetrieveSuccess(GalaxyID userID) = 0;
 
            enum FailureReason
            {
                FAILURE_REASON_UNDEFINED, 
                FAILURE_REASON_CONNECTION_FAILURE 
            };
 
            virtual void OnRichPresenceRetrieveFailure(GalaxyID userID, FailureReason failureReason) = 0;
        };
 
        typedef SelfRegisteringListener<IRichPresenceRetrieveListener> GlobalRichPresenceRetrieveListener;
 
        class IGameJoinRequestedListener : public GalaxyTypeAwareListener<GAME_JOIN_REQUESTED_LISTENER>
        {
        public:
 
            virtual void OnGameJoinRequested(GalaxyID userID, const char* connectionString) = 0;
        };
 
        typedef SelfRegisteringListener<IGameJoinRequestedListener> GlobalGameJoinRequestedListener;
 
        class IGameInvitationReceivedListener : public GalaxyTypeAwareListener<GAME_INVITATION_RECEIVED_LISTENER>
        {
        public:
 
            virtual void OnGameInvitationReceived(GalaxyID userID, const char* connectionString) = 0;
        };
 
        typedef SelfRegisteringListener<IGameInvitationReceivedListener> GlobalGameInvitationReceivedListener;
 
        class ISendInvitationListener : public GalaxyTypeAwareListener<INVITATION_SEND>
        {
        public:
 
            virtual void OnInvitationSendSuccess(GalaxyID userID, const char* connectionString) = 0;
 
            enum FailureReason
            {
                FAILURE_REASON_UNDEFINED, 
                FAILURE_REASON_USER_DOES_NOT_EXIST, 
                FAILURE_REASON_RECEIVER_DOES_NOT_ALLOW_INVITING, 
                FAILURE_REASON_SENDER_DOES_NOT_ALLOW_INVITING, 
                FAILURE_REASON_RECEIVER_BLOCKED, 
                FAILURE_REASON_SENDER_BLOCKED, 
                FAILURE_REASON_CONNECTION_FAILURE 
            };
 
            virtual void OnInvitationSendFailure(GalaxyID userID, const char* connectionString, FailureReason failureReason) = 0;
        };
 
        typedef SelfRegisteringListener<ISendInvitationListener> GlobalSendInvitationListener;
 
        class IUserFindListener : public GalaxyTypeAwareListener<USER_FIND_LISTENER>
        {
        public:
 
            virtual void OnUserFindSuccess(const char* userSpecifier, GalaxyID userID) = 0;
 
            enum FailureReason
            {
                FAILURE_REASON_UNDEFINED, 
                FAILURE_REASON_USER_NOT_FOUND, 
                FAILURE_REASON_CONNECTION_FAILURE 
            };
 
            virtual void OnUserFindFailure(const char* userSpecifier, FailureReason failureReason) = 0;
        };
 
        typedef SelfRegisteringListener<IUserFindListener> GlobalUserFindListener;
 
        class IFriends
        {
        public:
 
            virtual ~IFriends()
            {
            }
 
            virtual AvatarCriteria GetDefaultAvatarCriteria() = 0;
 
            virtual void SetDefaultAvatarCriteria(AvatarCriteria defaultAvatarCriteria) = 0;
 
            virtual void RequestUserInformation(
                GalaxyID userID,
                AvatarCriteria avatarCriteria = AVATAR_TYPE_NONE,
                IUserInformationRetrieveListener* const listener = NULL) = 0;
 
            virtual bool IsUserInformationAvailable(GalaxyID userID) = 0;
 
            virtual const char* GetPersonaName() = 0;
 
            virtual void GetPersonaNameCopy(char* buffer, uint32_t bufferLength) = 0;
 
            virtual PersonaState GetPersonaState() = 0;
 
            virtual const char* GetFriendPersonaName(GalaxyID userID) = 0;
 
            virtual void GetFriendPersonaNameCopy(GalaxyID userID, char* buffer, uint32_t bufferLength) = 0;
 
            virtual PersonaState GetFriendPersonaState(GalaxyID userID) = 0;
 
            virtual const char* GetFriendAvatarUrl(GalaxyID userID, AvatarType avatarType) = 0;
 
            virtual void GetFriendAvatarUrlCopy(GalaxyID userID, AvatarType avatarType, char* buffer, uint32_t bufferLength) = 0;
 
            virtual uint32_t GetFriendAvatarImageID(GalaxyID userID, AvatarType avatarType) = 0;
 
            virtual void GetFriendAvatarImageRGBA(GalaxyID userID, AvatarType avatarType, void* buffer, uint32_t bufferLength) = 0;
 
            virtual bool IsFriendAvatarImageRGBAAvailable(GalaxyID userID, AvatarType avatarType) = 0;
 
            virtual void RequestFriendList(IFriendListListener* const listener = NULL) = 0;
 
            virtual bool IsFriend(GalaxyID userID) = 0;
 
            virtual uint32_t GetFriendCount() = 0;
 
            virtual GalaxyID GetFriendByIndex(uint32_t index) = 0;
 
            virtual void SendFriendInvitation(GalaxyID userID, IFriendInvitationSendListener* const listener = NULL) = 0;
 
            virtual void RequestFriendInvitationList(IFriendInvitationListRetrieveListener* const listener = NULL) = 0;
 
            virtual void RequestSentFriendInvitationList(ISentFriendInvitationListRetrieveListener* const listener = NULL) = 0;
 
            virtual uint32_t GetFriendInvitationCount() = 0;
 
            virtual void GetFriendInvitationByIndex(uint32_t index, GalaxyID& userID, uint32_t& sendTime) = 0;
 
            virtual void RespondToFriendInvitation(GalaxyID userID, bool accept, IFriendInvitationRespondToListener* const listener = NULL) = 0;
 
            virtual void DeleteFriend(GalaxyID userID, IFriendDeleteListener* const listener = NULL) = 0;
 
            virtual void SetRichPresence(const char* key, const char* value, IRichPresenceChangeListener* const listener = NULL) = 0;
 
            virtual void DeleteRichPresence(const char* key, IRichPresenceChangeListener* const listener = NULL) = 0;
 
            virtual void ClearRichPresence(IRichPresenceChangeListener* const listener = NULL) = 0;
 
            virtual void RequestRichPresence(GalaxyID userID = GalaxyID(), IRichPresenceRetrieveListener* const listener = NULL) = 0;
 
            virtual const char* GetRichPresence(const char* key, GalaxyID userID = GalaxyID()) = 0;
 
            virtual void GetRichPresenceCopy(const char* key, char* buffer, uint32_t bufferLength, GalaxyID userID = GalaxyID()) = 0;
 
            virtual uint32_t GetRichPresenceCount(GalaxyID userID = GalaxyID()) = 0;
 
            virtual void GetRichPresenceByIndex(uint32_t index, char* key, uint32_t keyLength, char* value, uint32_t valueLength, GalaxyID userID = GalaxyID()) = 0;
 
            virtual const char* GetRichPresenceKeyByIndex(uint32_t index, GalaxyID userID = GalaxyID()) = 0;
 
            virtual void GetRichPresenceKeyByIndexCopy(uint32_t index, char* buffer, uint32_t bufferLength, GalaxyID userID = GalaxyID()) = 0;
 
            virtual void ShowOverlayInviteDialog(const char* connectionString) = 0;
 
            virtual void SendInvitation(GalaxyID userID, const char* connectionString, ISendInvitationListener* const listener = NULL) = 0;
 
            virtual void FindUser(const char* userSpecifier, IUserFindListener* const listener = NULL) = 0;
 
            virtual bool IsUserInTheSameGame(GalaxyID userID) const = 0;
        };
 
    }
}
 
#endif