GOG GALAXY SDK Documentation
ISendInvitationListener Class Referenceabstract

Listener for the event of sending an invitation without using the overlay. More...

#include <IFriends.h>

Inheritance diagram for ISendInvitationListener:
[legend]

Public Types

enum  FailureReason {
  FAILURE_REASON_UNDEFINED , FAILURE_REASON_USER_DOES_NOT_EXIST , FAILURE_REASON_RECEIVER_DOES_NOT_ALLOW_INVITING , FAILURE_REASON_SENDER_DOES_NOT_ALLOW_INVITING ,
  FAILURE_REASON_RECEIVER_BLOCKED , FAILURE_REASON_SENDER_BLOCKED , FAILURE_REASON_CONNECTION_FAILURE
}
 The reason of a failure in sending an invitation. More...
 

Public Member Functions

virtual void OnInvitationSendSuccess (GalaxyID userID, const char *connectionString)=0
 Notification for the event of success in sending an invitation. More...
 
virtual void OnInvitationSendFailure (GalaxyID userID, const char *connectionString, FailureReason failureReason)=0
 Notification for the event of a failure in sending an invitation. More...
 

Additional Inherited Members

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

Detailed Description

Listener for the event of sending an invitation without using the overlay.

Member Enumeration Documentation

◆ FailureReason

The reason of a failure in sending an invitation.

Enumerator
FAILURE_REASON_UNDEFINED 

Unspecified error.

FAILURE_REASON_USER_DOES_NOT_EXIST 

Receiver does not exist.

FAILURE_REASON_RECEIVER_DOES_NOT_ALLOW_INVITING 

Receiver does not allow inviting.

FAILURE_REASON_SENDER_DOES_NOT_ALLOW_INVITING 

Sender does not allow inviting.

FAILURE_REASON_RECEIVER_BLOCKED 

Receiver blocked by sender.

FAILURE_REASON_SENDER_BLOCKED 

Sender blocked by receiver. Will also occur if both users blocked each other.

FAILURE_REASON_CONNECTION_FAILURE 

Unable to communicate with backend services.

Member Function Documentation

◆ OnInvitationSendFailure()

virtual void OnInvitationSendFailure ( GalaxyID  userID,
const char *  connectionString,
FailureReason  failureReason 
)
pure virtual

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

Parameters
[in]userIDThe ID of the user to whom the invitation was being sent.
[in]connectionStringThe string which contains connection info.
[in]failureReasonThe cause of the failure.

◆ OnInvitationSendSuccess()

virtual void OnInvitationSendSuccess ( GalaxyID  userID,
const char *  connectionString 
)
pure virtual

Notification for the event of success in sending an invitation.

Parameters
[in]userIDThe ID of the user to whom the invitation was being sent.
[in]connectionStringThe string which contains connection info.