1. Epic GamesDeveloper
  3. OnlineSubsystem

OnlineSubsystem

API > API/Plugins

Filters

Classes

  Type Name Description
Public struct FCloudFile Holds the data used in downloading a file asynchronously from the online service  
Public struct FCloudFileHeader Holds metadata about a given downloadable file  
Public struct FColumnMetaData Representation of a single column of data in a leaderboard  
Public class FNameArrayDeprecationWrapper    
Public class FNameDeprecationWrapper    
Public struct UStruct FNamedInterface Named interfaces for Online Subsystem Holds a named object interface for dynamically bound interfaces  
Public struct UStruct FNamedInterfaceDef Holds a name to class name mapping for adding the named interfaces automatically  
Public class FNamedOnlineSession Holds the per session information for named sessions  
Public class FNboSerializeFromBufferOSS Class used to read data from a NBO data buffer  
Public class FNboSerializeToBufferOSS Serializes data in network byte order form into a buffer  
Public class FOnlineAchievementsWrite The interface for writing achievement stats to the server.  
Public class FOnlineAsyncEvent An event triggered by the online subsystem to be routed to the game thread for processing Originates on the online thread  
Public class FOnlineAsyncItem Base class of any async task that can be returned to the game thread by the async task manager May originate on the game thread, or generated by an external platform service callback from the online thread itself  
Public class FOnlineAsyncTask A single task for an online service to be queued with the async task manager Originates on the game thread  
Public class FOnlineAsyncTaskBasic    
Public class FOnlineAsyncTaskGenericCallable An async task that can execute any callable type with no parameters.  
Public class FOnlineAsyncTaskManager The foundation of all async operations in every online subsystem  
Public class FOnlineAsyncTaskThreadedGenericCallable An async task that can execute any callable type with no parameters.  
Public class FOnlineBlockedPlayer Blocked user info returned via IOnlineFriends interface  
Public struct FOnlineError Generic Error response for OSS calls  
Public class FOnlineFriend Friend user info returned via IOnlineFriends interface  
Public class FOnlineFriendSettingsSourceData    
Public class FOnlineKeyValuePairs Associative container for key value pairs  
Public class FOnlineLeaderboardRead Interface for reading data from a leaderboard service  
Public class FOnlineLeaderboardWrite Interface for storing/writing data to a leaderboard  
Public struct FOnlineNotification Notification object, used to send messages between systems  
Public struct FOnlineNotificationBinding Struct to keep track of bindings  
Public class FOnlineNotificationHandler This class is a static manager used to track notification transports and map the delivered notifications to subscribed notification handlers  
Public class FOnlineNotificationTransportManager This class is a static manager used to track notification transports and map the delivered notifications to subscribed notification handlers  
Public class FOnlinePagedResult Info for a response with paged results  
Public class FOnlinePartyId Id of a party instance  
Public class FOnlinePartyTypeId Id of a party's type  
Public class FOnlinePlayerScore TODO ONLINE.  
Public class FOnlineRecentPlayer Recent player user info returned via IOnlineFriends interface  
Public class FOnlineSearchSettings Container for all parameters describing a single session search  
Public class FOnlineSession Basic session information serializable into a NamedSession or SearchResults  
Public class FOnlineSessionInfo Abstraction of a session's platform specific info The class is meant to be opaque (see IOnlinePlatformData)  
Public class FOnlineSessionSearch Encapsulation of a search for sessions request.  
Public class FOnlineSessionSearchParam One search parameter in an online session query contains a value and how this setting is compared  
Public class FOnlineSessionSearchResult Representation of a single search result from a FindSession() call  
Public struct FOnlineSessionSetting One setting describing an online session contains a key, value and how this setting is advertised to others, if at all  
Public class FOnlineSessionSettings Container for all settings describing a single online session  
Public class FOnlineStats An interface used to collect and manage online stats  
Public struct FOnlineStatsRow Representation of a single row in a retrieved leaderboard  
Public class FOnlineSubsystemDelegates Online subsystem delegates that are more external to the online subsystems themselves This is NOT to replace the individual interfaces that have the Add/Clear/Trigger syntax  
Public class FOnlineSubsystemImpl FOnlineSubsystemImpl - common functionality to share across online platforms, not intended for direct use  
Public class FOnlineSubsystemModule Online subsystem module class Wraps the loading of an online subsystem by name and allows new services to register themselves for use  
Public class FOnlineUser Base for all online user info  
Public class FPagedQuery Paging info needed for a request that can return paged results  
Public class FRegionInfo Locale and country code  
Public class FSharedContentHandle Abstraction of a profile service shared file handle The class is meant to be opaque (see IOnlinePlatformData)  
Public class FStatPropertyArray Typedef FOnlineKeyValuePairsFStatPropertyArray; Temporary class to assist in deprecation of changing the key from FName to FString.  
Public class FStatsColumnArray Typedef FOnlineKeyValuePairsFStatsColumnArray; Temporary class to assist in deprecation of changing the key from FName to FString.  
Public struct FUniqueNetIdMatcher TArray helper for IndexOfByPredicate() function  
Public class FUniqueNetIdString Unique net id wrapper for a string  
Public class FUserOnlineAccount User account information returned via IOnlineIdentity interface  
Public class FVariantData Container for storing data of variable type  
Public class FVariantDataConverter Helper class for converting from UStruct to FVariantData and back only very basic flat UStructs with POD types are supported  
Public class IOnlineFactory Interface for creating the actual online subsystem instance for a given platform all modules must implement this  
Public class IOnlinePlatformData Base class for anything meant to be opaque so that the data can be passed around without consideration for the data it contains.  
Public class IOnlineSubsystem OnlineSubsystem - Series of interfaces to support communicating with various web/platform layer services  
Public struct TOnlinePartyIdMapKeyFuncs    
Public class UClass Transient, Config UNamedInterfaces Named interfaces are a registry of UObjects accessible by an FName key that will persist for the lifetime of the process  

Constants

Name Description
NAME_Unset Placeholder "type" until we can make FUniqueNetIdString sufficiently abstract

Typedefs

Name Description
FHandleOnlineNotificationSignature Delegate type for handling a notification
FJsonSerializeableKeyValueMapVariant  
FNamedOnlineSessionPtr  
FNamedOnlineSessionRef  
FNextTickDelegate  
FNotificationTransportId Unique identifier for notification transports
FOnConfigChanged Delegate fired when a configuration change was detected as a result of ReloadConfigs being called.
FOnConfigChangedDelegate  
FOnConnectionStatusChanged Called when the connection state as reported by the online platform changes
FOnConnectionStatusChangedDelegate  
FOnlineAchievementsWritePtr  
FOnlineAchievementsWriteRef  
FOnlineJsonSerializable  
FOnlineJsonSerializerWriter  
FOnlineLeaderboardReadPtr  
FOnlineLeaderboardReadRef  
FOnlineNotificationHandlerPtr  
FOnlineNotificationHandlerPtr  
FOnlineNotificationHandlerRef  
FOnlineNotificationHandlerWeakPtr  
FOnlineNotificationTransportManagerPtr  
FOnlineNotificationTransportManagerPtr  
FOnlineSubsystemFeatureCheck Feature checks allow an application to enable online subsystem features based on runtime configuration such as the command-line.
FOnlineSubsystemModulePtr Public references to the online subsystem module pointer should use this
FOnOnlineEnvironmentChanged Delegate fired when the PSN environment changes
FOnOnlineEnvironmentChangedDelegate  
FSearchParams Type defining an array of search parameters accessible by key
FSessionSettings Type defining an array of session settings accessible by key
FUniqueNetIdStringPtr  
FUniqueNetIdStringRef  
IMessageSanitizerPtr  
IOnlineAchievementsPtr  
IOnlineChatPtr  
IOnlineContentAgeRestrictionPtr  
IOnlineEntitlementsPtr  
IOnlineEventsPtr  
IOnlineExternalUIPtr  
IOnlineFriendsPtr  
IOnlineGameActivityPtr  
IOnlineGameItemStatsPtr  
IOnlineGameMatchesPtr  
IOnlineGroupsPtr  
IOnlineIdentityPtr  
IOnlineLeaderboardsPtr  
IOnlineMessagePtr  
IOnlineNotificationTransportPtr Forward declare
IOnlinePartyPtr  
IOnlinePresencePtr  
IOnlinePurchasePtr  
IOnlineSessionPtr Forward declarations of all interface classes
IOnlineSharedCloudPtr  
IOnlineSharingPtr  
IOnlineStatsPtr  
IOnlineStoreV2Ptr  
IOnlineSubsystemPtr Public references to the online subsystem pointer should use this
IOnlineSubsystemPtr  
IOnlineTimePtr  
IOnlineTitleFilePtr  
IOnlineTournamentPtr  
IOnlineTurnBasedPtr  
IOnlineUserCloudPtr  
IOnlineUserPtr  
IOnlineVoicePtr  
TOnlinePartyIdMap  

Enums

  Type Name Description
Public enum EFeaturePrivilegeLevel::Type Possible feature privilege access levels  
Public enum EFriendInvitePolicy Permissions for who can send invites to a user.  
Public enum EInviteStatus::Type Friend list invite states  
Public enum ELeaderboardFormat::Type Leaderboard display format  
Public enum ELeaderboardSort::Type Leaderboard entry sort types  
Public enum ELeaderboardUpdateMethod::Type How to upload leaderboard score updates  
Public enum ELoginStatus::Type Possible login states  
Public enum EOnlineAsyncTaskState::Type The state of an async task (read friends, read content, write cloud file, etc) request  
Public enum EOnlineCachedResult::Type Return codes for the GetCached functions in the various subsystems.  
Public enum EOnlineComparisonOp::Type The types of comparison operations for a given search query  
Public enum EOnlineDataAdvertisementType::Type The types of advertisement of settings to use  
Public enum EOnlineEnvironment::Type Environment for the current online platform  
Public enum EOnlineErrorResult Common error results  
Public enum EOnlineFriendState::Type The possible friend states for a friend entry  
Public enum EOnlineKeyValuePairDataType::Type    
Public enum EOnlineNotificationResult Whether a handler function handled a particular notification  
Public enum EOnlineServerConnectionStatus::Type Possible connection states  
Public enum EOnlineSessionState::Type Enum indicating the current state of the online session (in progress, ended, etc.)  
Public enum EOnlineSharingCategory First 16 bits are reading permissions Second 16 bits are writing/publishing permissions  
Public enum EOnlineSharingPermissionState Valid states for user facing permissions  
Public enum EOnlineStatusUpdatePrivacy Privacy permissions used for Online Status updates  

Functions

  Type Name Description
Public function void

DumpNamedSession ( const FNamedOnlineSession* NamedSession
)

 Logs session properties used from the session settings
Public function void

DumpSession ( const FOnlineSession* Session
)

 Logs session properties used from the session settings
Public function void

DumpSessionSettings ( const FOnlineSessionSettings* SessionSettings
)

 Logs session properties used from the session settings
Public function EOnlineKeyValuePairDataType::Type  
Public function const TCHAR *  
Public function FOnlineError  
Public function const TCHAR * Configured namspace.
Public function FOnlineError  
Public function FOnlineError Input validation.
Public function FOnlineError System failures.
Public function FOnlineError  
Public function FOnlineError Configuration.
Public function FOnlineError Response failures.
Public function FOnlineError Failures.
Public function FOnlineError  
Public function int32 Retrieve the beacon port from the specified session settings
Public function int32 Generates a unique number based off of the current engine package
Public function FUniqueNetIdPtr Temp solution for some hardcoded access to logged in user 0, please avoid using this
Public function uint32

GetTypeHash ( const FOnlinePartyId& Value
)

  
Public function bool

IsPlayerInSessionImpl ( IOnlineSession* SessionInt,
FName SessionName,
const FUniqueNetId& UniqueId
)

 Common implementation for finding a player in a session
Public function bool

IsUniqueIdLocal ( const FUniqueNetId& UniqueId
)

 Is the unique id local to this instance
Public function bool  
Public function void

LexFromString ( EFriendInvitePolicy& Value,
const TCHAR* String
)

  
Public function const TCHAR *  
Public function  

LLM_DECLARE_TAG_API ( OnlineSubsystem,
ONLINESUBSYSTEM_API
)

  
Public function Static IOnlineAchievementsPtr

Online::GetAchievementsInterface ( const FName SubsystemName
)

 Get the interface for accessing entitlements online services
Public function Static IOnlineAchievementsPtr  
Public function Static IOnlineChatPtr

Online::GetChatInterface ( const FName SubsystemName
)

 Get the interface for accessing the chat services
Public function Static IOnlineChatPtr

Online::GetChatInterfaceChecked ( const FName SubsystemName
)

  
Public function Static IOnlineEntitlementsPtr

Online::GetEntitlementsInterface ( const FName SubsystemName
)

 Get the interface for accessing entitlements online services
Public function Static IOnlineEntitlementsPtr  
Public function Static IOnlineEventsPtr

Online::GetEventsInterface ( const FName SubsystemName
)

 Get the interface for accessing online events
Public function Static IOnlineEventsPtr

Online::GetEventsInterfaceChecked ( const FName SubsystemName
)

  
Public function Static IOnlineExternalUIPtr

Online::GetExternalUIInterface ( const FName SubsystemName
)

 Get the interface for accessing the external UIs of a service
Public function Static IOnlineExternalUIPtr  
Public function Static IOnlineFriendsPtr

Online::GetFriendsInterface ( const FName SubsystemName
)

 Get the interface for accessing the player friends services
Public function Static IOnlineFriendsPtr

Online::GetFriendsInterfaceChecked ( const FName SubsystemName
)

  
Public function Static IOnlineIdentityPtr

Online::GetIdentityInterface ( const FName SubsystemName
)

 Get the interface for accessing identity online services
Public function Static IOnlineIdentityPtr

Online::GetIdentityInterfaceChecked ( const FName SubsystemName
)

  
Public function Static IOnlineLeaderboardsPtr

Online::GetLeaderboardsInterface ( const FName SubsystemName
)

 Get the interface for accessing platform leaderboards
Public function Static IOnlineLeaderboardsPtr  
Public function Static IOnlinePartyPtr

Online::GetPartyInterface ( const FName SubsystemName
)

 Get the interface for accessing the party services
Public function Static IOnlinePartyPtr

Online::GetPartyInterfaceChecked ( const FName SubsystemName
)

  
Public function Static IOnlinePresencePtr

Online::GetPresenceInterface ( const FName SubsystemName
)

 Get the interface for accessing rich presence online services
Public function Static IOnlinePresencePtr

Online::GetPresenceInterfaceChecked ( const FName SubsystemName
)

  
Public function Static IOnlinePurchasePtr

Online::GetPurchaseInterface ( const FName SubsystemName
)

 Get the interface for accessing the purchasing services
Public function Static IOnlinePurchasePtr

Online::GetPurchaseInterfaceChecked ( const FName SubsystemName
)

  
Public function Static IOnlineSessionPtr

Online::GetSessionInterface ( const FName SubsystemName
)

 Get the interface for accessing the session services
Public function Static IOnlineSessionPtr

Online::GetSessionInterfaceChecked ( const FName SubsystemName
)

  
Public function Static IOnlineSharedCloudPtr

Online::GetSharedCloudInterface ( const FName SubsystemName
)

 Get the interface for sharing user files in the cloud
Public function Static IOnlineSharedCloudPtr  
Public function Static IOnlineStatsPtr

Online::GetStatsInterface ( const FName SubsystemName
)

 Get the interface for accessing the stats services
Public function Static IOnlineStatsPtr

Online::GetStatsInterfaceChecked ( const FName SubsystemName
)

  
Public function Static IOnlineTimePtr

Online::GetTimeInterface ( const FName SubsystemName
)

 Get the interface for accessing the server time from an online service
Public function Static IOnlineTimePtr

Online::GetTimeInterfaceChecked ( const FName SubsystemName
)

  
Public function Static IOnlineTitleFilePtr

Online::GetTitleFileInterface ( const FName SubsystemName
)

 Get the interface for accessing title file online services
Public function Static IOnlineTitleFilePtr  
Public function Static IOnlineUserCloudPtr

Online::GetUserCloudInterface ( const FName SubsystemName
)

 Get the interface for accessing user files in the cloud
Public function Static IOnlineUserCloudPtr  
Public function Static IOnlineUserPtr

Online::GetUserInterface ( const FName SubsystemName
)

 Get the interface for accessing user information by uniqueid
Public function Static IOnlineUserPtr

Online::GetUserInterfaceChecked ( const FName SubsystemName
)

  
Public function Static IOnlineVoicePtr

Online::GetVoiceInterface ( const FName SubsystemName
)

 Get the interface for accessing voice services
Public function Static IOnlineVoicePtr

Online::GetVoiceInterfaceChecked ( const FName SubsystemName
)

  
Public function FOnlineError  
Public function const TCHAR * Configured namspace.
Public function FOnlineError  
Public function FOnlineError  
Public function FOnlineError Input validation.
Public function FOnlineError System failures.
Public function FOnlineError  
Public function FOnlineError Configuration.
Public function FOnlineError Response failures.
Public function FOnlineError Failures.
Public function FOnlineError  
Public function FOnlineError  
Public function const TCHAR * Configured namspace.
Public function FOnlineError  
Public function FOnlineError  
Public function FOnlineError  
Public function FOnlineError  
Public function FOnlineError  
Public function FOnlineError Input validation.
Public function FOnlineError  
Public function FOnlineError System failures.
Public function FOnlineError  
Public function FOnlineError Configuration.
Public function FOnlineError Response failures.
Public function FOnlineError  
Public function FOnlineError  
Public function FOnlineError Failures.
Public function FOnlineError  
Public function FOnlineError  
Public function FOnlineError  
Public function const TCHAR * Configured namspace.
Public function FOnlineError  
Public function FOnlineError  
Public function FOnlineError Input validation.
Public function FOnlineError System failures.
Public function FOnlineError  
Public function FOnlineError Configuration.
Public function FOnlineError Response failures.
Public function FOnlineError Failures.
Public function FOnlineError  
Public function FOnlineError  
Public function const TCHAR * Configured namspace.
Public function FOnlineError  
Public function FOnlineError  
Public function FOnlineError Input validation.
Public function FOnlineError System failures.
Public function FOnlineError  
Public function FOnlineError Configuration.
Public function FOnlineError Response failures.
Public function FOnlineError Failures.
Public function FOnlineError  
Public function bool  
Public function EOnlineSharingCategory  
Public function EOnlineSharingCategory &  
Public function EOnlineSharingCategory  
Public function EOnlineSharingCategory &  
Public function EOnlineSharingCategory  
Public function EOnlineSharingCategory &  
Public function EOnlineSharingCategory  
Public function void

ParseOnlineSubsystemConfigPairs ( TArrayView< const FString > InEntries,
TArray< TPair< FString, FString > >& OutPairs
)

 Parse an array of strings in the format (Key=Value) into an array of pairs of those keys and values
Public function const TCHAR *

ToString ( EOnlineSharingCategory CategoryType
)

  
Public function const TCHAR *  

Variables

  Type Name Description
Public variable const FName AMAZON_SUBSYSTEM  
Public variable const FName APPLE_SUBSYSTEM  
Public variable const FName EOS_SUBSYSTEM  
Public variable const FName FACEBOOK_SUBSYSTEM  
Public variable const FName GAMECIRCLE_SUBSYSTEM  
Public variable const FName GDK_SUBSYSTEM  
Public variable const FName GOOGLE_SUBSYSTEM  
Public variable const FName GOOGLEPLAY_SUBSYSTEM  
Public variable const FName IOS_SUBSYSTEM  
Public variable const FName MCP_SUBSYSTEM  
Public variable const FName NULL_SUBSYSTEM  
Public variable const FName PS4_SUBSYSTEM  
Public variable const FName PS4SERVER_SUBSYSTEM  
Public variable const FName PS5_SUBSYSTEM  
Public variable const FName SAMSUNG_SUBSYSTEM  
Public variable   STATCAT_Advanced Online subsystem stats
Public variable const FName STEAM_SUBSYSTEM  
Public variable const FName SWITCH_SUBSYSTEM  
Public variable const FName TENCENT_SUBSYSTEM  
Public variable const FName THUNDERHEAD_SUBSYSTEM  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page