Navigation
API > API/Runtime > API/Runtime/XMPP
Interface for updating presence for current user and for obtaining updates of roster members
| Name | IXmppPresence |
| Type | class |
| Header File | /Engine/Source/Runtime/Online/XMPP/Public/XmppPresence.h |
| Include Path | #include "XmppPresence.h" |
Syntax
class IXmppPresence
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IXmppPresence() |
Destructor | XmppPresence.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnXmppPresenceReceived | TMulticastDelegate_ThreeParams< void, const TSharedRef< IXmppConnection > &, const FXmppUserJid &, const TSharedRef< FXmppUserPresence > & > | Delegate callback for when new presence data is received for a given user. | XmppPresence.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FXmppUserPresence & GetPresence() |
Get the last cached presence for the current user | XmppPresence.h | |
void GetRosterMembers
(
TArray< FXmppUserJid >& OutMembers |
Obtain a list of current roster member id | XmppPresence.h | |
TArray< TSharedPtr< FXmppUserPresence > > GetRosterPresence
(
const FString& UserId |
Obtain presence info for a given roster member id | XmppPresence.h | |
FOnXmppPresenceReceived & OnReceivePresence() |
XmppPresence.h | ||
bool QueryPresence
(
const FString& UserId |
Kick off a query for presence data for a given user | XmppPresence.h | |
bool UpdatePresence
(
const FXmppUserPresence& Presence |
Send a presence update to Xmpp service for current user logged in with the connection. | XmppPresence.h |