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

Light Theme

Dark Theme

OnlineSubsystem

Windows

MacOS

Linux

Filters

Classes

	Name	Description
	FCloudFile	Holds the data used in downloading a file asynchronously from the online service
	FCloudFileHeader	Holds metadata about a given downloadable file
	FColumnMetaData	Representation of a single column of data in a leaderboard
	FLanBeacon	Class responsible for sending/receiving UDP broadcasts for LAN match discovery
	FLANSession	Encapsulate functionality related to LAN broadcast data
	FNamedInterface	Named interfaces for Online SubsystemHolds a named object interface for dynamically bound interfaces
	FNamedInterfaceDef	Holds a name to class name mapping for adding the named interfaces automatically
	FNamedOnlineSession	Holds the per session information for named sessions
	FNboSerializeFromBuffer	Disable used without initialization warning because the reads are initializing.
	FNboSerializeToBuffer	Serializes data in network byte order form into a buffer
	FOnlineAchievementsWrite	The interface for writing achievement stats to the server.
	FOnlineAsyncEvent	An event triggered by the online subsystem to be routed to the game thread for processing Originates on the online thread
	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
	FOnlineAsyncTask	A single task for an online service to be queued with the async task manager Originates on the game thread
	FOnlineAsyncTaskBasic
	FOnlineAsyncTaskGenericCallable	An async task that can execute any callable type with no parameters.
	FOnlineAsyncTaskManager	The foundation of all async operations in every online subsystem
	FOnlineAsyncTaskThreadedGenericCallable	An async task that can execute any callable type with no parameters.
	FOnlineBlockedPlayer	Blocked user info returned via IOnlineFriends interface
	FOnlineError	Generic Error response for OSS calls
	FOnlineFriend	Friend user info returned via IOnlineFriends interface
	FOnlineFriendSettingsSourceData
	FOnlineKeyValuePairs	Associative container for key value pairs
	FOnlineLeaderboardRead	Interface for reading data from a leaderboard service
	FOnlineLeaderboardWrite	Interface for storing/writing data to a leaderboard
	FOnlineNotification	Notification object, used to send messages between systems
	FOnlineNotificationBinding	Struct to keep track of bindings
	FOnlineNotificationHandler	This class is a static manager used to track notification transports and map the delivered notifications to subscribed notification handlers
	FOnlineNotificationTransportManager	This class is a static manager used to track notification transports and map the delivered notifications to subscribed notification handlers
	FOnlinePagedResult	Info for a response with paged results
	FOnlinePartyId	Id of a party instance
	FOnlinePartyTypeId	Id of a party's type
	FOnlinePlayerScore	TODO ONLINE.
	FOnlineRecentPlayer	Recent player user info returned via IOnlineFriends interface
	FOnlineSearchSettings	Container for all parameters describing a single session search
	FOnlineSession	Basic session information serializable into a NamedSession or SearchResults
	FOnlineSessionInfo	Abstraction of a session's platform specific info The class is meant to be opaque (see IOnlinePlatformData)
	FOnlineSessionSearch	Encapsulation of a search for sessions request.
	FOnlineSessionSearchParam	One search parameter in an online session query contains a value and how this setting is compared
	FOnlineSessionSearchResult	Representation of a single search result from a FindSession() call
	FOnlineSessionSetting	One setting describing an online session contains a key, value and how this setting is advertised to others, if at all
	FOnlineSessionSettings	Container for all settings describing a single online session
	FOnlineStats	An interface used to collect and manage online stats
	FOnlineStatsRow	Representation of a single row in a retrieved leaderboard
	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
	FOnlineSubsystemImpl	FOnlineSubsystemImpl - common functionality to share across online platforms, not intended for direct use
	FOnlineSubsystemModule	Online subsystem module class Wraps the loading of an online subsystem by name and allows new services to register themselves for use
	FOnlineUser	Base for all online user info
	FPagedQuery	Paging info needed for a request that can return paged results
	FRegionInfo	Locale and country code
	FSharedContentHandle	Abstraction of a profile service shared file handle The class is meant to be opaque (see IOnlinePlatformData)
	FUniqueNetIdMatcher	TArray helper for IndexOfByPredicate() function
	FUniqueNetIdString	Unique net id wrapper for a string
	FUserOnlineAccount	User account information returned via IOnlineIdentity interface
	FVariantData	Container for storing data of variable type
	FVariantDataConverter	Helper class for converting from UStruct to FVariantData and back only very basic flat UStructs with POD types are supported
	IOnlineFactory	Interface for creating the actual online subsystem instance for a given platform all modules must implement this
	IOnlinePlatformData	Base class for anything meant to be opaque so that the data can be passed around without consideration for the data it contains.
	IOnlineSubsystem	OnlineSubsystem - Series of interfaces to support communicating with various web/platform layer services
	TOnlinePartyIdMapKeyFuncs
	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
LAN_BEACON_PACKET_VERSION
NAME_Unset	Placeholder "type" until we can make FUniqueNetIdString sufficiently abstract

Typedefs

Name	Description
FHandleOnlineNotificationSignature	Delegate type for handling a notification
FJsonSerializeableKeyValueMapVariant
FNextTickDelegate
FNotificationTransportId	Unique identifier for notification transports
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
FOnlineSubsystemModulePtr	Public references to the online subsystem module pointer should use this
FOnOnlineEnvironmentChanged	Delegate fired when the PSN environment changes
FOnOnlineEnvironmentChangedDelegate
FOnSearchingTimeout
FOnSearchingTimeoutDelegate
FOnValidQueryPacket	LAN Session Delegates.
FOnValidQueryPacketDelegate
FOnValidResponsePacket
FOnValidResponsePacketDelegate
FSearchParams	Type defining an array of search parameters accessible by key
FSessionSettings	Type defining an array of session settings accessible by key
FStatPropertyArray	Representation of a single stat value to post to the backend
FStatsColumnArray	Representation of a single column and its data
FUniqueNetIdStringPtr
FUniqueNetIdStringRef
IMessageSanitizerPtr
IOnlineAchievementsPtr
IOnlineChatPtr
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
IOnlineStorePtr
IOnlineStoreV2Ptr
IOnlineSubsystemPtr
IOnlineSubsystemPtr	Public references to the online subsystem pointer should use this
IOnlineTimePtr
IOnlineTitleFilePtr
IOnlineTournamentPtr
IOnlineTurnBasedPtr
IOnlineUserCloudPtr
IOnlineUserPtr
IOnlineVoicePtr
TOnlinePartyIdMap

Enums

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

Functions

	Name	Description
void	DumpNamedSession ( const FNamedOnlineSession* Nam... )	Logs session properties used from the session settings
void	DumpSession ( const FOnlineSession* Session )	Logs session properties used from the session settings
void	DumpSessionSettings ( const FOnlineSessionSettings* ... )	Logs session properties used from the session settings
const TCHAR ...	EFeaturePrivilegeLevel::ToString ( EFeaturePrivilegeLevel::Type EnumVa... )
const TCHAR ...	EInviteStatus::ToString ( EInviteStatus::Type EnumVal )
const TCHAR ...	ELanBeaconState::ToString ( ELanBeaconState::Type EnumVal )
const TCHAR ...	ELeaderboardFormat::ToString ( ELeaderboardFormat::Type EnumVal )
const TCHAR ...	ELeaderboardSort::ToString ( ELeaderboardSort::Type EnumVal )
const TCHAR ...	ELeaderboardUpdateMethod::ToString ( ELeaderboardUpdateMethod::Type Enum... )
const TCHAR ...	ELoginStatus::ToString ( ELoginStatus::Type EnumVal )
const TCHAR ...	EOnlineAsyncTaskState::ToString ( EOnlineAsyncTaskState::Type EnumVal )
const TCHAR ...	EOnlineCachedResult::ToString ( EOnlineCachedResult::Type EnumVal )
const TCHAR ...	EOnlineComparisonOp::ToString ( EOnlineComparisonOp::Type EnumVal )
const TCHAR ...	EOnlineDataAdvertisementType::ToString ( EOnlineDataAdvertisementType::Type ... )
const TCHAR ...	EOnlineEnvironment::ToString ( EOnlineEnvironment::Type Environmen... )
const TCHAR ...	EOnlineFriendState::ToString ( EOnlineFriendState::Type EnumVal )
EOnlineKeyVa...	EOnlineKeyValuePairDataType::FromString ( const FString& EnumStr )
const TCHAR ...	EOnlineKeyValuePairDataType::ToString ( EOnlineKeyValuePairDataType::Type E... )
const TCHAR ...	EOnlineServerConnectionStatus::ToString ( EOnlineServerConnectionStatus::Type... )
const TCHAR ...	EOnlineSessionState::ToString ( EOnlineSessionState::Type EnumVal )
FOnlineError	Errors::AccessDenied()
const TCHAR ...	Errors::BaseNamespace()	Configured namspace.
FOnlineError	Errors::InvalidParams()
FOnlineError	Errors::InvalidUser()	Input validation.
FOnlineError	Errors::MissingInterface()	System failures.
FOnlineError	Errors::MissingSubsystem()
FOnlineError	Errors::NotConfigured()	Configuration.
FOnlineError	Errors::ParseError()	Response failures.
FOnlineError	Errors::RequestFailure()	Failures.
FOnlineError	Errors::ResultsError()
void	GenerateNonce ( uint8* Nonce, uint32 Length )	Generates a random nonce (number used once) of the desired length
int32	GetBeaconPortFromSessionSettings ( const FOnlineSessionSettings& Sess... )	Retrieve the beacon port from the specified session settings
int32	GetBuildUniqueId()	Generates a unique number based off of the current engine package
FUniqueNetId...	GetFirstSignedInUser ( IOnlineIdentityPtr IdentityInt )	Temp solution for some hardcoded access to logged in user 0, please avoid using this
uint32	GetTypeHash ( const FOnlinePartyTypeId Id )
bool	IsPlayerInSessionImpl ( IOnlineSession* SessionInt, FName SessionName, const FUniqueNetId& UniqueId )	Common implementation for finding a player in a session
bool	IsUniqueIdLocal ( const FUniqueNetId& UniqueId )	Is the unique id local to this instance
bool	IsValid ( const FOnlinePartyTypeId Id )
IOnlineAchie...	Online::GetAchievementsInterface ( const FName SubsystemName )	Get the interface for accessing entitlements online services
IOnlineAchie...	Online::GetAchievementsInterfaceChecked ( const FName SubsystemName )
IOnlineChatP...	Online::GetChatInterface ( const FName SubsystemName )	Get the interface for accessing the chat services
IOnlineChatP...	Online::GetChatInterfaceChecked ( const FName SubsystemName )
IOnlineEntit...	Online::GetEntitlementsInterface ( const FName SubsystemName )	Get the interface for accessing entitlements online services
IOnlineEntit...	Online::GetEntitlementsInterfaceChecked ( const FName SubsystemName )
IOnlineEvent...	Online::GetEventsInterface ( const FName SubsystemName )	Get the interface for accessing online events
IOnlineEvent...	Online::GetEventsInterfaceChecked ( const FName SubsystemName )
IOnlineExter...	Online::GetExternalUIInterface ( const FName SubsystemName )	Get the interface for accessing the external UIs of a service
IOnlineExter...	Online::GetExternalUIInterfaceChecked ( const FName SubsystemName )
IOnlineFrien...	Online::GetFriendsInterface ( const FName SubsystemName )	Get the interface for accessing the player friends services
IOnlineFrien...	Online::GetFriendsInterfaceChecked ( const FName SubsystemName )
IOnlineIdent...	Online::GetIdentityInterface ( const FName SubsystemName )	Get the interface for accessing identity online services
IOnlineIdent...	Online::GetIdentityInterfaceChecked ( const FName SubsystemName )
IOnlineLeade...	Online::GetLeaderboardsInterface ( const FName SubsystemName )	Get the interface for accessing platform leaderboards
IOnlineLeade...	Online::GetLeaderboardsInterfaceChecked ( const FName SubsystemName )
IOnlineParty...	Online::GetPartyInterface ( const FName SubsystemName )	Get the interface for accessing the party services
IOnlineParty...	Online::GetPartyInterfaceChecked ( const FName SubsystemName )
IOnlinePrese...	Online::GetPresenceInterface ( const FName SubsystemName )	Get the interface for accessing rich presence online services
IOnlinePrese...	Online::GetPresenceInterfaceChecked ( const FName SubsystemName )
IOnlinePurch...	Online::GetPurchaseInterface ( const FName SubsystemName )	Get the interface for accessing the purchasing services
IOnlinePurch...	Online::GetPurchaseInterfaceChecked ( const FName SubsystemName )
IOnlineSessi...	Online::GetSessionInterface ( const FName SubsystemName )	Get the interface for accessing the session services
IOnlineSessi...	Online::GetSessionInterfaceChecked ( const FName SubsystemName )
IOnlineShare...	Online::GetSharedCloudInterface ( const FName SubsystemName )	Get the interface for sharing user files in the cloud
IOnlineShare...	Online::GetSharedCloudInterfaceChecked ( const FName SubsystemName )
IOnlineStats...	Online::GetStatsInterface ( const FName SubsystemName )	Get the interface for accessing the stats services
IOnlineStats...	Online::GetStatsInterfaceChecked ( const FName SubsystemName )
IOnlineTimeP...	Online::GetTimeInterface ( const FName SubsystemName )	Get the interface for accessing the server time from an online service
IOnlineTimeP...	Online::GetTimeInterfaceChecked ( const FName SubsystemName )
IOnlineTitle...	Online::GetTitleFileInterface ( const FName SubsystemName )	Get the interface for accessing title file online services
IOnlineTitle...	Online::GetTitleFileInterfaceChecked ( const FName SubsystemName )
IOnlineUserC...	Online::GetUserCloudInterface ( const FName SubsystemName )	Get the interface for accessing user files in the cloud
IOnlineUserC...	Online::GetUserCloudInterfaceChecked ( const FName SubsystemName )
IOnlineUserP...	Online::GetUserInterface ( const FName SubsystemName )	Get the interface for accessing user information by uniqueid
IOnlineUserP...	Online::GetUserInterfaceChecked ( const FName SubsystemName )
IOnlineVoice...	Online::GetVoiceInterface ( const FName SubsystemName )	Get the interface for accessing voice services
IOnlineVoice...	Online::GetVoiceInterfaceChecked ( const FName SubsystemName )
FOnlineError	OnlineFriend::Errors::AccessDenied()
const TCHAR ...	OnlineFriend::Errors::BaseNamespace()	Configured namspace.
FOnlineError	OnlineFriend::Errors::InvalidParams()
FOnlineError	OnlineFriend::Errors::InvalidResult()
FOnlineError	OnlineFriend::Errors::InvalidUser()	Input validation.
FOnlineError	OnlineFriend::Errors::MissingInterface()	System failures.
FOnlineError	OnlineFriend::Errors::MissingSubsystem()
FOnlineError	OnlineFriend::Errors::NotConfigured()	Configuration.
FOnlineError	OnlineFriend::Errors::ParseError()	Response failures.
FOnlineError	OnlineFriend::Errors::RequestFailure()	Failures.
FOnlineError	OnlineFriend::Errors::ResultsError()
FOnlineError	OnlineIdentity::Errors::AccessDenied()
const TCHAR ...	OnlineIdentity::Errors::BaseNamespace()	Configured namspace.
FOnlineError	OnlineIdentity::Errors::InvalidAuth()
FOnlineError	OnlineIdentity::Errors::InvalidCreds()
FOnlineError	OnlineIdentity::Errors::InvalidParams()
FOnlineError	OnlineIdentity::Errors::InvalidResult()
FOnlineError	OnlineIdentity::Errors::InvalidUser()	Input validation.
FOnlineError	OnlineIdentity::Errors::LoginPending()
FOnlineError	OnlineIdentity::Errors::MissingInterface()	System failures.
FOnlineError	OnlineIdentity::Errors::MissingSubsystem()
FOnlineError	OnlineIdentity::Errors::NotConfigured()	Configuration.
FOnlineError	OnlineIdentity::Errors::ParseError()	Response failures.
FOnlineError	OnlineIdentity::Errors::PinGrantFailure()
FOnlineError	OnlineIdentity::Errors::PinGrantTimeout()
FOnlineError	OnlineIdentity::Errors::RequestFailure()	Failures.
FOnlineError	OnlineIdentity::Errors::ResultsError()
FOnlineError	OnlineIdentity::Errors::UserNotFound()
FOnlineError	OnlinePresence::Errors::AccessDenied()
const TCHAR ...	OnlinePresence::Errors::BaseNamespace()	Configured namspace.
FOnlineError	OnlinePresence::Errors::InvalidParams()
FOnlineError	OnlinePresence::Errors::InvalidResult()
FOnlineError	OnlinePresence::Errors::InvalidUser()	Input validation.
FOnlineError	OnlinePresence::Errors::MissingInterface()	System failures.
FOnlineError	OnlinePresence::Errors::MissingSubsystem()
FOnlineError	OnlinePresence::Errors::NotConfigured()	Configuration.
FOnlineError	OnlinePresence::Errors::ParseError()	Response failures.
FOnlineError	OnlinePresence::Errors::RequestFailure()	Failures.
FOnlineError	OnlinePresence::Errors::ResultsError()
FOnlineError	OnlinePurchase::Errors::AccessDenied()
const TCHAR ...	OnlinePurchase::Errors::BaseNamespace()	Configured namspace.
FOnlineError	OnlinePurchase::Errors::InvalidParams()
FOnlineError	OnlinePurchase::Errors::InvalidResult()
FOnlineError	OnlinePurchase::Errors::InvalidUser()	Input validation.
FOnlineError	OnlinePurchase::Errors::MissingInterface()	System failures.
FOnlineError	OnlinePurchase::Errors::MissingSubsystem()
FOnlineError	OnlinePurchase::Errors::NotConfigured()	Configuration.
FOnlineError	OnlinePurchase::Errors::ParseError()	Response failures.
FOnlineError	OnlinePurchase::Errors::RequestFailure()	Failures.
FOnlineError	OnlinePurchase::Errors::ResultsError()
constexpr bo...	operator! ( EOnlineSharingCategory E )
constexpr EO...	operator& ( EOnlineSharingCategory Lhs, EOnlineSharingCategory Rhs )
EOnlineShari...	operator&= ( EOnlineSharingCategory& Lhs, EOnlineSharingCategory Rhs )
constexpr EO...	operator^ ( EOnlineSharingCategory Lhs, EOnlineSharingCategory Rhs )
EOnlineShari...	operator^= ( EOnlineSharingCategory& Lhs, EOnlineSharingCategory Rhs )
constexpr EO...	operator\| ( EOnlineSharingCategory Lhs, EOnlineSharingCategory Rhs )
EOnlineShari...	operator\|= ( EOnlineSharingCategory& Lhs, EOnlineSharingCategory Rhs )
constexpr EO...	operator~ ( EOnlineSharingCategory E )
void	ParseOnlineSubsystemConfigPairs ( TArrayView< const FString > InEntri..., TArray< TPair< FString, FString >> ... )	Parse an array of strings in the format (Key=Value) into an array of pairs of those keys and values
const TCHAR ...	ToString ( EOnlineSharingCategory CategoryType )
const TCHAR ...	ToString ( EOnlineStatusUpdatePrivacy PrivacyT... )

Variables

		Name	Description
		STATCAT_Advanced	Online subsystem stats

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

Take our survey

Dismiss