UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
BuildPatchServices::IDownloadService Class Referenceabstract

#include <DownloadService.h>

+ Inheritance diagram for BuildPatchServices::IDownloadService:

Public Member Functions

virtual ~IDownloadService ()
 
virtual int32 RequestFile (const FString &FileUri, const FDownloadCompleteDelegate &OnCompleteDelegate, const FDownloadProgressDelegate &OnProgressDelegate)=0
 
virtual int32 RequestFileWithHeaders (const FString &FileUri, const TMap< FString, FString > &RequestHeaders, const FDownloadCompleteDelegate &OnCompleteDelegate, const FDownloadProgressDelegate &OnProgressDelegate)=0
 
virtual void RequestCancel (int32 RequestId)=0
 
virtual void RequestAbandon (int32 RequestId)=0
 

Detailed Description

An interface providing access to download files, supporting http(s) and network protocols.

Constructor & Destructor Documentation

◆ ~IDownloadService()

virtual BuildPatchServices::IDownloadService::~IDownloadService ( )
inlinevirtual

Member Function Documentation

◆ RequestAbandon()

virtual void BuildPatchServices::IDownloadService::RequestAbandon ( int32  RequestId)
pure virtual

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.

Implemented in BuildPatchServices::FDownloadService.

◆ RequestCancel()

virtual void BuildPatchServices::IDownloadService::RequestCancel ( int32  RequestId)
pure virtual

Requests the cancellation of a requested file.

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

Implemented in BuildPatchServices::FDownloadService.

◆ RequestFile()

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

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.

Implemented in BuildPatchServices::FDownloadService.

◆ RequestFileWithHeaders()

virtual int32 BuildPatchServices::IDownloadService::RequestFileWithHeaders ( const FString &  FileUri,
const TMap< FString, FString > &  RequestHeaders,
const FDownloadCompleteDelegate &  OnCompleteDelegate,
const FDownloadProgressDelegate &  OnProgressDelegate 
)
pure virtual

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

Implemented in BuildPatchServices::FDownloadService.

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