IUser.h

Go to the documentation of this file.

#ifndef GALAXY_I_USER_H
#define GALAXY_I_USER_H
 
#include "GalaxyID.h"
#include "IListenerRegistrar.h"
 
namespace galaxy
{
    namespace api
    {
        typedef uint64_t SessionID;
 
        class IAuthListener : public GalaxyTypeAwareListener<AUTH>
        {
        public:
 
            virtual void OnAuthSuccess() = 0;
 
            enum FailureReason
            {
                FAILURE_REASON_UNDEFINED, 
                FAILURE_REASON_GALAXY_SERVICE_NOT_AVAILABLE, 
                FAILURE_REASON_GALAXY_SERVICE_NOT_SIGNED_IN, 
                FAILURE_REASON_CONNECTION_FAILURE, 
                FAILURE_REASON_NO_LICENSE, 
                FAILURE_REASON_INVALID_CREDENTIALS, 
                FAILURE_REASON_GALAXY_NOT_INITIALIZED, 
                FAILURE_REASON_EXTERNAL_SERVICE_FAILURE 
            };
 
            virtual void OnAuthFailure(FailureReason failureReason) = 0;
 
            virtual void OnAuthLost() = 0;
        };
 
        typedef SelfRegisteringListener<IAuthListener> GlobalAuthListener;
 
        typedef SelfRegisteringListener<IAuthListener, GameServerListenerRegistrar> GameServerGlobalAuthListener;
 
        class IOtherSessionStartListener : public GalaxyTypeAwareListener<OTHER_SESSION_START>
        {
        public:
 
            virtual void OnOtherSessionStarted() = 0;
        };
 
        typedef SelfRegisteringListener<IOtherSessionStartListener> GlobalOtherSessionStartListener;
 
        typedef SelfRegisteringListener<IOtherSessionStartListener, GameServerListenerRegistrar> GameServerGlobalOtherSessionStartListener;
 
        class IOperationalStateChangeListener : public GalaxyTypeAwareListener<OPERATIONAL_STATE_CHANGE>
        {
        public:
 
            enum OperationalState
            {
                OPERATIONAL_STATE_SIGNED_IN = 0x0001, 
                OPERATIONAL_STATE_LOGGED_ON = 0x0002 
            };
 
            virtual void OnOperationalStateChanged(uint32_t operationalState) = 0;
        };
 
        typedef SelfRegisteringListener<IOperationalStateChangeListener> GlobalOperationalStateChangeListener;
 
        typedef SelfRegisteringListener<IOperationalStateChangeListener, GameServerListenerRegistrar> GameServerGlobalOperationalStateChangeListener;
 
        class IUserDataListener : public GalaxyTypeAwareListener<USER_DATA>
        {
        public:
 
            virtual void OnUserDataUpdated() = 0;
        };
 
        typedef SelfRegisteringListener<IUserDataListener> GlobalUserDataListener;
 
        typedef SelfRegisteringListener<IUserDataListener, GameServerListenerRegistrar> GameServerGlobalUserDataListener;
 
        class ISpecificUserDataListener : public GalaxyTypeAwareListener<SPECIFIC_USER_DATA>
        {
        public:
 
            virtual void OnSpecificUserDataUpdated(GalaxyID userID) = 0;
        };
 
        typedef SelfRegisteringListener<ISpecificUserDataListener> GlobalSpecificUserDataListener;
 
        typedef SelfRegisteringListener<ISpecificUserDataListener, GameServerListenerRegistrar> GameServerGlobalSpecificUserDataListener;
 
        class IEncryptedAppTicketListener : public GalaxyTypeAwareListener<ENCRYPTED_APP_TICKET_RETRIEVE>
        {
        public:
 
            virtual void OnEncryptedAppTicketRetrieveSuccess() = 0;
 
            enum FailureReason
            {
                FAILURE_REASON_UNDEFINED, 
                FAILURE_REASON_CONNECTION_FAILURE 
            };
 
            virtual void OnEncryptedAppTicketRetrieveFailure(FailureReason failureReason) = 0;
        };
 
        typedef SelfRegisteringListener<IEncryptedAppTicketListener> GlobalEncryptedAppTicketListener;
 
        typedef SelfRegisteringListener<IEncryptedAppTicketListener, GameServerListenerRegistrar> GameServerGlobalEncryptedAppTicketListener;
 
 
        class IAccessTokenListener : public GalaxyTypeAwareListener<ACCESS_TOKEN_CHANGE>
        {
        public:
 
            virtual void OnAccessTokenChanged() = 0;
        };
 
        typedef SelfRegisteringListener<IAccessTokenListener> GlobalAccessTokenListener;
 
        typedef SelfRegisteringListener<IAccessTokenListener, GameServerListenerRegistrar> GameServerGlobalAccessTokenListener;
 
        class IPlayFabCreateOpenIDConnectionListener : public GalaxyTypeAwareListener<PLAYFAB_CREATE_OPENID_CONNECTION>
        {
        public:
 
            virtual void OnPlayFabCreateOpenIDConnectionSuccess(bool connectionAlreadyExists) = 0;
 
            enum FailureReason
            {
                FAILURE_REASON_UNDEFINED, 
                FAILURE_REASON_CONNECTION_FAILURE 
            };
 
            virtual void OnPlayFabCreateOpenIDConnectionFailure(FailureReason failureReason) = 0;
        };
 
        typedef SelfRegisteringListener<IPlayFabCreateOpenIDConnectionListener> GlobalPlayFabCreateOpenIDConnectionListener;
 
        typedef SelfRegisteringListener<IPlayFabCreateOpenIDConnectionListener, GameServerListenerRegistrar> GameServerGlobalPlayFabCreateOpenIDConnectionListener;
 
        class IPlayFabLoginWithOpenIDConnectListener : public GalaxyTypeAwareListener<PLAYFAB_LOGIN_WITH_OPENID_CONNECT>
        {
        public:
 
            virtual void OnPlayFabLoginWithOpenIDConnectSuccess() = 0;
 
            enum FailureReason
            {
                FAILURE_REASON_UNDEFINED, 
                FAILURE_REASON_CONNECTION_FAILURE 
            };
 
            virtual void OnPlayFabLoginWithOpenIDConnectFailure(FailureReason failureReason) = 0;
        };
 
        typedef SelfRegisteringListener<IPlayFabLoginWithOpenIDConnectListener> GlobalPlayFabLoginWithOpenIDConnectListener;
 
        typedef SelfRegisteringListener<IPlayFabLoginWithOpenIDConnectListener, GameServerListenerRegistrar> GameServerGlobalPlayFabLoginWithOpenIDConnectListener;
 
        class IUser
        {
        public:
 
            virtual ~IUser()
            {
            }
 
            virtual bool SignedIn() = 0;
 
            virtual GalaxyID GetGalaxyID() = 0;
 
            virtual void SignInCredentials(const char* login, const char* password, IAuthListener* const listener = NULL) = 0;
 
            virtual void SignInToken(const char* refreshToken, IAuthListener* const listener = NULL) = 0;
 
            virtual void SignInLauncher(IAuthListener* const listener = NULL) = 0;
 
            virtual void SignInSteam(const void* steamAppTicket, uint32_t steamAppTicketSize, const char* personaName, IAuthListener* const listener = NULL) = 0;
 
            virtual void SignInGalaxy(bool requireOnline = false, uint32_t timeout = 15, IAuthListener* const listener = NULL) = 0;
 
            virtual void SignInPS4(const char* ps4ClientID, IAuthListener* const listener = NULL) = 0;
 
            virtual void SignInXB1(const char* xboxOneUserID, IAuthListener* const listener = NULL) = 0;
 
            virtual void SignInXbox(uint64_t xboxID, IAuthListener* const listener = NULL) = 0;
 
            virtual void SignInXBLive(const char* token, const char* signature, const char* marketplaceID, const char* locale, IAuthListener* const listener = NULL) = 0;
 
            virtual void SignInAnonymous(IAuthListener* const listener = NULL) = 0;
 
            virtual void SignInAnonymousTelemetry(IAuthListener* const listener = NULL) = 0;
 
            virtual void SignInServerKey(const char* serverKey, IAuthListener* const listener = NULL) = 0;
 
            virtual void SignInAuthorizationCode(const char* authorizationCode, const char* redirectURI, IAuthListener* const listener = NULL) = 0;
 
            virtual void SignOut() = 0;
 
            virtual void RequestUserData(GalaxyID userID = GalaxyID(), ISpecificUserDataListener* const listener = NULL) = 0;
 
            virtual bool IsUserDataAvailable(GalaxyID userID = GalaxyID()) = 0;
 
            virtual const char* GetUserData(const char* key, GalaxyID userID = GalaxyID()) = 0;
 
            virtual void GetUserDataCopy(const char* key, char* buffer, uint32_t bufferLength, GalaxyID userID = GalaxyID()) = 0;
 
            virtual void SetUserData(const char* key, const char* value, ISpecificUserDataListener* const listener = NULL) = 0;
 
            virtual uint32_t GetUserDataCount(GalaxyID userID = GalaxyID()) = 0;
 
            virtual bool GetUserDataByIndex(uint32_t index, char* key, uint32_t keyLength, char* value, uint32_t valueLength, GalaxyID userID = GalaxyID()) = 0;
 
            virtual void DeleteUserData(const char* key, ISpecificUserDataListener* const listener = NULL) = 0;
 
            virtual bool IsLoggedOn() = 0;
 
            virtual void RequestEncryptedAppTicket(const void* data, uint32_t dataSize, IEncryptedAppTicketListener* const listener = NULL) = 0;
 
            virtual void GetEncryptedAppTicket(void* encryptedAppTicket, uint32_t maxEncryptedAppTicketSize, uint32_t& currentEncryptedAppTicketSize) = 0;
 
            virtual void CreateOpenIDConnection(const char* secretKey, const char* titleID, const char* connectionID, bool ignoreNonce = true, IPlayFabCreateOpenIDConnectionListener* const listener = NULL) = 0;
 
            virtual void LoginWithOpenIDConnect(const char* titleID, const char* connectionID, const char* idToken, bool createAccount = true, const char* encryptedRequest = NULL, const char* playerSecret = NULL, IPlayFabLoginWithOpenIDConnectListener* const listener = NULL) = 0;
 
            virtual SessionID GetSessionID() = 0;
 
            virtual const char* GetAccessToken() = 0;
 
            virtual void GetAccessTokenCopy(char* buffer, uint32_t bufferLength) = 0;
 
            virtual const char* GetRefreshToken() = 0;
 
            virtual void GetRefreshTokenCopy(char* buffer, uint32_t bufferLength) = 0;
 
            virtual const char* GetIDToken() = 0;
 
            virtual void GetIDTokenCopy(char* buffer, uint32_t bufferLength) = 0;
 
            virtual bool ReportInvalidAccessToken(const char* accessToken, const char* info = NULL) = 0;
        };
 
    }
}
 
#endif