Listener for the event of retrieving a chat room with a specified user. More...

#include <IChat.h>

Inheritance diagram for IChatRoomWithUserRetrieveListener:

Public Types
enum	FailureReason { FAILURE_REASON_UNDEFINED , FAILURE_REASON_FORBIDDEN , FAILURE_REASON_CONNECTION_FAILURE }
	The reason of a failure in retrieving a chat room with a specified user. More...

Public Member Functions
virtual void	OnChatRoomWithUserRetrieveSuccess (GalaxyID userID, ChatRoomID chatRoomID)=0
	Notification for the event of retrieving a chat room with a specified user. More...

virtual void	OnChatRoomWithUserRetrieveFailure (GalaxyID userID, FailureReason failureReason)=0
	Notification for the event of a failure in retrieving a chat room with a specified user. More...

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

Detailed Description

Listener for the event of retrieving a chat room with a specified user.

Member Enumeration Documentation

The reason of a failure in retrieving a chat room with a specified user.

Enumerator
FAILURE_REASON_UNDEFINED	Unspecified error.
FAILURE_REASON_FORBIDDEN	Communication with a specified user is not allowed.
FAILURE_REASON_CONNECTION_FAILURE	Unable to communicate with backend services.

virtual void OnChatRoomWithUserRetrieveFailure	(	GalaxyID	userID,
		FailureReason	failureReason
	)

pure virtual

Notification for the event of a failure in retrieving a chat room with a specified user.

Parameters

[in]	userID	The ID of the user with whom a chat room was requested.
[in]	failureReason	The cause of the failure.

virtual void OnChatRoomWithUserRetrieveSuccess	(	GalaxyID	userID,
		ChatRoomID	chatRoomID
	)

pure virtual

Notification for the event of retrieving a chat room with a specified user.

Parameters

[in]	userID	The ID of the user with whom a chat room was requested.
[in]	chatRoomID	The ID of the retrieved chat room.