UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
IXmppChat Class Referenceabstract

#include <XmppChat.h>

Public Member Functions

virtual ~IXmppChat ()
 
virtual bool SendChat (const FXmppUserJid &RecipientId, const FString &Message)=0
 
 DECLARE_MULTICAST_DELEGATE_ThreeParams (FOnXmppChatReceived, const TSharedRef< IXmppConnection > &, const FXmppUserJid &, const TSharedRef< FXmppChatMessage > &)
 
virtual FOnXmppChatReceived & OnReceiveChat ()=0
 

Detailed Description

Interface for sending/receiving chat messages between users

Constructor & Destructor Documentation

◆ ~IXmppChat()

virtual IXmppChat::~IXmppChat ( )
inlinevirtual

destructor

Member Function Documentation

◆ DECLARE_MULTICAST_DELEGATE_ThreeParams()

IXmppChat::DECLARE_MULTICAST_DELEGATE_ThreeParams ( FOnXmppChatReceived  ,
const TSharedRef< IXmppConnection > &  ,
const FXmppUserJid &  ,
const TSharedRef< FXmppChatMessage > &   
)

Delegate callback for when a new chat message is received

Parameters
Connectionthe xmpp connection that received the chat
FromIdid of user that sent the chat
Chatdata that was received

◆ OnReceiveChat()

virtual FOnXmppChatReceived & IXmppChat::OnReceiveChat ( )
pure virtual
Returns
chat received delegate

◆ SendChat()

virtual bool IXmppChat::SendChat ( const FXmppUserJid &  RecipientId,
const FString &  Message 
)
pure virtual

Send a chat to a user via xmpp service

Parameters
RecipientIduser to send chat to (must be online)
Messagechat message to send
Returns
true if successfully sent
The documentation for this class was generated from the following file: