GOG GALAXY SDK Documentation
IFriends.h
Go to the documentation of this file.
1 #ifndef GALAXY_I_FRIENDS_H
2 #define GALAXY_I_FRIENDS_H
3 
9 #include "GalaxyID.h"
10 #include "IListenerRegistrar.h"
11 
12 namespace galaxy
13 {
14  namespace api
15  {
25  {
26  AVATAR_TYPE_NONE = 0x0000,
27  AVATAR_TYPE_SMALL = 0x0001,
28  AVATAR_TYPE_MEDIUM = 0x0002,
29  AVATAR_TYPE_LARGE = 0x0004
30  };
31 
35  typedef uint32_t AvatarCriteria;
36 
41  {
44  };
45 
49  class IPersonaDataChangedListener : public GalaxyTypeAwareListener<PERSONA_DATA_CHANGED>
50  {
51  public:
52 
57  {
65  };
66 
73  virtual void OnPersonaDataChanged(GalaxyID userID, uint32_t personaStateChange) = 0;
74  };
75 
80 
84  class IUserInformationRetrieveListener : public GalaxyTypeAwareListener<USER_INFORMATION_RETRIEVE_LISTENER>
85  {
86  public:
87 
93  virtual void OnUserInformationRetrieveSuccess(GalaxyID userID) = 0;
94 
99  {
102  };
103 
110  virtual void OnUserInformationRetrieveFailure(GalaxyID userID, FailureReason failureReason) = 0;
111  };
112 
117 
121  class IFriendListListener : public GalaxyTypeAwareListener<FRIEND_LIST_RETRIEVE>
122  {
123  public:
124 
130  virtual void OnFriendListRetrieveSuccess() = 0;
131 
136  {
139  };
140 
146  virtual void OnFriendListRetrieveFailure(FailureReason failureReason) = 0;
147  };
148 
153 
157  class IFriendInvitationSendListener : public GalaxyTypeAwareListener<FRIEND_INVITATION_SEND_LISTENER>
158  {
159  public:
160 
166  virtual void OnFriendInvitationSendSuccess(GalaxyID userID) = 0;
167 
172  {
178  };
179 
186  virtual void OnFriendInvitationSendFailure(GalaxyID userID, FailureReason failureReason) = 0;
187  };
188 
193 
197  class IFriendInvitationListRetrieveListener : public GalaxyTypeAwareListener<FRIEND_INVITATION_LIST_RETRIEVE_LISTENER>
198  {
199  public:
200 
207 
212  {
215  };
216 
222  virtual void OnFriendInvitationListRetrieveFailure(FailureReason failureReason) = 0;
223 
224  };
225 
230 
234  class ISentFriendInvitationListRetrieveListener : public GalaxyTypeAwareListener<SENT_FRIEND_INVITATION_LIST_RETRIEVE_LISTENER>
235  {
236  public:
237 
244 
249  {
252  };
253 
260  };
261 
266 
270  class IFriendInvitationListener : public GalaxyTypeAwareListener<FRIEND_INVITATION_LISTENER>
271  {
272  public:
273 
280  virtual void OnFriendInvitationReceived(GalaxyID userID, uint32_t sendTime) = 0;
281  };
282 
287 
291  class IFriendInvitationRespondToListener : public GalaxyTypeAwareListener<FRIEND_INVITATION_RESPOND_TO_LISTENER>
292  {
293  public:
294 
301  virtual void OnFriendInvitationRespondToSuccess(GalaxyID userID, bool accept) = 0;
302 
307  {
313  };
314 
321  virtual void OnFriendInvitationRespondToFailure(GalaxyID userID, FailureReason failureReason) = 0;
322  };
323 
328 
332  class IFriendAddListener : public GalaxyTypeAwareListener<FRIEND_ADD_LISTENER>
333  {
334  public:
335 
340  {
343  };
344 
351  virtual void OnFriendAdded(GalaxyID userID, InvitationDirection invitationDirection) = 0;
352  };
353 
358 
362  class IFriendDeleteListener : public GalaxyTypeAwareListener<FRIEND_DELETE_LISTENER>
363  {
364  public:
365 
371  virtual void OnFriendDeleteSuccess(GalaxyID userID) = 0;
372 
377  {
380  };
381 
388  virtual void OnFriendDeleteFailure(GalaxyID userID, FailureReason failureReason) = 0;
389  };
390 
395 
399  class IRichPresenceChangeListener : public GalaxyTypeAwareListener<RICH_PRESENCE_CHANGE_LISTENER>
400  {
401  public:
402 
406  virtual void OnRichPresenceChangeSuccess() = 0;
407 
412  {
415  };
416 
422  virtual void OnRichPresenceChangeFailure(FailureReason failureReason) = 0;
423  };
424 
429 
433  class IRichPresenceListener : public GalaxyTypeAwareListener<RICH_PRESENCE_LISTENER>
434  {
435  public:
436 
442  virtual void OnRichPresenceUpdated(GalaxyID userID) = 0;
443  };
444 
449 
453  class IRichPresenceRetrieveListener : public GalaxyTypeAwareListener<RICH_PRESENCE_RETRIEVE_LISTENER>
454  {
455  public:
456 
462  virtual void OnRichPresenceRetrieveSuccess(GalaxyID userID) = 0;
463 
468  {
471  };
472 
479  virtual void OnRichPresenceRetrieveFailure(GalaxyID userID, FailureReason failureReason) = 0;
480  };
481 
486 
493  class IGameJoinRequestedListener : public GalaxyTypeAwareListener<GAME_JOIN_REQUESTED_LISTENER>
494  {
495  public:
496 
503  virtual void OnGameJoinRequested(GalaxyID userID, const char* connectionString) = 0;
504  };
505 
510 
516  class IGameInvitationReceivedListener : public GalaxyTypeAwareListener<GAME_INVITATION_RECEIVED_LISTENER>
517  {
518  public:
519 
526  virtual void OnGameInvitationReceived(GalaxyID userID, const char* connectionString) = 0;
527  };
528 
533 
537  class ISendInvitationListener : public GalaxyTypeAwareListener<INVITATION_SEND>
538  {
539  public:
540 
547  virtual void OnInvitationSendSuccess(GalaxyID userID, const char* connectionString) = 0;
548 
553  {
561  };
562 
570  virtual void OnInvitationSendFailure(GalaxyID userID, const char* connectionString, FailureReason failureReason) = 0;
571  };
572 
577 
581  class IUserFindListener : public GalaxyTypeAwareListener<USER_FIND_LISTENER>
582  {
583  public:
584 
591  virtual void OnUserFindSuccess(const char* userSpecifier, GalaxyID userID) = 0;
592 
597  {
601  };
602 
609  virtual void OnUserFindFailure(const char* userSpecifier, FailureReason failureReason) = 0;
610  };
611 
616 
620  class IFriends
621  {
622  public:
623 
624  virtual ~IFriends()
625  {
626  }
627 
634 
643  virtual void SetDefaultAvatarCriteria(AvatarCriteria defaultAvatarCriteria) = 0;
644 
665  GalaxyID userID,
666  AvatarCriteria avatarCriteria = AVATAR_TYPE_NONE,
667  IUserInformationRetrieveListener* const listener = NULL) = 0;
668 
677  virtual bool IsUserInformationAvailable(GalaxyID userID) = 0;
678 
686  virtual const char* GetPersonaName() = 0;
687 
694  virtual void GetPersonaNameCopy(char* buffer, uint32_t bufferLength) = 0;
695 
702 
713  virtual const char* GetFriendPersonaName(GalaxyID userID) = 0;
714 
724  virtual void GetFriendPersonaNameCopy(GalaxyID userID, char* buffer, uint32_t bufferLength) = 0;
725 
735 
747  virtual const char* GetFriendAvatarUrl(GalaxyID userID, AvatarType avatarType) = 0;
748 
759  virtual void GetFriendAvatarUrlCopy(GalaxyID userID, AvatarType avatarType, char* buffer, uint32_t bufferLength) = 0;
760 
771  virtual uint32_t GetFriendAvatarImageID(GalaxyID userID, AvatarType avatarType) = 0;
772 
786  virtual void GetFriendAvatarImageRGBA(GalaxyID userID, AvatarType avatarType, void* buffer, uint32_t bufferLength) = 0;
787 
795  virtual bool IsFriendAvatarImageRGBAAvailable(GalaxyID userID, AvatarType avatarType) = 0;
796 
804  virtual void RequestFriendList(IFriendListListener* const listener = NULL) = 0;
805 
814  virtual bool IsFriend(GalaxyID userID) = 0;
815 
823  virtual uint32_t GetFriendCount() = 0;
824 
833  virtual GalaxyID GetFriendByIndex(uint32_t index) = 0;
834 
843  virtual void SendFriendInvitation(GalaxyID userID, IFriendInvitationSendListener* const listener = NULL) = 0;
844 
852  virtual void RequestFriendInvitationList(IFriendInvitationListRetrieveListener* const listener = NULL) = 0;
853 
862 
870  virtual uint32_t GetFriendInvitationCount() = 0;
871 
881  virtual void GetFriendInvitationByIndex(uint32_t index, GalaxyID& userID, uint32_t& sendTime) = 0;
882 
892  virtual void RespondToFriendInvitation(GalaxyID userID, bool accept, IFriendInvitationRespondToListener* const listener = NULL) = 0;
893 
902  virtual void DeleteFriend(GalaxyID userID, IFriendDeleteListener* const listener = NULL) = 0;
903 
924  virtual void SetRichPresence(const char* key, const char* value, IRichPresenceChangeListener* const listener = NULL) = 0;
925 
936  virtual void DeleteRichPresence(const char* key, IRichPresenceChangeListener* const listener = NULL) = 0;
937 
945  virtual void ClearRichPresence(IRichPresenceChangeListener* const listener = NULL) = 0;
946 
956  virtual void RequestRichPresence(GalaxyID userID = GalaxyID(), IRichPresenceRetrieveListener* const listener = NULL) = 0;
957 
969  virtual const char* GetRichPresence(const char* key, GalaxyID userID = GalaxyID()) = 0;
970 
981  virtual void GetRichPresenceCopy(const char* key, char* buffer, uint32_t bufferLength, GalaxyID userID = GalaxyID()) = 0;
982 
989  virtual uint32_t GetRichPresenceCount(GalaxyID userID = GalaxyID()) = 0;
990 
1003  virtual void GetRichPresenceByIndex(uint32_t index, char* key, uint32_t keyLength, char* value, uint32_t valueLength, GalaxyID userID = GalaxyID()) = 0;
1004 
1016  virtual const char* GetRichPresenceKeyByIndex(uint32_t index, GalaxyID userID = GalaxyID()) = 0;
1017 
1028  virtual void GetRichPresenceKeyByIndexCopy(uint32_t index, char* buffer, uint32_t bufferLength, GalaxyID userID = GalaxyID()) = 0;
1029 
1043  virtual void ShowOverlayInviteDialog(const char* connectionString) = 0;
1044 
1059  virtual void SendInvitation(GalaxyID userID, const char* connectionString, ISendInvitationListener* const listener = NULL) = 0;
1060 
1072  virtual void FindUser(const char* userSpecifier, IUserFindListener* const listener = NULL) = 0;
1073 
1082  virtual bool IsUserInTheSameGame(GalaxyID userID) const = 0;
1083  };
1084 
1086  }
1087 }
1088 
1089 #endif
Contains GalaxyID, which is the class that represents the ID of an entity used by Galaxy Peer.
Contains data structures and interfaces related to callback listeners.
Represents the ID of an entity used by Galaxy Peer.
Definition: GalaxyID.h:30
The class that is inherited by all specific callback listeners and provides a static method that retu...
Definition: IListenerRegistrar.h:110
Listener for the event of a user being added to the friend list.
Definition: IFriends.h:333
virtual void OnFriendAdded(GalaxyID userID, InvitationDirection invitationDirection)=0
Notification for the event of a user being added to the friend list.
InvitationDirection
The direction of the invitation that initiated the change in the friend list.
Definition: IFriends.h:340
@ INVITATION_DIRECTION_INCOMING
The user indicated in the notification was the inviter.
Definition: IFriends.h:341
@ INVITATION_DIRECTION_OUTGOING
The user indicated in the notification was the invitee.
Definition: IFriends.h:342
Listener for the event of removing a user from the friend list.
Definition: IFriends.h:363
virtual void OnFriendDeleteFailure(GalaxyID userID, FailureReason failureReason)=0
Notification for the event of a failure in removing a user from the friend list.
FailureReason
The reason of a failure in removing a user from the friend list.
Definition: IFriends.h:377
@ FAILURE_REASON_UNDEFINED
Unspecified error.
Definition: IFriends.h:378
@ FAILURE_REASON_CONNECTION_FAILURE
Unable to communicate with backend services.
Definition: IFriends.h:379
virtual void OnFriendDeleteSuccess(GalaxyID userID)=0
Notification for the event of a success in removing a user from the friend list.
Listener for the event of retrieving requested list of incoming friend invitations.
Definition: IFriends.h:198
FailureReason
The reason of a failure in retrieving the user's list of incoming friend invitations.
Definition: IFriends.h:212
@ FAILURE_REASON_UNDEFINED
Unspecified error.
Definition: IFriends.h:213
@ FAILURE_REASON_CONNECTION_FAILURE
Unable to communicate with backend services.
Definition: IFriends.h:214
virtual void OnFriendInvitationListRetrieveSuccess()=0
Notification for the event of a success in retrieving the user's list of incoming friend invitations.
virtual void OnFriendInvitationListRetrieveFailure(FailureReason failureReason)=0
Notification for the event of a failure in retrieving the user's list of incoming friend invitations.
Listener for the event of receiving a friend invitation.
Definition: IFriends.h:271
virtual void OnFriendInvitationReceived(GalaxyID userID, uint32_t sendTime)=0
Notification for the event of receiving a friend invitation.
Listener for the event of responding to a friend invitation.
Definition: IFriends.h:292
FailureReason
The reason of a failure in responding to a friend invitation.
Definition: IFriends.h:307
@ FAILURE_REASON_USER_ALREADY_FRIEND
User already on the friend list.
Definition: IFriends.h:311
@ FAILURE_REASON_UNDEFINED
Unspecified error.
Definition: IFriends.h:308
@ FAILURE_REASON_USER_DOES_NOT_EXIST
User does not exist.
Definition: IFriends.h:309
@ FAILURE_REASON_FRIEND_INVITATION_DOES_NOT_EXIST
Friend invitation does not exist.
Definition: IFriends.h:310
@ FAILURE_REASON_CONNECTION_FAILURE
Unable to communicate with backend services.
Definition: IFriends.h:312
virtual void OnFriendInvitationRespondToFailure(GalaxyID userID, FailureReason failureReason)=0
Notification for the event of a failure in responding to a friend invitation.
virtual void OnFriendInvitationRespondToSuccess(GalaxyID userID, bool accept)=0
Notification for the event of a success in responding to a friend invitation.
Listener for the event of sending a friend invitation.
Definition: IFriends.h:158
FailureReason
The reason of a failure in sending a friend invitation.
Definition: IFriends.h:172
@ FAILURE_REASON_USER_ALREADY_INVITED
Friend invitation already sent to the user.
Definition: IFriends.h:175
@ FAILURE_REASON_USER_ALREADY_FRIEND
User already on the friend list.
Definition: IFriends.h:176
@ FAILURE_REASON_UNDEFINED
Unspecified error.
Definition: IFriends.h:173
@ FAILURE_REASON_USER_DOES_NOT_EXIST
User does not exist.
Definition: IFriends.h:174
@ FAILURE_REASON_CONNECTION_FAILURE
Unable to communicate with backend services.
Definition: IFriends.h:177
virtual void OnFriendInvitationSendFailure(GalaxyID userID, FailureReason failureReason)=0
Notification for the event of a failure in sending a friend invitation.
virtual void OnFriendInvitationSendSuccess(GalaxyID userID)=0
Notification for the event of a success in sending a friend invitation.
Listener for the event of retrieving requested list of friends.
Definition: IFriends.h:122
FailureReason
The reason of a failure in retrieving the user's list of friends.
Definition: IFriends.h:136
@ FAILURE_REASON_UNDEFINED
Unspecified error.
Definition: IFriends.h:137
@ FAILURE_REASON_CONNECTION_FAILURE
Unable to communicate with backend services.
Definition: IFriends.h:138
virtual void OnFriendListRetrieveSuccess()=0
Notification for the event of a success in retrieving the user's list of friends.
virtual void OnFriendListRetrieveFailure(FailureReason failureReason)=0
Notification for the event of a failure in retrieving the user's list of friends.
The interface for managing social info and activities.
Definition: IFriends.h:621
virtual void RequestSentFriendInvitationList(ISentFriendInvitationListRetrieveListener *const listener=NULL)=0
Performs a request for the user's list of outgoing friend invitations.
virtual GalaxyID GetFriendByIndex(uint32_t index)=0
Returns the GalaxyID for a friend.
virtual void GetFriendAvatarImageRGBA(GalaxyID userID, AvatarType avatarType, void *buffer, uint32_t bufferLength)=0
Copies the avatar of a specified user.
virtual bool IsUserInformationAvailable(GalaxyID userID)=0
Checks if the information of specified user is available.
virtual void GetFriendPersonaNameCopy(GalaxyID userID, char *buffer, uint32_t bufferLength)=0
Copies the nickname of a specified user.
virtual void RespondToFriendInvitation(GalaxyID userID, bool accept, IFriendInvitationRespondToListener *const listener=NULL)=0
Responds to the friend invitation.
virtual const char * GetPersonaName()=0
Returns the user's nickname.
virtual void RequestUserInformation(GalaxyID userID, AvatarCriteria avatarCriteria=AVATAR_TYPE_NONE, IUserInformationRetrieveListener *const listener=NULL)=0
Performs a request for information about specified user.
virtual const char * GetFriendAvatarUrl(GalaxyID userID, AvatarType avatarType)=0
Returns the URL of the avatar of a specified user.
virtual bool IsFriend(GalaxyID userID)=0
Checks if a specified user is a friend.
virtual void RequestRichPresence(GalaxyID userID=GalaxyID(), IRichPresenceRetrieveListener *const listener=NULL)=0
Performs a request for the user's rich presence.
virtual void GetRichPresenceCopy(const char *key, char *buffer, uint32_t bufferLength, GalaxyID userID=GalaxyID())=0
Copies the rich presence of a specified user to a buffer.
virtual void GetRichPresenceByIndex(uint32_t index, char *key, uint32_t keyLength, char *value, uint32_t valueLength, GalaxyID userID=GalaxyID())=0
Returns a property from the rich presence storage by index.
virtual bool IsUserInTheSameGame(GalaxyID userID) const =0
Checks if a specified user is playing the same game.
virtual void SetRichPresence(const char *key, const char *value, IRichPresenceChangeListener *const listener=NULL)=0
Sets the variable value under a specified name.
virtual void GetFriendInvitationByIndex(uint32_t index, GalaxyID &userID, uint32_t &sendTime)=0
Reads the details of the friend invitation.
virtual PersonaState GetFriendPersonaState(GalaxyID userID)=0
Returns the state of a specified user.
virtual uint32_t GetFriendCount()=0
Returns the number of retrieved friends in the user's list of friends.
virtual AvatarCriteria GetDefaultAvatarCriteria()=0
Returns the default avatar criteria.
virtual void DeleteRichPresence(const char *key, IRichPresenceChangeListener *const listener=NULL)=0
Removes the variable value under a specified name.
virtual void RequestFriendInvitationList(IFriendInvitationListRetrieveListener *const listener=NULL)=0
Performs a request for the user's list of incoming friend invitations.
virtual const char * GetRichPresenceKeyByIndex(uint32_t index, GalaxyID userID=GalaxyID())=0
Returns a key from the rich presence storage by index.
virtual bool IsFriendAvatarImageRGBAAvailable(GalaxyID userID, AvatarType avatarType)=0
Checks if a specified avatar image is available.
virtual void RequestFriendList(IFriendListListener *const listener=NULL)=0
Performs a request for the user's list of friends.
virtual void DeleteFriend(GalaxyID userID, IFriendDeleteListener *const listener=NULL)=0
Removes a user from the friend list.
virtual void GetFriendAvatarUrlCopy(GalaxyID userID, AvatarType avatarType, char *buffer, uint32_t bufferLength)=0
Copies URL of the avatar of a specified user.
virtual void GetRichPresenceKeyByIndexCopy(uint32_t index, char *buffer, uint32_t bufferLength, GalaxyID userID=GalaxyID())=0
Copies a key from the rich presence storage by index to a buffer.
virtual const char * GetFriendPersonaName(GalaxyID userID)=0
Returns the nickname of a specified user.
virtual PersonaState GetPersonaState()=0
Returns the user's state.
virtual void ClearRichPresence(IRichPresenceChangeListener *const listener=NULL)=0
Removes all rich presence data for the user.
virtual void SendFriendInvitation(GalaxyID userID, IFriendInvitationSendListener *const listener=NULL)=0
Sends a friend invitation.
virtual uint32_t GetRichPresenceCount(GalaxyID userID=GalaxyID())=0
Returns the number of retrieved properties in user's rich presence.
virtual void GetPersonaNameCopy(char *buffer, uint32_t bufferLength)=0
Copies the user's nickname to a buffer.
virtual void ShowOverlayInviteDialog(const char *connectionString)=0
Shows game invitation dialog that allows to invite users to game.
virtual void SetDefaultAvatarCriteria(AvatarCriteria defaultAvatarCriteria)=0
Sets the default avatar criteria.
virtual void SendInvitation(GalaxyID userID, const char *connectionString, ISendInvitationListener *const listener=NULL)=0
Sends a game invitation without using the overlay.
virtual void FindUser(const char *userSpecifier, IUserFindListener *const listener=NULL)=0
Finds a specified user.
virtual const char * GetRichPresence(const char *key, GalaxyID userID=GalaxyID())=0
Returns the rich presence of a specified user.
virtual uint32_t GetFriendInvitationCount()=0
Returns the number of retrieved friend invitations.
virtual uint32_t GetFriendAvatarImageID(GalaxyID userID, AvatarType avatarType)=0
Returns the ID of the avatar of a specified user.
Event of receiving a game invitation.
Definition: IFriends.h:517
virtual void OnGameInvitationReceived(GalaxyID userID, const char *connectionString)=0
Notification for the event of receiving a game invitation.
Event of requesting a game join by user.
Definition: IFriends.h:494
virtual void OnGameJoinRequested(GalaxyID userID, const char *connectionString)=0
Notification for the event of accepting a game invitation.
Listener for the event of changing persona data.
Definition: IFriends.h:50
virtual void OnPersonaDataChanged(GalaxyID userID, uint32_t personaStateChange)=0
Notification for the event of changing persona data.
PersonaStateChange
Describes what has changed about a user.
Definition: IFriends.h:57
@ PERSONA_CHANGE_AVATAR
Avatar, i.e. its URL, has changed.
Definition: IFriends.h:60
@ PERSONA_CHANGE_AVATAR_DOWNLOADED_IMAGE_LARGE
Large avatar image has been downloaded.
Definition: IFriends.h:63
@ PERSONA_CHANGE_AVATAR_DOWNLOADED_IMAGE_MEDIUM
Medium avatar image has been downloaded.
Definition: IFriends.h:62
@ PERSONA_CHANGE_AVATAR_DOWNLOADED_IMAGE_ANY
Any avatar images have been downloaded.
Definition: IFriends.h:64
@ PERSONA_CHANGE_NAME
Persona name has changed.
Definition: IFriends.h:59
@ PERSONA_CHANGE_AVATAR_DOWNLOADED_IMAGE_SMALL
Small avatar image has been downloaded.
Definition: IFriends.h:61
@ PERSONA_CHANGE_NONE
No information has changed.
Definition: IFriends.h:58
Listener for the event of rich presence modification.
Definition: IFriends.h:400
virtual void OnRichPresenceChangeFailure(FailureReason failureReason)=0
Notification for the event of failure to modify rich presence.
FailureReason
The reason of a failure in rich presence modification.
Definition: IFriends.h:412
@ FAILURE_REASON_UNDEFINED
Unspecified error.
Definition: IFriends.h:413
@ FAILURE_REASON_CONNECTION_FAILURE
Unable to communicate with backend services.
Definition: IFriends.h:414
virtual void OnRichPresenceChangeSuccess()=0
Notification for the event of successful rich presence change.
Listener for the event of any user rich presence update.
Definition: IFriends.h:434
virtual void OnRichPresenceUpdated(GalaxyID userID)=0
Notification for the event of successful rich presence update.
Listener for the event of retrieving requested user's rich presence.
Definition: IFriends.h:454
FailureReason
The reason of a failure in retrieving the user's rich presence.
Definition: IFriends.h:468
@ FAILURE_REASON_UNDEFINED
Unspecified error.
Definition: IFriends.h:469
@ FAILURE_REASON_CONNECTION_FAILURE
Unable to communicate with backend services.
Definition: IFriends.h:470
virtual void OnRichPresenceRetrieveFailure(GalaxyID userID, FailureReason failureReason)=0
Notification for the event of a failure in retrieving the user's rich presence.
virtual void OnRichPresenceRetrieveSuccess(GalaxyID userID)=0
Notification for the event of a success in retrieving the user's rich presence.
Listener for the event of sending an invitation without using the overlay.
Definition: IFriends.h:538
FailureReason
The reason of a failure in sending an invitation.
Definition: IFriends.h:553
@ FAILURE_REASON_SENDER_BLOCKED
Sender blocked by receiver. Will also occur if both users blocked each other.
Definition: IFriends.h:559
@ FAILURE_REASON_RECEIVER_DOES_NOT_ALLOW_INVITING
Receiver does not allow inviting.
Definition: IFriends.h:556
@ FAILURE_REASON_RECEIVER_BLOCKED
Receiver blocked by sender.
Definition: IFriends.h:558
@ FAILURE_REASON_UNDEFINED
Unspecified error.
Definition: IFriends.h:554
@ FAILURE_REASON_USER_DOES_NOT_EXIST
Receiver does not exist.
Definition: IFriends.h:555
@ FAILURE_REASON_CONNECTION_FAILURE
Unable to communicate with backend services.
Definition: IFriends.h:560
@ FAILURE_REASON_SENDER_DOES_NOT_ALLOW_INVITING
Sender does not allow inviting.
Definition: IFriends.h:557
virtual void OnInvitationSendFailure(GalaxyID userID, const char *connectionString, FailureReason failureReason)=0
Notification for the event of a failure in sending an invitation.
virtual void OnInvitationSendSuccess(GalaxyID userID, const char *connectionString)=0
Notification for the event of success in sending an invitation.
Listener for the event of retrieving requested list of outgoing friend invitations.
Definition: IFriends.h:235
FailureReason
The reason of a failure in retrieving the user's list of outgoing friend invitations.
Definition: IFriends.h:249
@ FAILURE_REASON_UNDEFINED
Unspecified error.
Definition: IFriends.h:250
@ FAILURE_REASON_CONNECTION_FAILURE
Unable to communicate with backend services.
Definition: IFriends.h:251
virtual void OnSentFriendInvitationListRetrieveFailure(FailureReason failureReason)=0
Notification for the event of a failure in retrieving the user's list of outgoing friend invitations.
virtual void OnSentFriendInvitationListRetrieveSuccess()=0
Notification for the event of a success in retrieving the user's list of outgoing friend invitations.
Listener for the event of searching a user.
Definition: IFriends.h:582
FailureReason
The reason of a failure in searching a user.
Definition: IFriends.h:597
@ FAILURE_REASON_USER_NOT_FOUND
Specified user was not found.
Definition: IFriends.h:599
@ FAILURE_REASON_UNDEFINED
Unspecified error.
Definition: IFriends.h:598
@ FAILURE_REASON_CONNECTION_FAILURE
Unable to communicate with backend services.
Definition: IFriends.h:600
virtual void OnUserFindFailure(const char *userSpecifier, FailureReason failureReason)=0
Notification for the event of a failure in finding a user.
virtual void OnUserFindSuccess(const char *userSpecifier, GalaxyID userID)=0
Notification for the event of success in finding a user.
Listener for the event of retrieving requested user's information.
Definition: IFriends.h:85
virtual void OnUserInformationRetrieveFailure(GalaxyID userID, FailureReason failureReason)=0
Notification for the event of a failure in retrieving the user's information.
FailureReason
The reason of a failure in retrieving the user's information.
Definition: IFriends.h:99
@ FAILURE_REASON_UNDEFINED
Unspecified error.
Definition: IFriends.h:100
@ FAILURE_REASON_CONNECTION_FAILURE
Unable to communicate with backend services.
Definition: IFriends.h:101
virtual void OnUserInformationRetrieveSuccess(GalaxyID userID)=0
Notification for the event of a success in retrieving the user's information.
The class that is inherited by the self-registering versions of all specific callback listeners.
Definition: IListenerRegistrar.h:204
SelfRegisteringListener< IGameInvitationReceivedListener > GlobalGameInvitationReceivedListener
Globally self-registering version of IGameInvitationReceivedListener.
Definition: IFriends.h:532
uint32_t AvatarCriteria
The bit sum of the AvatarType.
Definition: IFriends.h:35
SelfRegisteringListener< IFriendAddListener > GlobalFriendAddListener
Globally self-registering version of IFriendAddListener.
Definition: IFriends.h:357
SelfRegisteringListener< ISendInvitationListener > GlobalSendInvitationListener
Globally self-registering version of ISendInvitationListener.
Definition: IFriends.h:576
SelfRegisteringListener< ISentFriendInvitationListRetrieveListener > GlobalSentFriendInvitationListRetrieveListener
Globally self-registering version of ISentFriendInvitationListRetrieveListener.
Definition: IFriends.h:265
SelfRegisteringListener< IFriendInvitationListRetrieveListener > GlobalFriendInvitationListRetrieveListener
Globally self-registering version of IFriendInvitationListRetrieveListener.
Definition: IFriends.h:229
SelfRegisteringListener< IFriendListListener > GlobalFriendListListener
Globally self-registering version of IFriendListListener.
Definition: IFriends.h:152
SelfRegisteringListener< IUserInformationRetrieveListener > GlobalUserInformationRetrieveListener
Globally self-registering version of IUserInformationRetrieveListener.
Definition: IFriends.h:116
AvatarType
The type of avatar.
Definition: IFriends.h:25
PersonaState
The state of the user.
Definition: IFriends.h:41
SelfRegisteringListener< IRichPresenceChangeListener > GlobalRichPresenceChangeListener
Globally self-registering version of IRichPresenceChangeListener.
Definition: IFriends.h:428
SelfRegisteringListener< IFriendDeleteListener > GlobalFriendDeleteListener
Globally self-registering version of IFriendDeleteListener.
Definition: IFriends.h:394
SelfRegisteringListener< IFriendInvitationSendListener > GlobalFriendInvitationSendListener
Globally self-registering version of IFriendInvitationSendListener.
Definition: IFriends.h:192
SelfRegisteringListener< IUserFindListener > GlobalUserFindListener
Globally self-registering version of IUserFindListener.
Definition: IFriends.h:615
SelfRegisteringListener< IFriendInvitationListener > GlobalFriendInvitationListener
Globally self-registering version of IFriendInvitationListener.
Definition: IFriends.h:286
SelfRegisteringListener< IFriendInvitationRespondToListener > GlobalFriendInvitationRespondToListener
Globally self-registering version of IFriendInvitationRespondToListener.
Definition: IFriends.h:327
SelfRegisteringListener< IPersonaDataChangedListener > GlobalPersonaDataChangedListener
Globally self-registering version of IPersonaDataChangedListener.
Definition: IFriends.h:79
SelfRegisteringListener< IGameJoinRequestedListener > GlobalGameJoinRequestedListener
Globally self-registering version of IGameJoinRequestedListener.
Definition: IFriends.h:509
SelfRegisteringListener< IRichPresenceRetrieveListener > GlobalRichPresenceRetrieveListener
Globally self-registering version of IRichPresenceRetrieveListener.
Definition: IFriends.h:485
SelfRegisteringListener< IRichPresenceListener > GlobalRichPresenceListener
Globally self-registering version of IRichPresenceListener.
Definition: IFriends.h:448
@ AVATAR_TYPE_NONE
No avatar type specified.
Definition: IFriends.h:26
@ AVATAR_TYPE_MEDIUM
Avatar resolution size: 64x64.
Definition: IFriends.h:28
@ AVATAR_TYPE_SMALL
Avatar resolution size: 32x32.
Definition: IFriends.h:27
@ AVATAR_TYPE_LARGE
Avatar resolution size: 184x184.
Definition: IFriends.h:29
@ PERSONA_STATE_OFFLINE
User is not currently logged on.
Definition: IFriends.h:42
@ PERSONA_STATE_ONLINE
User is logged on.
Definition: IFriends.h:43