Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > OnlineSubsystem > Interfaces > IOnlinePresence

Light Theme

Dark Theme

IOnlinePresence

Interface class for getting and setting rich presence information.

Windows

MacOS

Linux

References

Module	OnlineSubsystem
Header	/Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlinePresenceInterface.h
Include	#include "Interfaces/OnlinePresenceInterface.h"

Syntax

class IOnlinePresence

Remarks

Interface class for getting and setting rich presence information.

Variables

		Name	Description
	FOnPresenceArra...	OnPresenceArrayUpdatedDelegates	Delegate executed when the array of presence data for a user changes.
	FOnPresenceRece...	OnPresenceReceivedDelegates	Delegate executed when new presence data is available for a user.

Destructors

	Name	Description
	~IOnlinePresence()	Virtual destructor to force proper child cleanup

Functions

	Name	Description
FDelegateHan...	AddOnPresenceArrayUpdatedDelegate_Handle ( const FOnPresenceArrayUpdatedDelega... )
FDelegateHan...	AddOnPresenceReceivedDelegate_Handle ( const FOnPresenceReceivedDelegate&... )
void	ClearOnPresenceArrayUpdatedDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnPresenceArrayUpdatedDelegates ( void* Object )
void	ClearOnPresenceReceivedDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnPresenceReceivedDelegates ( void* Object )
EOnlineCache...	GetCachedPresence ( const FUniqueNetId& User, TSharedPtr< FOnlineUserPresence >&... )	Gets the cached presence information for a user.
EOnlineCache...	GetCachedPresenceForApp ( const FUniqueNetId& LocalUserId, const FUniqueNetId& User, const FString& AppId, TSharedPtr< FOnlineUserPresence >&... )	Gets the cached presence information for a user.
void	QueryPresence ( const FUniqueNetId& User, const FOnPresenceTaskCompleteDelega... )	Starts an async operation that will update the cache with presence data from all users in the Users array.
void	QueryPresence ( const FUniqueNetId& LocalUserId, const TArray< FUniqueNetIdRef >& U..., const FOnPresenceTaskCompleteDelega... )	Starts an async operation that will update the cache with presence data from all users in the Users array.
void	SetPresence ( const FUniqueNetId& User, const FOnlineUserPresenceStatus& S..., const FOnPresenceTaskCompleteDelega... )	Starts an async task that sets presence information for the user.
void	TriggerOnPresenceArrayUpdatedDelegates ( const FUniqueNetId& Param1, const TArray< TSharedRef< FOnlineUs... )
void	TriggerOnPresenceReceivedDelegates ( const FUniqueNetId& Param1, const TSharedRef< FOnlineUserPresen... )

Typedefs

Name	Description
FOnPresenceTaskCompleteDelegate	Delegate executed when setting or querying presence for a user has completed.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss