GOG GALAXY SDK Documentation
IChatRoomMessageSendListener Class Referenceabstract

Listener for the event of sending a chat room message. More...

#include <IChat.h>

Inheritance diagram for IChatRoomMessageSendListener:
[legend]

Public Types

enum  FailureReason { FAILURE_REASON_UNDEFINED , FAILURE_REASON_FORBIDDEN , FAILURE_REASON_CONNECTION_FAILURE }
 The reason of a failure in sending a message to a chat room. More...
 

Public Member Functions

virtual void OnChatRoomMessageSendSuccess (ChatRoomID chatRoomID, uint32_t sentMessageIndex, ChatMessageID messageID, uint32_t sendTime)=0
 Notification for the event of sending a chat room message. More...
 
virtual void OnChatRoomMessageSendFailure (ChatRoomID chatRoomID, uint32_t sentMessageIndex, FailureReason failureReason)=0
 Notification for the event of a failure in sending a message to a chat room. More...
 

Additional Inherited Members

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

Detailed Description

Listener for the event of sending a chat room message.

Member Enumeration Documentation

◆ FailureReason

The reason of a failure in sending a message to a chat room.

Enumerator
FAILURE_REASON_UNDEFINED 

Unspecified error.

FAILURE_REASON_FORBIDDEN 

Sending messages to the chat room is forbidden for the user.

FAILURE_REASON_CONNECTION_FAILURE 

Unable to communicate with backend services.

Member Function Documentation

◆ OnChatRoomMessageSendFailure()

virtual void OnChatRoomMessageSendFailure ( ChatRoomID  chatRoomID,
uint32_t  sentMessageIndex,
FailureReason  failureReason 
)
pure virtual

Notification for the event of a failure in sending a message to a chat room.

Parameters
[in]chatRoomIDThe ID of the chat room.
[in]sentMessageIndexThe internal index of the sent message.
[in]failureReasonThe cause of the failure.

◆ OnChatRoomMessageSendSuccess()

virtual void OnChatRoomMessageSendSuccess ( ChatRoomID  chatRoomID,
uint32_t  sentMessageIndex,
ChatMessageID  messageID,
uint32_t  sendTime 
)
pure virtual

Notification for the event of sending a chat room message.

Parameters
[in]chatRoomIDThe ID of the chat room.
[in]sentMessageIndexThe internal index of the sent message.
[in]messageIDThe ID of the sent message.
[in]sendTimeThe time at which the message was sent.