UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
FBackgroundURLSessionHandler Class Reference

#include <IOSBackgroundURLSessionHandler.h>

Public Member Functions

 UE_DEPRECATED (5.5, "Use new API in FBackgroundURLSessionHandler.") static bool InitBackgroundSession(const FString &SessionIdentifier)
 
 UE_DEPRECATED (5.5, "Use new API in FBackgroundURLSessionHandler.") static void ShutdownBackgroundSession(bool bShouldFinishTasksFirst
 
 DECLARE_MULTICAST_DELEGATE_TwoParams (FOnDownloadCompleted, const uint64, const bool)
 
 DECLARE_MULTICAST_DELEGATE_ThreeParams (FOnDownloadMetrics, const uint64, const int32, const float) static FOnDownloadMetrics OnDownloadMetrics
 
 DECLARE_MULTICAST_DELEGATE_TwoParams (FOnDownloadMetricsExtended, const uint64, const FBackgroundHttpRequestMetricsExtended)
 
 DECLARE_MULTICAST_DELEGATE_OneParam (FOnDownloadsCompletedWhileAppWasNotRunning, const bool)
 

Static Public Member Functions

static void AllowCellular (bool bAllow)
 
static uint64 CreateOrFindDownload (const TArray< FString > &URLs, const float Priority, BackgroundHttpFileHashHelperRef HelperRef, const uint64 ExpectedResultSize=0)
 
static void PauseDownload (const uint64 DownloadId)
 
static void ResumeDownload (const uint64 DownloadId)
 
static void CancelDownload (const uint64 DownloadId)
 
static void SetPriority (const uint64 DownloadId, const float Priority)
 
static uint64 GetCurrentDownloadedBytes (const uint64 DownloadId)
 
static bool IsDownloadFinished (const uint64 DownloadId, int32 &OutResultHTTPCode, FString &OutTemporaryFilePath)
 
static void HandleEventsForBackgroundURLSession (const FString &SessionIdentifier)
 
static void HandleDidEnterBackground ()
 
static void HandleWillEnterForeground ()
 
static void SaveBackgroundHttpFileHashHelperState ()
 
static TArray< TTuple< FString, uint32, FString > > GetCDNAnalyticsData ()
 
static void GetDownloadDebugText (const uint64 DownloadId, TArray< FString > &Output)
 

Static Public Attributes

static const uint64 InvalidDownloadId = [FBackgroundNSURLSession GetInvalidDownloadId]
 
static FOnDownloadCompleted OnDownloadCompleted
 
static FOnDownloadMetricsExtended OnDownloadMetricsExtended
 
static FOnDownloadsCompletedWhileAppWasNotRunning OnDownloadsCompletedWhileAppWasNotRunning
 
static NSMutableDictionary< NSString *, void(^)()> * BackgroundSessionEventCompleteDelegateMap
 

Member Function Documentation

◆ AllowCellular()

static void FBackgroundURLSessionHandler::AllowCellular ( bool  bAllow)
static

◆ CancelDownload()

static void FBackgroundURLSessionHandler::CancelDownload ( const uint64  DownloadId)
static

◆ CreateOrFindDownload()

static uint64 FBackgroundURLSessionHandler::CreateOrFindDownload ( const TArray< FString > &  URLs,
const float  Priority,
BackgroundHttpFileHashHelperRef  HelperRef,
const uint64  ExpectedResultSize = 0 
)
static

◆ DECLARE_MULTICAST_DELEGATE_OneParam()

FBackgroundURLSessionHandler::DECLARE_MULTICAST_DELEGATE_OneParam ( FOnDownloadsCompletedWhileAppWasNotRunning  ,
const bool   
)

◆ DECLARE_MULTICAST_DELEGATE_ThreeParams()

FBackgroundURLSessionHandler::DECLARE_MULTICAST_DELEGATE_ThreeParams ( FOnDownloadMetrics  ,
const uint64  ,
const int32  ,
const float   
)

◆ DECLARE_MULTICAST_DELEGATE_TwoParams() [1/2]

FBackgroundURLSessionHandler::DECLARE_MULTICAST_DELEGATE_TwoParams ( FOnDownloadCompleted  ,
const uint64  ,
const bool   
)

◆ DECLARE_MULTICAST_DELEGATE_TwoParams() [2/2]

FBackgroundURLSessionHandler::DECLARE_MULTICAST_DELEGATE_TwoParams ( FOnDownloadMetricsExtended  ,
const uint64  ,
const FBackgroundHttpRequestMetricsExtended   
)

◆ GetCDNAnalyticsData()

static TArray< TTuple< FString, uint32, FString > > FBackgroundURLSessionHandler::GetCDNAnalyticsData ( )
static

◆ GetCurrentDownloadedBytes()

static uint64 FBackgroundURLSessionHandler::GetCurrentDownloadedBytes ( const uint64  DownloadId)
static

◆ GetDownloadDebugText()

static void FBackgroundURLSessionHandler::GetDownloadDebugText ( const uint64  DownloadId,
TArray< FString > &  Output 
)
static

◆ HandleDidEnterBackground()

static void FBackgroundURLSessionHandler::HandleDidEnterBackground ( )
static

◆ HandleEventsForBackgroundURLSession()

static void FBackgroundURLSessionHandler::HandleEventsForBackgroundURLSession ( const FString &  SessionIdentifier)
static

◆ HandleWillEnterForeground()

static void FBackgroundURLSessionHandler::HandleWillEnterForeground ( )
static

◆ IsDownloadFinished()

static bool FBackgroundURLSessionHandler::IsDownloadFinished ( const uint64  DownloadId,
int32 &  OutResultHTTPCode,
FString &  OutTemporaryFilePath 
)
static

◆ PauseDownload()

static void FBackgroundURLSessionHandler::PauseDownload ( const uint64  DownloadId)
static

◆ ResumeDownload()

static void FBackgroundURLSessionHandler::ResumeDownload ( const uint64  DownloadId)
static

◆ SaveBackgroundHttpFileHashHelperState()

static void FBackgroundURLSessionHandler::SaveBackgroundHttpFileHashHelperState ( )
static

◆ SetPriority()

static void FBackgroundURLSessionHandler::SetPriority ( const uint64  DownloadId,
const float  Priority 
)
static

◆ UE_DEPRECATED() [1/2]

FBackgroundURLSessionHandler::UE_DEPRECATED ( 5.  5,
"Use new API in FBackgroundURLSessionHandler."   
) const &
inline

◆ UE_DEPRECATED() [2/2]

FBackgroundURLSessionHandler::UE_DEPRECATED ( 5.  5,
"Use new API in FBackgroundURLSessionHandler."   
)

Member Data Documentation

◆ BackgroundSessionEventCompleteDelegateMap

NSMutableDictionary<NSString*,void(^)()>* FBackgroundURLSessionHandler::BackgroundSessionEventCompleteDelegateMap
static

◆ InvalidDownloadId

const uint64 FBackgroundURLSessionHandler::InvalidDownloadId = [FBackgroundNSURLSession GetInvalidDownloadId]
static

◆ OnDownloadCompleted

FBackgroundURLSessionHandler::FOnDownloadCompleted FBackgroundURLSessionHandler::OnDownloadCompleted
static

◆ OnDownloadMetricsExtended

FBackgroundURLSessionHandler::FOnDownloadMetricsExtended FBackgroundURLSessionHandler::OnDownloadMetricsExtended
static

◆ OnDownloadsCompletedWhileAppWasNotRunning

FBackgroundURLSessionHandler::FOnDownloadsCompletedWhileAppWasNotRunning FBackgroundURLSessionHandler::OnDownloadsCompletedWhileAppWasNotRunning
static
The documentation for this class was generated from the following files: