OnlineSubsystem

Filters

Classes

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

FLanBeacon

Class responsible for sending/receiving UDP broadcasts for LAN match discovery

Public class

FLANSession

Encapsulate functionality related to LAN broadcast data

Public struct UStruct

FNamedInterface

Named interfaces for Online SubsystemHolds 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

FNboSerializeFromBuffer

Disable used without initialization warning because the reads are initializing.

Public class

FNboSerializeToBuffer

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

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

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

TODO ONLINE Settings to consider The server's nonce for this session Whether the game is an invitation or searched for game The ping of the server in milliseconds (-1 means the server was unreachable) Whether this server is a dedicated server or not Represents how good a match this is in a range from 0 to 1 Whether there is a skill update in progress or not (don't do multiple at once) Whether to shrink the session slots when a player leaves the match or not 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

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 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 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

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

FOnlineNotificationTransportManagerPtr

FOnlineNotificationTransportManagerPtr

FOnlineSubsystemModulePtr

Public references to the online subsystem module pointer should use this

FOnOnlineEnvironmentChanged

Delegate fired when the PSN environment changes

FOnOnlineEnvironmentChangedDelegate

FOnPlayTogetherEventReceived

Delegate fired when the "Play Together" event is sent from the PS4 system

FOnPlayTogetherEventReceivedDelegate

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

IMessageSanitizerPtr

IOnlineAchievementsPtr

IOnlineChatPtr

IOnlineEntitlementsPtr

IOnlineEventsPtr

IOnlineExternalUIPtr

IOnlineFriendsPtr

IOnlineGroupsPtr

IOnlineIdentityPtr

IOnlineLeaderboardsPtr

IOnlineMessagePtr

IOnlineNotificationTransportPtr

Forward declare

IOnlinePartyPtr

IOnlinePresencePtr

IOnlinePurchasePtr

IOnlineSessionPtr

Forward declarations of all interface classes

IOnlineSharedCloudPtr

IOnlineSharingPtr

IOnlineStorePtr

IOnlineStoreV2Ptr

IOnlineSubsystemPtr

IOnlineSubsystemPtr

Public references to the online subsystem pointer should use this

IOnlineTimePtr

IOnlineTitleFilePtr

IOnlineTurnBasedPtr

IOnlineUserCloudPtr

IOnlineUserPtr

IOnlineVoicePtr

Enums

Name

Description

Public enum

EFeaturePrivilegeLevel::Type

Possible feature privilege access levels

Public enum

EInviteStatus::Type

Friend list invite states

Public enum

ELanBeaconState::Type

Enum indicating the state the LAN beacon is in

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

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

Name Description

Public function

void [ONLINES](API\Plugins\OnlineSubsystem\Interfaces\ONLINESUBSYSTEM_API)...

 

DumpNamedSession

(
    const FNamedOnlineSession * Nam...
)

Logs session properties used from the session settings

Public function

void [ONLINES](API\Plugins\OnlineSubsystem\Interfaces\ONLINESUBSYSTEM_API)...

 

DumpSession

(
    const FOnlineSession * Session
)

Logs session properties used from the session settings

Public function

void [ONLINES](API\Plugins\OnlineSubsystem\Interfaces\ONLINESUBSYSTEM_API)...

 

DumpSessionSettings

(
    const FOnlineSessionSettings * ...
)

Logs session properties used from the session settings

Public function

const TCHAR ...

 

EFeaturePrivilegeLevel::ToString

(
    EFeaturePrivilegeLevel::Type EnumVa...
)

The stringified version of the enum passed in

Public function

const TCHAR ...

 

EInviteStatus::ToString

(
    EInviteStatus::Type EnumVal
)

The stringified version of the enum passed in

Public function

const TCHAR ...

 

ELanBeaconState::ToString

(
    ELanBeaconState::Type EnumVal
)

The stringified version of the enum passed in

Public function

const TCHAR ...

 

ELeaderboardFormat::ToString

(
    ELeaderboardFormat::Type EnumVal
)

The stringified version of the enum passed in

Public function

const TCHAR ...

 

ELeaderboardSort::ToString

(
    ELeaderboardSort::Type EnumVal
)

The stringified version of the enum passed in

Public function

const TCHAR ...

 

ELeaderboardUpdateMethod::ToString

(
    ELeaderboardUpdateMethod::Type Enum...
)

The stringified version of the enum passed in

Public function

const TCHAR ...

 

ELoginStatus::ToString

(
    ELoginStatus::Type EnumVal
)

The stringified version of the enum passed in

Public function

const TCHAR ...

 

EOnlineAsyncTaskState::ToString

(
    EOnlineAsyncTaskState::Type EnumVal
)

The stringified version of the enum passed in

Public function

const TCHAR ...

 

EOnlineCachedResult::ToString

(
    EOnlineCachedResult::Type EnumVal
)

The stringified version of the enum passed in

Public function

const TCHAR ...

 

EOnlineComparisonOp::ToString

(
    EOnlineComparisonOp::Type EnumVal
)

The stringified version of the enum passed in

Public function

const TCHAR ...

 

EOnlineDataAdvertisementType::ToString

The stringified version of the enum passed in

Public function

const TCHAR ...

 

EOnlineEnvironment::ToString

(
    EOnlineEnvironment::Type Environmen...
)

The stringified version of the enum passed in

Public function

const TCHAR ...

 

EOnlineFriendState::ToString

(
    EOnlineFriendState::Type EnumVal
)

The stringified version of the enum passed in

Public function

const TCHAR ...

 

EOnlineKeyValuePairDataType::ToString

The stringified version of the enum passed in

Public function

const TCHAR ...

 

EOnlineServerConnectionStatus::ToString

The stringified version of the enum passed in

Public function

const TCHAR ...

 

EOnlineSessionState::ToString

(
    EOnlineSessionState::Type EnumVal
)

The stringified version of the enum passed in

Public function

void

 

GenerateNonce

(
    uint8 * Nonce,
    uint32 Length
)

Generates a random nonce (number used once) of the desired length

Public function

[ONLINESUBSYS](API\Plugins\OnlineSubsystem\Interfaces\ONLINESUBSYSTEM_API)...

 

GetBeaconPortFromSessionSettings

(
    const FOnlineSessionSettings & Sess...
)

Retrieve the beacon port from the specified session settings

Public function

[ONLINESUBSYS](API\Plugins\OnlineSubsystem\Interfaces\ONLINESUBSYSTEM_API)...

 

GetBuildUniqueId()

Generates a unique number based off of the current engine package

Public function

uint32

 

GetTypeHash

(
    const FOnlinePartyTypeId Id
)

Public function

[ONLINESUBSYS](API\Plugins\OnlineSubsystem\Interfaces\ONLINESUBSYSTEM_API)...

 

IsPlayerInSessionImpl

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

Common implementation for finding a player in a session

Public function

bool

 

IsValid

(
    const FOnlinePartyTypeId Id
)

Public function Static

IOnlineAchie ...

 

Online::GetAchievementsInterface

(
    const FName SubsystemName
)

Get the interface for accessing entitlements online services

Public function Static

IOnlineChatP ...

 

Online::GetChatInterface

(
    const FName SubsystemName
)

Get the interface for accessing the chat services

Public function Static

IOnlineEntit ...

 

Online::GetEntitlementsInterface

(
    const FName SubsystemName
)

Get the interface for accessing entitlements online services

Public function Static

IOnlineEvent ...

 

Online::GetEventsInterface

(
    const FName SubsystemName
)

Get the interface for accessing online events

Interface pointer for the appropriate service

Public function Static

IOnlineExter ...

 

Online::GetExternalUIInterface

(
    const FName SubsystemName
)

Get the interface for accessing the external UIs of a service

Public function Static

IOnlineFrien ...

 

Online::GetFriendsInterface

(
    const FName SubsystemName
)

Get the interface for accessing the player friends services

Public function Static

IOnlineIdent ...

 

Online::GetIdentityInterface

(
    const FName SubsystemName
)

Get the interface for accessing identity online services

Public function Static

IOnlineLeade ...

 

Online::GetLeaderboardsInterface

(
    const FName SubsystemName
)

Get the interface for accessing platform leaderboards

Public function Static

IOnlineParty ...

 

Online::GetPartyInterface

(
    const FName SubsystemName
)

Get the interface for accessing the party services

Public function Static

IOnlinePrese ...

 

Online::GetPresenceInterface

(
    const FName SubsystemName
)

Get the interface for accessing rich presence online services

Public function Static

IOnlineSessi ...

 

Online::GetSessionInterface

(
    const FName SubsystemName
)

Get the interface for accessing the session services

Public function Static

IOnlineShare ...

 

Online::GetSharedCloudInterface

(
    const FName SubsystemName
)

Get the interface for sharing user files in the cloud

Public function Static

IOnlineTimeP ...

 

Online::GetTimeInterface

(
    const FName SubsystemName
)

Get the interface for accessing the server time from an online service

Public function Static

IOnlineTitle ...

 

Online::GetTitleFileInterface

(
    const FName SubsystemName
)

Get the interface for accessing title file online services

Public function Static

IOnlineUserC ...

 

Online::GetUserCloudInterface

(
    const FName SubsystemName
)

Get the interface for accessing user files in the cloud

Public function Static

IOnlineUserP ...

 

Online::GetUserInterface

(
    const FName SubsystemName
)

Get the interface for accessing user information by uniqueid

Public function Static

IOnlineVoice ...

 

Online::GetVoiceInterface

(
    const FName SubsystemName
)

Get the interface for accessing voice services

Public function

constexpr bo...

 

operator!

Public function

constexpr EO ...

 

operator&

Public function

EOnlineShari ...

 

operator&=

(
    EOnlineSharingCategory & Lhs,
    EOnlineSharingCategory Rhs
)

Public function

constexpr EO ...

 

operator^

Public function

EOnlineShari ...

 

operator^=

(
    EOnlineSharingCategory & Lhs,
    EOnlineSharingCategory Rhs
)

Public function

constexpr EO ...

 

operator|

Public function

EOnlineShari ...

 

operator|=

(
    EOnlineSharingCategory & Lhs,
    EOnlineSharingCategory Rhs
)

Public function

constexpr EO ...

 

operator~

Public function

const TCHAR ...

 

ToString

(
    EOnlineSharingCategory CategoryType
)

Public function

const TCHAR ...

 

ToString

(
    EOnlineStatusUpdatePrivacy PrivacyT...
)

Variables

Name Description

Public variable

 

ONLINESUBSYSTEM_API

Public variable

 

STATCAT_Advanced

Online subsystem stats