UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::Online::TOnlineId< IdType > Class Template Reference

#include <CoreOnline.h>

Public Member Functions

 TOnlineId ()=default
 
 TOnlineId (EOnlineServices Type, uint32 Handle)
 
bool IsValid () const
 
 operator bool () const
 
EOnlineServices GetOnlineServicesType () const
 
uint32 GetHandle () const
 
bool operator== (const TOnlineId &Other) const
 
bool operator!= (const TOnlineId &Other) const
 

Detailed Description

template<typename IdType>
class UE::Online::TOnlineId< IdType >

A handle to an id which uniquely identifies a persistent or transient online resource, i.e. account/session/party etc, within a given Online Services provider. At most one id, and therefore one handle, exists for any given resource. The id and handle persist until the OnlineServices module is unloaded. Passed to and returned from OnlineServices APIs.

Constructor & Destructor Documentation

◆ TOnlineId() [1/2]

template<typename IdType >
UE::Online::TOnlineId< IdType >::TOnlineId ( )
default

◆ TOnlineId() [2/2]

template<typename IdType >
UE::Online::TOnlineId< IdType >::TOnlineId ( EOnlineServices  Type,
uint32  Handle 
)
inline

Member Function Documentation

◆ GetHandle()

template<typename IdType >
uint32 UE::Online::TOnlineId< IdType >::GetHandle ( ) const
inline

◆ GetOnlineServicesType()

template<typename IdType >
EOnlineServices UE::Online::TOnlineId< IdType >::GetOnlineServicesType ( ) const
inline

◆ IsValid()

template<typename IdType >
bool UE::Online::TOnlineId< IdType >::IsValid ( ) const
inline

◆ operator bool()

template<typename IdType >
UE::Online::TOnlineId< IdType >::operator bool ( ) const
inlineexplicit

◆ operator!=()

template<typename IdType >
bool UE::Online::TOnlineId< IdType >::operator!= ( const TOnlineId< IdType > &  Other) const
inline

◆ operator==()

template<typename IdType >
bool UE::Online::TOnlineId< IdType >::operator== ( const TOnlineId< IdType > &  Other) const
inline

The documentation for this class was generated from the following file: