Loading...
Searching...
No Matches
AccelByte::FAccelBytePlatformHandler Class Reference

Public Member Functions

AccelBytePlatformWrapperWPtr GetPlatformWrapper (EAccelBytePlatformType PlatformType)
 Retrieve stored Platform Wrapper from a specified Native Platform.
bool SetPlatformWrapper (EAccelBytePlatformType PlatformType, AccelBytePlatformWrapperPtr const &WrapperPtr)
 Store Platform Wrapper for a specific Native Platform.
bool RemovePlatformWrapper (EAccelBytePlatformType PlatformType)
 Remove stored Platform Wrapper for a specific Native Platform.
FDelegateHandle AddPlatformPresenceChangedDelegate (FAccelBytePlatformPresenceChangedDelegate const &InPlatformPresenceChanged)
 Add delegate to listen at Presence changed notification on Native Platform.
void TriggerOnPlatformPresenceChangedDelegate (EAccelBytePlatformType PlatformType, FString const &PlatformUserId, EAvailability Availability)
 Trigger stored Presence changed delegate.
bool RemovePlatformPresenceChangedDelegate (FDelegateHandle DelegateHandle)
 Remove registered Platform Presence changed delegate.
void ClearPlatformPresenceChangedDelegates ()
 Clear all registered Platform Presence changed delegate.

Member Function Documentation

◆ AddPlatformPresenceChangedDelegate()

FDelegateHandle AccelByte::FAccelBytePlatformHandler::AddPlatformPresenceChangedDelegate ( FAccelBytePlatformPresenceChangedDelegate const & InPlatformPresenceChanged)

Add delegate to listen at Presence changed notification on Native Platform.

Parameters
InPlatformPresenceChangedPresence changed delegate.
Returns
DelegateHandle for given Presence changed delegate.

◆ GetPlatformWrapper()

AccelBytePlatformWrapperWPtr AccelByte::FAccelBytePlatformHandler::GetPlatformWrapper ( EAccelBytePlatformType PlatformType)

Retrieve stored Platform Wrapper from a specified Native Platform.

Parameters
PlatformTypeSpecified Native Platform Type.
Returns
WeakPtr to the Platform Wrapper object that was stored inside the Platform Handler.

◆ RemovePlatformPresenceChangedDelegate()

bool AccelByte::FAccelBytePlatformHandler::RemovePlatformPresenceChangedDelegate ( FDelegateHandle DelegateHandle)

Remove registered Platform Presence changed delegate.

Parameters
DelegateHandleDelegateHandle for given Presence changed delegate.
Returns
true if the removal is successful.

◆ RemovePlatformWrapper()

bool AccelByte::FAccelBytePlatformHandler::RemovePlatformWrapper ( EAccelBytePlatformType PlatformType)

Remove stored Platform Wrapper for a specific Native Platform.

Parameters
PlatformTypeSpecified Native Platform Type.

◆ SetPlatformWrapper()

bool AccelByte::FAccelBytePlatformHandler::SetPlatformWrapper ( EAccelBytePlatformType PlatformType,
AccelBytePlatformWrapperPtr const & WrapperPtr )

Store Platform Wrapper for a specific Native Platform.

Parameters
PlatformTypeSpecified Native Platform Type.
WrapperPtrSharedPtr to the Platform Wrapper object.
Returns
true if set platform wrapper successful.

◆ TriggerOnPlatformPresenceChangedDelegate()

void AccelByte::FAccelBytePlatformHandler::TriggerOnPlatformPresenceChangedDelegate ( EAccelBytePlatformType PlatformType,
FString const & PlatformUserId,
EAvailability Availability )

Trigger stored Presence changed delegate.

Parameters
PlatformTypeSpecified Native Platform Type.
PlatformUserIdSpecified User Id.
AvailabilityAvailability status changed of the given User Id.