GOG GALAXY SDK Documentation
IRichPresenceRetrieveListener Class Referenceabstract

Listener for the event of retrieving requested user's rich presence. More...

#include <IFriends.h>

Inheritance diagram for IRichPresenceRetrieveListener:
[legend]

Public Types

enum  FailureReason { FAILURE_REASON_UNDEFINED , FAILURE_REASON_CONNECTION_FAILURE }
 The reason of a failure in retrieving the user's rich presence. More...
 

Public Member Functions

virtual void OnRichPresenceRetrieveSuccess (GalaxyID userID)=0
 Notification for the event of a success in retrieving the user's rich presence. More...
 
virtual void OnRichPresenceRetrieveFailure (GalaxyID userID, FailureReason failureReason)=0
 Notification for the event of a failure in retrieving the user's rich presence. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from GalaxyTypeAwareListener< RICH_PRESENCE_RETRIEVE_LISTENER >
static ListenerType GetListenerType ()
 Returns the type of the listener. More...
 

Detailed Description

Listener for the event of retrieving requested user's rich presence.

Member Enumeration Documentation

◆ FailureReason

The reason of a failure in retrieving the user's rich presence.

Enumerator
FAILURE_REASON_UNDEFINED 

Unspecified error.

FAILURE_REASON_CONNECTION_FAILURE 

Unable to communicate with backend services.

Member Function Documentation

◆ OnRichPresenceRetrieveFailure()

virtual void OnRichPresenceRetrieveFailure ( GalaxyID  userID,
FailureReason  failureReason 
)
pure virtual

Notification for the event of a failure in retrieving the user's rich presence.

Parameters
[in]userIDThe ID of the user.
[in]failureReasonThe cause of the failure.

◆ OnRichPresenceRetrieveSuccess()

virtual void OnRichPresenceRetrieveSuccess ( GalaxyID  userID)
pure virtual

Notification for the event of a success in retrieving the user's rich presence.

Parameters
[in]userIDThe ID of the user.