UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Instance Methods | Class Methods | Properties | List of all members
FBackgroundNSURLSession Class Reference
+ Inheritance diagram for FBackgroundNSURLSession:

Instance Methods

(void) - Initialize
 
(void) - SetFileHashHelper:
 
(BackgroundHttpFileHashHelperRef) - GetFileHashHelper
 
(void) - SaveFileHashHelperState
 
(NSString *) - GetTempPathForURL:
 
(NSMutableArray< __kindof NSURL * > *) - ReorderCDNsByReachability:
 
(NSArray< __kindof FBackgroundNSURLCDNInfo * > *) - GetCDNInfo
 
(NSURLSessionDownloadTask *) - CreateDownloadForURL:WithPriority:WithTaskData:
 
(NSURLSessionDownloadTask *) - CreateDownloadForResumeData:WithPriority:WithTaskData:
 
(NSUInteger) - CreateOrFindDownloadForURLs:WithPriority:WithExpectedResultSize:
 
(void) - PauseDownload:
 
(void) - ResumeDownload:
 
(void) - CancelDownload:
 
(void) - SetPriority:ForDownload:
 
(void) - SetCurrentDownloadedBytes:ForTask:
 
(uint64) - GetCurrentDownloadedBytes:
 
(void) - RecreateDownload:ShouldResetRetryCount:
 
(void) - RecreateDownloads
 
(NSString *) - GetDownloadDebugText:
 
(void) - StartCheckingForStaleDownloads
 
(void) - StopCheckingForStaleDownloads
 
(void) - CheckForStaleDownloads:
 
(void) - HandleDidEnterBackground
 
(void) - HandleWillEnterForeground
 
(NSURLSessionDownloadTask *) - FindDownloadTaskFor:
 
(NSUInteger) - FindDownloadIdForTask:
 
(NSUInteger) - EnsureTaskIsTracked:
 
(void) - ReplaceTrackedTaskWith:ForDownloadId:
 
(void) - EnsureTaskIsNotTracked:
 
(void) - SetDownloadResult:WithTempFile:ForDownload:
 
(NSString *_Nullable) - GetDownloadResult:OutStatus:OutStatusCode:
 
(void) - URLSessionDidFinishEventsForBackgroundURLSession:
 
(void) - URLSession:task:didCompleteWithError:
 
(void) - URLSession:downloadTask:didFinishDownloadingToURL:
 
(void) - URLSession:downloadTask:didWriteData:totalBytesWritten:totalBytesExpectedToWrite:
 

Class Methods

(FBackgroundNSURLSession *) + Shared
 
(NSUInteger) + GetInvalidDownloadId
 
(NSString *) + GetNSURLSessionIdentifier
 

Properties

BOOL AllowCellular
 

Method Documentation

◆ CancelDownload:

- (void) CancelDownload: (NSUInteger)  DownloadId

◆ CheckForStaleDownloads:

- (void) CheckForStaleDownloads: (NSTimer*)  Timer

◆ CreateDownloadForResumeData:WithPriority:WithTaskData:

- (NSURLSessionDownloadTask *) CreateDownloadForResumeData: (NSData* _Nonnull)  ResumeData
WithPriority: (float)  Priority
WithTaskData: (FBackgroundNSURLSessionDownloadTaskData* _Nonnull)  TaskData 

◆ CreateDownloadForURL:WithPriority:WithTaskData:

- (NSURLSessionDownloadTask *) CreateDownloadForURL: (NSURL* _Nonnull)  URL
WithPriority: (float)  Priority
WithTaskData: (FBackgroundNSURLSessionDownloadTaskData* _Nonnull)  TaskData 

◆ CreateOrFindDownloadForURLs:WithPriority:WithExpectedResultSize:

- (NSUInteger) CreateOrFindDownloadForURLs: (NSArray<__kindof NSString*>*)  URLStrings
WithPriority: (float)  Priority
WithExpectedResultSize: (uint64)  ExpectedResultSize 

◆ EnsureTaskIsNotTracked:

- (void) EnsureTaskIsNotTracked: (NSURLSessionDownloadTask*)  Task

◆ EnsureTaskIsTracked:

- (NSUInteger) EnsureTaskIsTracked: (NSURLSessionDownloadTask*)  Task

◆ FindDownloadIdForTask:

- (NSUInteger) FindDownloadIdForTask: (NSURLSessionDownloadTask*)  Task

◆ FindDownloadTaskFor:

- (NSURLSessionDownloadTask *) FindDownloadTaskFor: (NSUInteger)  DownloadId

◆ GetCDNInfo

- (NSArray< __kindof FBackgroundNSURLCDNInfo * > *) GetCDNInfo

◆ GetCurrentDownloadedBytes:

- (uint64) GetCurrentDownloadedBytes: (NSUInteger)  DownloadId

◆ GetDownloadDebugText:

- (NSString *) GetDownloadDebugText: (NSUInteger)  DownloadId

◆ GetDownloadResult:OutStatus:OutStatusCode:

- (NSString *_Nullable) GetDownloadResult: (NSUInteger)  DownloadId
OutStatus: (BOOL* _Nonnull)  OutStatus
OutStatusCode: (NSInteger*)  OutStatusCode 

◆ GetFileHashHelper

- (BackgroundHttpFileHashHelperRef) GetFileHashHelper

◆ GetInvalidDownloadId

+ (NSUInteger) GetInvalidDownloadId

◆ GetNSURLSessionIdentifier

+ (NSString *) GetNSURLSessionIdentifier

◆ GetTempPathForURL:

- (NSString *) GetTempPathForURL: (NSURL* _Nonnull)  URL

◆ HandleDidEnterBackground

- (void) HandleDidEnterBackground

◆ HandleWillEnterForeground

- (void) HandleWillEnterForeground

◆ Initialize

- (void) Initialize

◆ PauseDownload:

- (void) PauseDownload: (NSUInteger)  DownloadId

◆ RecreateDownload:ShouldResetRetryCount:

- (void) RecreateDownload: (NSUInteger)  DownloadId
ShouldResetRetryCount: (bool)  ResetRetryCount 

◆ RecreateDownloads

- (void) RecreateDownloads

◆ ReorderCDNsByReachability:

- (NSMutableArray< __kindof NSURL * > *) ReorderCDNsByReachability: (NSMutableArray<__kindof NSURL*>*)  URLs

◆ ReplaceTrackedTaskWith:ForDownloadId:

- (void) ReplaceTrackedTaskWith: (NSURLSessionDownloadTask*)  NewTask
ForDownloadId: (NSUInteger)  DownloadId 

◆ ResumeDownload:

- (void) ResumeDownload: (NSUInteger)  DownloadId

◆ SaveFileHashHelperState

- (void) SaveFileHashHelperState

◆ SetCurrentDownloadedBytes:ForTask:

- (void) SetCurrentDownloadedBytes: (uint64)  DownloadedBytes
ForTask: (NSURLSessionDownloadTask*)  Task 

◆ SetDownloadResult:WithTempFile:ForDownload:

- (void) SetDownloadResult: (NSInteger)  HTTPCode
WithTempFile: (NSString*)  TempFile
ForDownload: (NSURLSessionDownloadTask*)  Task 

◆ SetFileHashHelper:

- (void) SetFileHashHelper: (BackgroundHttpFileHashHelperRef)  HelperRef

◆ SetPriority:ForDownload:

- (void) SetPriority: (float)  Priority
ForDownload: (NSUInteger)  DownloadId 

◆ Shared

+ (FBackgroundNSURLSession *) Shared

◆ StartCheckingForStaleDownloads

- (void) StartCheckingForStaleDownloads

◆ StopCheckingForStaleDownloads

- (void) StopCheckingForStaleDownloads

◆ URLSession:downloadTask:didFinishDownloadingToURL:

- (void) URLSession: (NSURLSession*)  Session
downloadTask: (NSURLSessionDownloadTask*)  Task
didFinishDownloadingToURL: (NSURL*)  Location 

◆ URLSession:downloadTask:didWriteData:totalBytesWritten:totalBytesExpectedToWrite:

- (void) URLSession: (NSURLSession*)  Session
downloadTask: (NSURLSessionDownloadTask*)  Task
didWriteData: (int64_t)  BytesWritten
totalBytesWritten: (int64_t)  TotalBytesWritten
totalBytesExpectedToWrite: (int64_t)  TotalBytesExpectedToWrite 

◆ URLSession:task:didCompleteWithError:

- (void) URLSession: (NSURLSession*)  Session
task: (NSURLSessionTask*)  Task
didCompleteWithError: (NSError*)  Error 

◆ URLSessionDidFinishEventsForBackgroundURLSession:

- (void) URLSessionDidFinishEventsForBackgroundURLSession: (NSURLSession*)  Session

Property Documentation

◆ AllowCellular

- (BOOL) AllowCellular
readwriteatomicassign
The documentation for this class was generated from the following file: