1. Epic GamesDeveloper
  3. IOnlinePresence

IOnlinePresence

Interface class for getting and setting rich presence information.

API > API/Plugins > API/Plugins/OnlineSubsystem

Interface class for getting and setting rich presence information.

   
Name IOnlinePresence
Type class
Header File /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlinePresenceInterface.h
Include Path #include "Interfaces/OnlinePresenceInterface.h"

Syntax

class IOnlinePresence

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IOnlinePresence()

 Virtual destructor to force proper child cleanup Interfaces/OnlinePresenceInterface.h  

Typedefs

Name Type Remarks Include Path
FOnPresenceTaskCompleteDelegate TBaseDelegate_TwoParams< void, const class FUniqueNetId &, const bool > Delegate executed when setting or querying presence for a user has completed. Interfaces/OnlinePresenceInterface.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnPresenceArrayUpdatedDelegates FOnPresenceArrayUpdated Delegate executed when the array of presence data for a user changes. Interfaces/OnlinePresenceInterface.h  
OnPresenceReceivedDelegates FOnPresenceReceived Delegate executed when new presence data is available for a user. Interfaces/OnlinePresenceInterface.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual FDelegateHandle AddOnPresenceArrayUpdatedDelegate_Handle ( const FOnPresenceArrayUpdatedDelegate& Delegate
)

   Interfaces/OnlinePresenceInterface.h  

virtual FDelegateHandle AddOnPresenceReceivedDelegate_Handle ( const FOnPresenceReceivedDelegate& Delegate
)

   Interfaces/OnlinePresenceInterface.h  

virtual void ClearOnPresenceArrayUpdatedDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlinePresenceInterface.h  

virtual void ClearOnPresenceArrayUpdatedDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlinePresenceInterface.h  

virtual void ClearOnPresenceReceivedDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlinePresenceInterface.h  

virtual void ClearOnPresenceReceivedDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlinePresenceInterface.h  

EOnlineCachedResult::Type GetCachedPresence ( const FUniqueNetId& User,
TSharedPtr< FOnlineUserPresence >& OutPresence
)

 Gets the cached presence information for a user. Interfaces/OnlinePresenceInterface.h  

EOnlineCachedResult::Type GetCachedPresenceForApp ( const FUniqueNetId& LocalUserId,
const FUniqueNetId& User,
const FString& AppId,
TSharedPtr< FOnlineUserPresence >& OutPresence
)

 Gets the cached presence information for a user. Interfaces/OnlinePresenceInterface.h  

void QueryPresence ( const FUniqueNetId& User,
const FOnPresenceTaskCompleteDelegate& Delegate
)

 Starts an async operation that will update the cache with presence data from all users in the Users array. Interfaces/OnlinePresenceInterface.h  

virtual void QueryPresence ( const FUniqueNetId& LocalUserId,
const TArray< FUniqueNetIdRef >& UserIds,
const FOnPresenceTaskCompleteDelegate& Delegate
)

 Starts an async operation that will update the cache with presence data from all users in the Users array. Interfaces/OnlinePresenceInterface.h  

void SetPresence ( const FUniqueNetId& User,
const FOnlineUserPresenceStatus& Status,
const FOnPresenceTaskCompleteDelegate& Delegate
)

 Starts an async task that sets presence information for the user. Interfaces/OnlinePresenceInterface.h  

virtual void SetPresence ( const FUniqueNetId& User,
FOnlinePresenceSetPresenceParameters&& Parameters,
const FOnPresenceTaskCompleteDelegate& Delegate
)

 Starts an async task that sets presence information for the user. Interfaces/OnlinePresenceInterface.h  

virtual void TriggerOnPresenceArrayUpdatedDelegates ( const FUniqueNetId& Param1,
const TArray< TSharedRef< FOnlineUserPresence > >& Param2
)

   Interfaces/OnlinePresenceInterface.h  

virtual void TriggerOnPresenceReceivedDelegates ( const FUniqueNetId& Param1,
const TSharedRef< FOnlineUserPresence >& Param2
)

   Interfaces/OnlinePresenceInterface.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page