GOG GALAXY SDK Documentation
IFriendInvitationSendListener Class Referenceabstract

Listener for the event of sending a friend invitation. More...

#include <IFriends.h>

Inheritance diagram for IFriendInvitationSendListener:
[legend]

Public Types

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
}
 The reason of a failure in sending a friend invitation. More...
 

Public Member Functions

virtual void OnFriendInvitationSendSuccess (GalaxyID userID)=0
 Notification for the event of a success in sending a friend invitation. More...
 
virtual void OnFriendInvitationSendFailure (GalaxyID userID, FailureReason failureReason)=0
 Notification for the event of a failure in sending a friend invitation. More...
 

Additional Inherited Members

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

Detailed Description

Listener for the event of sending a friend invitation.

Member Enumeration Documentation

◆ FailureReason

The reason of a failure in sending a friend invitation.

Enumerator
FAILURE_REASON_UNDEFINED 

Unspecified error.

FAILURE_REASON_USER_DOES_NOT_EXIST 

User does not exist.

FAILURE_REASON_USER_ALREADY_INVITED 

Friend invitation already sent to the user.

FAILURE_REASON_USER_ALREADY_FRIEND 

User already on the friend list.

FAILURE_REASON_CONNECTION_FAILURE 

Unable to communicate with backend services.

Member Function Documentation

◆ OnFriendInvitationSendFailure()

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

Notification for the event of a failure in sending a friend invitation.

Parameters
[in]userIDThe ID of the user to whom the invitation was being sent.
[in]failureReasonThe cause of the failure.

◆ OnFriendInvitationSendSuccess()

virtual void OnFriendInvitationSendSuccess ( GalaxyID  userID)
pure virtual

Notification for the event of a success in sending a friend invitation.

Parameters
[in]userIDThe ID of the user to whom the invitation was being sent.