IXmppPresence Class Reference

#include <XmppPresence.h>

Public Member Functions
virtual	~IXmppPresence ()
virtual bool	UpdatePresence (const FXmppUserPresence &Presence)=0
virtual const FXmppUserPresence &	GetPresence () const =0
virtual bool	QueryPresence (const FString &UserId)=0
virtual void	GetRosterMembers (TArray< FXmppUserJid > &OutMembers)=0
virtual TArray< TSharedPtr< FXmppUserPresence > >	GetRosterPresence (const FString &UserId)=0
	DECLARE_MULTICAST_DELEGATE_ThreeParams (FOnXmppPresenceReceived, const TSharedRef< IXmppConnection > &, const FXmppUserJid &, const TSharedRef< FXmppUserPresence > &)
virtual FOnXmppPresenceReceived &	OnReceivePresence ()=0

Detailed Description

Interface for updating presence for current user and for obtaining updates of roster members

Constructor & Destructor Documentation

~IXmppPresence()

virtual IXmppPresence::~IXmppPresence ( )

inlinevirtual

destructor

Member Function Documentation

DECLARE_MULTICAST_DELEGATE_ThreeParams()

IXmppPresence::DECLARE_MULTICAST_DELEGATE_ThreeParams	(	FOnXmppPresenceReceived	,
		const TSharedRef< IXmppConnection > &	,
		const FXmppUserJid &	,
		const TSharedRef< FXmppUserPresence > &
	)

Delegate callback for when new presence data is received for a given user. Can also obtain cached data via GetRosterPresence()

Parameters

Connection	the xmpp connection this message was received on
UserId	roster member or current user that updated
Presence	presence data that was received

GetPresence()

virtual const FXmppUserPresence & IXmppPresence::GetPresence ( ) const

pure virtual

Get the last cached presence for the current user

Returns

Presence status data

GetRosterMembers()

virtual void IXmppPresence::GetRosterMembers ( TArray< FXmppUserJid > &  OutMembers )

pure virtual

Obtain a list of current roster member id

Parameters

OutMembers

[out] members to update

GetRosterPresence()

virtual TArray< TSharedPtr< FXmppUserPresence > > IXmppPresence::GetRosterPresence ( const FString &  UserId )

pure virtual

Obtain presence info for a given roster member id

Returns

cached presence or NULL if not found

OnReceivePresence()

virtual FOnXmppPresenceReceived & IXmppPresence::OnReceivePresence ( )

pure virtual

Returns

presence received delegate

QueryPresence()

virtual bool IXmppPresence::QueryPresence ( const FString &  UserId )

pure virtual

Kick off a query for presence data for a given user

Returns

true if successfully sent

UpdatePresence()

virtual bool IXmppPresence::UpdatePresence ( const FXmppUserPresence &  Presence )

pure virtual

Send a presence update to Xmpp service for current user logged in with the connection. Also updates cached copy of presence data

Parameters

Presence

status data to update

Returns

true if successfully sent

---

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

• Engine/Source/Runtime/Online/XMPP/Public/XmppPresence.h