UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::Online::FOnlineIdRegistryRegistry Class Reference

#include <CoreOnline.h>

Public Member Functions

COREONLINE_API void RegisterAccountIdRegistry (EOnlineServices OnlineServices, IOnlineAccountIdRegistry *Registry, int32 Priority=0)
 
COREONLINE_API void UnregisterAccountIdRegistry (EOnlineServices OnlineServices, int32 Priority=0)
 
COREONLINE_API FString ToString (const FAccountId &AccountId) const
 
COREONLINE_API FString ToLogString (const FAccountId &AccountId) const
 
COREONLINE_API TArray< uint8ToReplicationData (const FAccountId &AccountId) const
 
COREONLINE_API FAccountId ToAccountId (EOnlineServices Services, const TArray< uint8 > &RepData) const
 
COREONLINE_API FAccountId ToAccountId (EOnlineServices Services, const FString &StringData) const
 
COREONLINE_API IOnlineAccountIdRegistryGetAccountIdRegistry (EOnlineServices OnlineServices) const
 
COREONLINE_API void RegisterSessionIdRegistry (EOnlineServices OnlineServices, IOnlineSessionIdRegistry *Registry, int32 Priority=0)
 
COREONLINE_API void UnregisterSessionIdRegistry (EOnlineServices OnlineServices, int32 Priority=0)
 
COREONLINE_API FString ToString (const FOnlineSessionId &SessionId) const
 
COREONLINE_API FString ToLogString (const FOnlineSessionId &SessionId) const
 
COREONLINE_API TArray< uint8ToReplicationData (const FOnlineSessionId &SessionId) const
 
COREONLINE_API FOnlineSessionId ToSessionId (EOnlineServices Services, const TArray< uint8 > &RepData) const
 
COREONLINE_API IOnlineSessionIdRegistryGetSessionIdRegistry (EOnlineServices OnlineServices) const
 
COREONLINE_API void RegisterSessionInviteIdRegistry (EOnlineServices OnlineServices, IOnlineSessionInviteIdRegistry *Registry, int32 Priority=0)
 
COREONLINE_API void UnregisterSessionInviteIdRegistry (EOnlineServices OnlineServices, int32 Priority=0)
 
COREONLINE_API FString ToLogString (const FSessionInviteId &SessionInviteId) const
 
COREONLINE_API TArray< uint8ToReplicationData (const FSessionInviteId &SessionInviteId) const
 
COREONLINE_API FSessionInviteId ToSessionInviteId (EOnlineServices Services, const TArray< uint8 > &RepData) const
 
COREONLINE_API IOnlineSessionInviteIdRegistryGetSessionInviteIdRegistry (EOnlineServices OnlineServices) const
 

Static Public Member Functions

static COREONLINE_API FOnlineIdRegistryRegistryGet ()
 
static COREONLINE_API void TearDown ()
 

Member Function Documentation

◆ Get()

FOnlineIdRegistryRegistry & UE::Online::FOnlineIdRegistryRegistry::Get ( )
static

Get the FOnlineIdRegistryRegistry singleton

Returns
The FOnlineIdRegistryRegistry singleton instance

◆ GetAccountIdRegistry()

IOnlineAccountIdRegistry * UE::Online::FOnlineIdRegistryRegistry::GetAccountIdRegistry ( EOnlineServices  OnlineServices) const

◆ GetSessionIdRegistry()

IOnlineSessionIdRegistry * UE::Online::FOnlineIdRegistryRegistry::GetSessionIdRegistry ( EOnlineServices  OnlineServices) const

◆ GetSessionInviteIdRegistry()

IOnlineSessionInviteIdRegistry * UE::Online::FOnlineIdRegistryRegistry::GetSessionInviteIdRegistry ( EOnlineServices  OnlineServices) const

◆ RegisterAccountIdRegistry()

void UE::Online::FOnlineIdRegistryRegistry::RegisterAccountIdRegistry ( EOnlineServices  OnlineServices,
IOnlineAccountIdRegistry Registry,
int32  Priority = 0 
)

Register a registry for a given OnlineServices implementation and IOnlineAccountIdHandle type

Parameters
OnlineServicesServices that the registry is for
Registrythe registry of online account ids
PriorityInteger priority, allows an existing registry to be extended and registered with a higher priority so it is used instead

◆ RegisterSessionIdRegistry()

void UE::Online::FOnlineIdRegistryRegistry::RegisterSessionIdRegistry ( EOnlineServices  OnlineServices,
IOnlineSessionIdRegistry Registry,
int32  Priority = 0 
)

Register a registry for a given OnlineServices implementation and IOnlineSessionIdHandle type

Parameters
OnlineServicesServices that the registry is for
Registrythe registry of online session ids
PriorityInteger priority, allows an existing registry to be extended and registered with a higher priority so it is used instead

◆ RegisterSessionInviteIdRegistry()

void UE::Online::FOnlineIdRegistryRegistry::RegisterSessionInviteIdRegistry ( EOnlineServices  OnlineServices,
IOnlineSessionInviteIdRegistry Registry,
int32  Priority = 0 
)

Register a registry for a given OnlineServices implementation and IOnlineSessionInviteIdHandle type

Parameters
OnlineServicesServices that the registry is for
Registrythe registry of online session ids
PriorityInteger priority, allows an existing registry to be extended and registered with a higher priority so it is used instead

◆ TearDown()

void UE::Online::FOnlineIdRegistryRegistry::TearDown ( )
static

Tear down the singleton instance

◆ ToAccountId() [1/2]

FAccountId UE::Online::FOnlineIdRegistryRegistry::ToAccountId ( EOnlineServices  Services,
const FString &  StringData 
) const

◆ ToAccountId() [2/2]

FAccountId UE::Online::FOnlineIdRegistryRegistry::ToAccountId ( EOnlineServices  Services,
const TArray< uint8 > &  RepData 
) const

◆ ToLogString() [1/3]

FString UE::Online::FOnlineIdRegistryRegistry::ToLogString ( const FAccountId AccountId) const

◆ ToLogString() [2/3]

COREONLINE_API FString UE::Online::FOnlineIdRegistryRegistry::ToLogString ( const FOnlineSessionId SessionId) const

◆ ToLogString() [3/3]

COREONLINE_API FString UE::Online::FOnlineIdRegistryRegistry::ToLogString ( const FSessionInviteId SessionInviteId) const

◆ ToReplicationData() [1/3]

TArray< uint8 > UE::Online::FOnlineIdRegistryRegistry::ToReplicationData ( const FAccountId AccountId) const

◆ ToReplicationData() [2/3]

COREONLINE_API TArray< uint8 > UE::Online::FOnlineIdRegistryRegistry::ToReplicationData ( const FOnlineSessionId SessionId) const

◆ ToReplicationData() [3/3]

COREONLINE_API TArray< uint8 > UE::Online::FOnlineIdRegistryRegistry::ToReplicationData ( const FSessionInviteId SessionInviteId) const

◆ ToSessionId()

FOnlineSessionId UE::Online::FOnlineIdRegistryRegistry::ToSessionId ( EOnlineServices  Services,
const TArray< uint8 > &  RepData 
) const

◆ ToSessionInviteId()

FSessionInviteId UE::Online::FOnlineIdRegistryRegistry::ToSessionInviteId ( EOnlineServices  Services,
const TArray< uint8 > &  RepData 
) const

◆ ToString() [1/2]

FString UE::Online::FOnlineIdRegistryRegistry::ToString ( const FAccountId AccountId) const

◆ ToString() [2/2]

COREONLINE_API FString UE::Online::FOnlineIdRegistryRegistry::ToString ( const FOnlineSessionId SessionId) const

◆ UnregisterAccountIdRegistry()

void UE::Online::FOnlineIdRegistryRegistry::UnregisterAccountIdRegistry ( EOnlineServices  OnlineServices,
int32  Priority = 0 
)

Unregister a previously registered Account Id registry

Parameters
OnlineServicesServices that the registry is for
PriorityInteger priority, will be unregistered only if the priority matches the one that is registered

◆ UnregisterSessionIdRegistry()

void UE::Online::FOnlineIdRegistryRegistry::UnregisterSessionIdRegistry ( EOnlineServices  OnlineServices,
int32  Priority = 0 
)

Unregister a previously registered Session Id registry

Parameters
OnlineServicesServices that the registry is for
PriorityInteger priority, will be unregistered only if the priority matches the one that is registered

◆ UnregisterSessionInviteIdRegistry()

void UE::Online::FOnlineIdRegistryRegistry::UnregisterSessionInviteIdRegistry ( EOnlineServices  OnlineServices,
int32  Priority = 0 
)

Unregister a previously registered Session Invite Id registry

Parameters
OnlineServicesServices that the registry is for
PriorityInteger priority, will be unregistered only if the priority matches the one that is registered

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