Listener for the event of searching a user. More...

#include <IFriends.h>

Inheritance diagram for IUserFindListener:

Public Types
enum	FailureReason { FAILURE_REASON_UNDEFINED , FAILURE_REASON_USER_NOT_FOUND , FAILURE_REASON_CONNECTION_FAILURE }
	The reason of a failure in searching a user. More...

Public Member Functions
virtual void	OnUserFindSuccess (const char *userSpecifier, GalaxyID userID)=0
	Notification for the event of success in finding a user. More...

virtual void	OnUserFindFailure (const char *userSpecifier, FailureReason failureReason)=0
	Notification for the event of a failure in finding a user. More...

Additional Inherited Members
Static Public Member Functions inherited from GalaxyTypeAwareListener< USER_FIND_LISTENER >
static ListenerType	GetListenerType ()
	Returns the type of the listener. More...

Detailed Description

Listener for the event of searching a user.

Member Enumeration Documentation

The reason of a failure in searching a user.

Enumerator
FAILURE_REASON_UNDEFINED	Unspecified error.
FAILURE_REASON_USER_NOT_FOUND	Specified user was not found.
FAILURE_REASON_CONNECTION_FAILURE	Unable to communicate with backend services.

virtual void OnUserFindFailure	(	const char *	userSpecifier,
		FailureReason	failureReason
	)

pure virtual

Notification for the event of a failure in finding a user.

Parameters

[in]	userSpecifier	The user specifier by which user search was performed.
[in]	failureReason	The cause of the failure.

virtual void OnUserFindSuccess	(	const char *	userSpecifier,
		GalaxyID	userID
	)

pure virtual

Notification for the event of success in finding a user.

Parameters

[in]	userSpecifier	The user specifier by which user search was performed.
[in]	userID	The ID of the found user.