Listener for the event of retrieving chat room messages in a specified chat room. More...

#include <IChat.h>

Inheritance diagram for IChatRoomMessagesRetrieveListener:

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

Public Member Functions
virtual void	OnChatRoomMessagesRetrieveSuccess (ChatRoomID chatRoomID, uint32_t messageCount, uint32_t longestMessageLenght)=0
	Notification for the event of retrieving chat room messages in a specified chat room. More...

virtual void	OnChatRoomMessagesRetrieveFailure (ChatRoomID chatRoomID, FailureReason failureReason)=0
	Notification for the event of a failure in retrieving chat room messages in a specified chat room. More...

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

Detailed Description

Listener for the event of retrieving chat room messages in a specified chat room.

Member Enumeration Documentation

The reason of a failure in retrieving chat room messages in a specified chat room.

Enumerator
FAILURE_REASON_UNDEFINED	Unspecified error.
FAILURE_REASON_FORBIDDEN	Retrieving messages from the chat room is forbidden for the user.
FAILURE_REASON_CONNECTION_FAILURE	Unable to communicate with backend services.

virtual void OnChatRoomMessagesRetrieveFailure	(	ChatRoomID	chatRoomID,
		FailureReason	failureReason
	)

pure virtual

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

Parameters

[in]	chatRoomID	The ID of the chat room.
[in]	failureReason	The cause of the failure.

virtual void OnChatRoomMessagesRetrieveSuccess	(	ChatRoomID	chatRoomID,
		uint32_t	messageCount,
		uint32_t	longestMessageLenght
	)

pure virtual

Notification for the event of retrieving chat room messages in a specified chat room.

In order to read subsequent messages, call IChat::GetChatRoomMessageByIndex().

Parameters

[in]	chatRoomID	The ID of the chat room.
[in]	messageCount	The amount of messages received in the chat room.
[in]	longestMessageLenght	The length of the longest message.