UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Protected Member Functions | List of all members
IPortalServiceLocator Class Referenceabstract

#include <IPortalServiceLocator.h>

+ Inheritance diagram for IPortalServiceLocator:

Public Member Functions

virtual void Configure (const FString &ServiceName, const FWildcardString &ProductId, const FName &ServiceModule)=0
 
template<typename ServiceType >
TSharedPtr< ServiceType > GetService (const FString &ProductId=TEXT(""))
 
template<typename ServiceType >
TSharedRef< ServiceType > GetServiceRef (const FString &ProductId=TEXT(""))
 
virtual ~IPortalServiceLocator ()
 

Protected Member Functions

virtual TSharedPtr< IPortalService > GetService (const FString &ServiceName, const FString &ProductId)=0
 

Constructor & Destructor Documentation

◆ ~IPortalServiceLocator()

virtual IPortalServiceLocator::~IPortalServiceLocator ( )
inlinevirtual

Virtual destructor.

Member Function Documentation

◆ Configure()

virtual void IPortalServiceLocator::Configure ( const FString &  ServiceName,
const FWildcardString &  ProductId,
const FName &  ServiceModule 
)
pure virtual

Configure a service.

The format of the ProductId is "ProductName_Major.Minor.Patch-Changelist+Branch". Use the '*` wild card to include multiple versions, i.e. "Fortnite_1.0.*+UE".

When looking up services, the first matching configuration entry will be used. If no entry matches, nullptr will be returned.

Parameters
ServiceNameThe name of the service type configure.
ProductNameThe product name that this configuration applies to.
ProductVersionThe version string of the product that this configuration applies to.
ServiceModuleThe name of the module that implements the service.

Implemented in FPortalServiceLocatorImpl.

◆ GetService() [1/2]

template<typename ServiceType >
TSharedPtr< ServiceType > IPortalServiceLocator::GetService ( const FString &  ProductId = TEXT(""))
inline

Get a service of the specified type.

Parameters
ServiceTypeThe type of service to get.
Returns
The service instance, or nullptr if unavailable.
See also
GetServiceRef

◆ GetService() [2/2]

virtual TSharedPtr< IPortalService > IPortalServiceLocator::GetService ( const FString &  ServiceName,
const FString &  ProductId 
)
protectedpure virtual

Get a service of the specified type.

Parameters
ServiceNameThe name of the service type to get.
Returns
The service instance, or nullptr if unavailable.

Implemented in FPortalServiceLocatorImpl.

◆ GetServiceRef()

template<typename ServiceType >
TSharedRef< ServiceType > IPortalServiceLocator::GetServiceRef ( const FString &  ProductId = TEXT(""))
inline

Get a service of the specified type.

Unlike GetService(), this method will assert if a service instance of the specified type does not exist.

Parameters
ServiceTypeThe type of service to get.
Returns
The service instance.
See also
GetService
The documentation for this class was generated from the following file: