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

#include <EncryptionKeyManager.h>

Public Member Functions

 FEncryptionKeyManager (const FEncryptionKeyManager &)=delete
 
 FEncryptionKeyManager (FEncryptionKeyManager &&)=delete
 
FEncryptionKeyManageroperator= (const FEncryptionKeyManager &)=delete
 
FEncryptionKeyManageroperator= (FEncryptionKeyManager &&)=delete
 
UE_API ~FEncryptionKeyManager ()
 
UE_API bool ContainsKey (const FGuid &Id) const
 
UE_API void AddKey (const FGuid &Id, const FAES::FAESKey &Key)
 
UE_API bool TryGetKey (const FGuid &Id, FAES::FAESKey &OutKey) const
 
UE_API TMap< FGuid, FAES::FAESKeyGetAllKeys () const
 
 DECLARE_MULTICAST_DELEGATE_TwoParams (FEncryptionKeyAddedDelegate, const FGuid &, const FAES::FAESKey &)
 
FEncryptionKeyAddedDelegateOnKeyAdded ()
 

Static Public Member Functions

static UE_API FEncryptionKeyManagerGet ()
 

Detailed Description

Manages a set of registered encryption key(s).

Constructor & Destructor Documentation

◆ FEncryptionKeyManager() [1/2]

UE::FEncryptionKeyManager::FEncryptionKeyManager ( const FEncryptionKeyManager )
delete

◆ FEncryptionKeyManager() [2/2]

UE::FEncryptionKeyManager::FEncryptionKeyManager ( FEncryptionKeyManager &&  )
delete

◆ ~FEncryptionKeyManager()

UE::FEncryptionKeyManager::~FEncryptionKeyManager ( )

Member Function Documentation

◆ AddKey()

void UE::FEncryptionKeyManager::AddKey ( const FGuid Id,
const FAES::FAESKey Key 
)

Add a new encryption key, ignored if the key already exist.

◆ ContainsKey()

bool UE::FEncryptionKeyManager::ContainsKey ( const FGuid Id) const

Returns whether the specified encrypton key exist or not.

◆ DECLARE_MULTICAST_DELEGATE_TwoParams()

UE::FEncryptionKeyManager::DECLARE_MULTICAST_DELEGATE_TwoParams ( FEncryptionKeyAddedDelegate  ,
const FGuid ,
const FAES::FAESKey  
)

◆ Get()

FEncryptionKeyManager & UE::FEncryptionKeyManager::Get ( )
static

Returns the single instance of the key manager.

◆ GetAllKeys()

TMap< FGuid, FAES::FAESKey > UE::FEncryptionKeyManager::GetAllKeys ( ) const

Returns a map of all available keys

◆ OnKeyAdded()

FEncryptionKeyAddedDelegate & UE::FEncryptionKeyManager::OnKeyAdded ( )
inline

Event triggered when a new key as been added.

◆ operator=() [1/2]

FEncryptionKeyManager & UE::FEncryptionKeyManager::operator= ( const FEncryptionKeyManager )
delete

◆ operator=() [2/2]

FEncryptionKeyManager & UE::FEncryptionKeyManager::operator= ( FEncryptionKeyManager &&  )
delete

◆ TryGetKey()

bool UE::FEncryptionKeyManager::TryGetKey ( const FGuid Id,
FAES::FAESKey OutKey 
) const

Try retrieve the encryption key for the specified key ID.


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