1. Epic GamesDeveloper
  3. IOnlinePresence

IOnlinePresence

Interface class for getting and setting rich presence information.

API > API/Plugins > API/Plugins/OnlineSubsystem > API/Plugins/OnlineSubsystem/Interfaces

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

  Type Name Description
Public variable FOnPresenceArrayUpdated OnPresenceArrayUpdatedDelegates Delegate executed when the array of presence data for a user changes.
Public variable FOnPresenceReceived OnPresenceReceivedDelegates Delegate executed when new presence data is available for a user.

Destructors

  Type Name Description
Public function Virtual   Virtual destructor to force proper child cleanup

Functions

  Type Name Description
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function EOnlineCachedResult::Type Gets the cached presence information for a user.
Public function EOnlineCachedResult::Type

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

 Gets the cached presence information for a user.
Public function void Starts an async operation that will update the cache with presence data from all users in the Users array.
Public function 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.
Public function void

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

 Starts an async task that sets presence information for the user.
Public function Virtual void Starts an async task that sets presence information for the user.
Public function Virtual void  
Public function Virtual void  

Typedefs

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page