UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
BuildPatchServices::FDownloadService Class Reference
+ Inheritance diagram for BuildPatchServices::FDownloadService:

Public Member Functions

 FDownloadService (IHttpManager *HttpManager, IFileSystem *FileSystem, IDownloadServiceStat *DownloadServiceStat, IInstallerAnalytics *InstallerAnalytics)
 
 ~FDownloadService ()
 
virtual int32 RequestFile (const FString &FileUri, const FDownloadCompleteDelegate &OnCompleteDelegate, const FDownloadProgressDelegate &OnProgressDelegate) override
 
int32 RequestFileWithHeaders (const FString &FileUri, const TMap< FString, FString > &RequestHeaders, const FDownloadCompleteDelegate &OnCompleteDelegate, const FDownloadProgressDelegate &OnProgressDelegate)
 
virtual void RequestCancel (int32 RequestId) override
 
virtual void RequestAbandon (int32 RequestId) override
 
- Public Member Functions inherited from BuildPatchServices::IDownloadService
virtual ~IDownloadService ()
 

Constructor & Destructor Documentation

◆ FDownloadService()

BuildPatchServices::FDownloadService::FDownloadService ( IHttpManager *  HttpManager,
IFileSystem *  FileSystem,
IDownloadServiceStat *  DownloadServiceStat,
IInstallerAnalytics *  InstallerAnalytics 
)
inline

◆ ~FDownloadService()

BuildPatchServices::FDownloadService::~FDownloadService ( )
inline

Member Function Documentation

◆ RequestAbandon()

virtual void BuildPatchServices::FDownloadService::RequestAbandon ( int32  RequestId)
inlineoverridevirtual

Requests the abandoning of a requested file (cancelling without calling complete/progress handlers)

Parameters
RequestIdThe id that was returned by the call to RequestFile which should be canceled.

Implements BuildPatchServices::IDownloadService.

◆ RequestCancel()

virtual void BuildPatchServices::FDownloadService::RequestCancel ( int32  RequestId)
inlineoverridevirtual

Requests the cancellation of a requested file.

Parameters
RequestIdThe id that was returned by the call to RequestFile which should be canceled.

Implements BuildPatchServices::IDownloadService.

◆ RequestFile()

virtual int32 BuildPatchServices::FDownloadService::RequestFile ( const FString &  FileUri,
const FDownloadCompleteDelegate &  OnCompleteDelegate,
const FDownloadProgressDelegate &  OnProgressDelegate 
)
inlineoverridevirtual

Starts a new request for a file.

Parameters
FileUriThe uri for the file request. For http(s), this should begin with the protocol.
OnCompleteDelegateThe delegate that will be called with the completed download.
OnProgressDelegateThe delegate that will be called with updates to the ongoing download.
Returns
the request id for this download, which will match that provided to the delegates.

Implements BuildPatchServices::IDownloadService.

◆ RequestFileWithHeaders()

int32 BuildPatchServices::FDownloadService::RequestFileWithHeaders ( const FString &  FileUri,
const TMap< FString, FString > &  RequestHeaders,
const FDownloadCompleteDelegate &  OnCompleteDelegate,
const FDownloadProgressDelegate &  OnProgressDelegate 
)
inlinevirtual

As per RequestFile, except adds the given headers to the request as a <Name, Value> pair.

Implements BuildPatchServices::IDownloadService.

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