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

#include <XmppStanza.h>

Public Member Functions

virtual ~IXmppStanza ()
 
virtual FString GetName () const =0
 
virtual FString GetText () const =0
 
virtual FString GetType () const =0
 
virtual FString GetId () const =0
 
virtual FXmppUserJid GetTo () const =0
 
virtual FXmppUserJid GetFrom () const =0
 
virtual FString GetAttribute (const FString &Key) const =0
 
virtual bool HasAttribute (const FString &Key) const =0
 
virtual TOptional< FString > GetBodyText () const =0
 
virtual TUniquePtr< IXmppStanzaGetChild (const FString &ChildName) const =0
 
virtual bool HasChild (const FString &ChildName) const =0
 

Detailed Description

Xmpp stanza abstract interface Exposes getters for various attributes and fields of an Xmpp stanza

Constructor & Destructor Documentation

◆ ~IXmppStanza()

virtual IXmppStanza::~IXmppStanza ( )
inlinevirtual

Member Function Documentation

◆ GetAttribute()

virtual FString IXmppStanza::GetAttribute ( const FString &  Key) const
pure virtual

Get Stanza attribute

Parameters
Keyattribute name
Returns
attribute text

◆ GetBodyText()

virtual TOptional< FString > IXmppStanza::GetBodyText ( ) const
pure virtual

Get stanza body text (if any)

Returns
Stanza body text

◆ GetChild()

virtual TUniquePtr< IXmppStanza > IXmppStanza::GetChild ( const FString &  ChildName) const
pure virtual

Get given Stanza child, if existing

Parameters
ChildNamename of child to return
Returns
Stanza ChildName, if it exists

◆ GetFrom()

virtual FXmppUserJid IXmppStanza::GetFrom ( ) const
pure virtual

Get Stanza from (source) user Jid

Returns
Stanza from Jid

◆ GetId()

virtual FString IXmppStanza::GetId ( ) const
pure virtual

Get Stanza Id

Returns
Stanza Id

◆ GetName()

virtual FString IXmppStanza::GetName ( ) const
pure virtual

Get Stanza type (presence, query, message)

Returns
stanza type

◆ GetText()

virtual FString IXmppStanza::GetText ( ) const
pure virtual

Get Stanza text (concatenates all child text nodes)

Returns
stanza text

◆ GetTo()

virtual FXmppUserJid IXmppStanza::GetTo ( ) const
pure virtual

Get Stanza to (destination) user Jid

Returns
Stanza to Jid

◆ GetType()

virtual FString IXmppStanza::GetType ( ) const
pure virtual

Get Stanza type

Returns
stanza type

◆ HasAttribute()

virtual bool IXmppStanza::HasAttribute ( const FString &  Key) const
pure virtual

Returns whether or not stanza has a given attribute

Parameters
Keyattribute name
Returns
whether or not stanza has attribute named Key

◆ HasChild()

virtual bool IXmppStanza::HasChild ( const FString &  ChildName) const
pure virtual

Whether or not Stanza has a given child

Parameters
ChildNamename of child to check for
Returns
Whether or not Stanza has child ChildName

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