UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
IXmppMessages Class Referenceabstract

#include <XmppMessages.h>

Public Member Functions

virtual ~IXmppMessages ()
 
virtual bool SendMessage (const FXmppUserJid &RecipientId, const FString &Type, const FString &Payload, bool bPayloadIsSerializedJson=false)=0
 
virtual bool SendMessage (const FXmppUserJid &RecipientId, const FString &Type, const TSharedRef< class FJsonObject > &Payload)=0
 
 DECLARE_MULTICAST_DELEGATE_ThreeParams (FOnXmppMessageReceived, const TSharedRef< IXmppConnection > &, const FXmppUserJid &, const TSharedRef< FXmppMessage > &)
 
virtual FOnXmppMessageReceivedOnReceiveMessage ()=0
 

Detailed Description

Interface for sending/receiving messages between users (also admin to user notifications)

Constructor & Destructor Documentation

◆ ~IXmppMessages()

virtual IXmppMessages::~IXmppMessages ( )
inlinevirtual

destructor

Member Function Documentation

◆ DECLARE_MULTICAST_DELEGATE_ThreeParams()

IXmppMessages::DECLARE_MULTICAST_DELEGATE_ThreeParams ( FOnXmppMessageReceived  ,
const TSharedRef< IXmppConnection > &  ,
const FXmppUserJid ,
const TSharedRef< FXmppMessage > &   
)

Delegate callback for when a new message is received

Parameters
Connectionthe xmpp connection this message was received on
FromIdid of user that sent the message (might be admin)
Messagedata that was received

◆ OnReceiveMessage()

virtual FOnXmppMessageReceived & IXmppMessages::OnReceiveMessage ( )
pure virtual
Returns
message received delegate

◆ SendMessage() [1/2]

virtual bool IXmppMessages::SendMessage ( const FXmppUserJid RecipientId,
const FString &  Type,
const FString &  Payload,
bool  bPayloadIsSerializedJson = false 
)
pure virtual

Send a message to a user via xmpp service

Parameters
RecipientIduser to send message to (must be online)
Typemessage type
Payloadmessage data to send
Returns
true if successfully sent

◆ SendMessage() [2/2]

virtual bool IXmppMessages::SendMessage ( const FXmppUserJid RecipientId,
const FString &  Type,
const TSharedRef< class FJsonObject > &  Payload 
)
pure virtual

The documentation for this class was generated from the following file: