Navigation
API > API/Runtime > API/Runtime/XMPP
Base interface for connecting to Xmpp
| Name | IXmppConnection |
| Type | class |
| Header File | /Engine/Source/Runtime/Online/XMPP/Public/XmppConnection.h |
| Include Path | #include "XmppConnection.h" |
Syntax
class IXmppConnection : public TSharedFromThis< IXmppConnection >
Inheritance Hierarchy
- TSharedFromThis< IXmppConnection > → IXmppConnection
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IXmppConnection() |
Destructor | XmppConnection.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnXmppLoginChanged | TMulticastDelegate_TwoParams< void, const FXmppUserJid &, EXmppLoginStatus::Type > | Delegate called when login completes | XmppConnection.h |
| FOnXmppLoginComplete | TMulticastDelegate_ThreeParams< void, const FXmppUserJid &, bool, const FString & > | Delegate called when login completes | XmppConnection.h |
| FOnXmppLogoutComplete | TMulticastDelegate_ThreeParams< void, const FXmppUserJid &, bool, const FString & > | Delegate called when logout completes | XmppConnection.h |
| FOnXmppStanzaReceived | TMulticastDelegate_OneParam< void, const IXmppStanza & > | Alias for old typo, remove in 4.24 Delegate called when a message is received (ONLY STROPHE) | XmppConnection.h |
| FOnXmppStanzaSent | TMulticastDelegate_OneParam< void, const IXmppStanza & > | Delegate called when a message is sent (ONLY STROPHE) | XmppConnection.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void DumpState() |
Debug dump of this connection | XmppConnection.h | |
EXmppLoginStatus::Type GetLoginStatus() |
Obtain currently cached login status | XmppConnection.h | |
const FXmppServer & GetServer() |
Obtain last server details associated with the connection | XmppConnection.h | |
const FXmppUserJid & GetUserJid() |
Get the jid of the last user login attempt Note that they may be logged out | XmppConnection.h | |
void Login
(
const FString& UserId, |
Login on the connection. | XmppConnection.h | |
void Logout () |
Logout on the connection with a user that has previously logged in. | XmppConnection.h | |
IXmppMessagesPtr Messages() |
XmppConnection.h | ||
IXmppMultiUserChatPtr MultiUserChat() |
XmppConnection.h | ||
FOnXmppLoginChanged & OnLoginChanged() |
XmppConnection.h | ||
FOnXmppLoginComplete & OnLoginComplete() |
XmppConnection.h | ||
FOnXmppLogoutComplete & OnLogoutComplete() |
XmppConnection.h | ||
FOnXmppStanzaReceived & OnStanzaReceived() |
XmppConnection.h | ||
FOnXmppStanzaSent & OnStanzaSent() |
XmppConnection.h | ||
IXmppPresencePtr Presence() |
XmppConnection.h | ||
IXmppChatPtr PrivateChat() |
XmppConnection.h | ||
IXmppPubSubPtr PubSub() |
XmppConnection.h | ||
void SetServer
(
const FXmppServer& Server |
Configure the connection with server details | XmppConnection.h |