GOG GALAXY SDK Documentation
IFriendInvitationListRetrieveListener Class Referenceabstract

Listener for the event of retrieving requested list of incoming friend invitations. More...

#include <IFriends.h>

Inheritance diagram for IFriendInvitationListRetrieveListener:
[legend]

Public Types

enum  FailureReason { FAILURE_REASON_UNDEFINED , FAILURE_REASON_CONNECTION_FAILURE }
 The reason of a failure in retrieving the user's list of incoming friend invitations. More...
 

Public Member Functions

virtual void OnFriendInvitationListRetrieveSuccess ()=0
 Notification for the event of a success in retrieving the user's list of incoming friend invitations. More...
 
virtual void OnFriendInvitationListRetrieveFailure (FailureReason failureReason)=0
 Notification for the event of a failure in retrieving the user's list of incoming friend invitations. More...
 

Additional Inherited Members

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

Detailed Description

Listener for the event of retrieving requested list of incoming friend invitations.

Member Enumeration Documentation

◆ FailureReason

The reason of a failure in retrieving the user's list of incoming friend invitations.

Enumerator
FAILURE_REASON_UNDEFINED 

Unspecified error.

FAILURE_REASON_CONNECTION_FAILURE 

Unable to communicate with backend services.

Member Function Documentation

◆ OnFriendInvitationListRetrieveFailure()

virtual void OnFriendInvitationListRetrieveFailure ( FailureReason  failureReason)
pure virtual

Notification for the event of a failure in retrieving the user's list of incoming friend invitations.

Parameters
[in]failureReasonThe cause of the failure.

◆ OnFriendInvitationListRetrieveSuccess()

virtual void OnFriendInvitationListRetrieveSuccess ( )
pure virtual

Notification for the event of a success in retrieving the user's list of incoming friend invitations.

In order to read subsequent invitation IDs, call and IFriends::GetFriendInvitationByIndex().