Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > HTTP > Interfaces > IHttpRequest

Light Theme

Dark Theme

IHttpRequest

Interface for Http requests (created using FHttpFactory)

Windows

MacOS

Linux

Inheritance Hierarchy

IHttpBase

TSharedFromThis

IHttpRequest

FHttpRequestImpl

FHttpRequestAdapterBase

FRequest

References

Module	HTTP
Header	/Engine/Source/Runtime/Online/HTTP/Public/Interfaces/IHttpRequest.h
Include	#include "Interfaces/IHttpRequest.h"

Syntax

class IHttpRequest :
public IHttpBase,
public TSharedFromThis< IHttpRequest, ESPMode::ThreadSafe >

Remarks

Interface for Http requests (created using FHttpFactory)

Destructors

	Name	Description
	~IHttpRequest()	Destructor for overrides

Functions

	Name	Description
void	AppendToHeader ( const FString& HeaderName, const FString& AdditionalHeaderVal... )	Appends to the value already set in the header.
void	CancelRequest()	Called to cancel a request that is still being processed
void	ClearTimeout()	Clears the optional timeout in seconds for this HTTP request, causing the default value from FHttpModule::GetTimeout() to be used.
float	GetElapsedTime()	Gets the time that it took for the server to fully respond to the request.
const FHttpR...	GetResponse()	Get the associated Response
EHttpRequest...	GetStatus()	Get the current status of the request being processed
TOptional< f...	GetTimeout()	Gets the optional timeout in seconds for this entire HTTP request to complete.
FString	GetVerb()	Gets the verb (GET, PUT, POST) used by the request.
FHttpRequest...	OnHeaderReceived()	Delegate called to signal the receipt of a header. See FHttpRequestHeaderReceivedDelegate
FHttpRequest...	OnProcessRequestComplete()	Delegate called when the request is complete. See FHttpRequestCompleteDelegate
FHttpRequest...	OnRequestProgress()	Delegate called to update the request/response progress. See FHttpRequestProgressDelegate
FHttpRequest...	OnRequestWillRetry()	Delegate called when the request will be retried
bool	ProcessRequest()	Called to begin processing the request.
void	SetContent ( const TArray< uint8 >& ContentPayl... )	Sets the content of the request (optional data). Usually only set for POST requests.
void	SetContent ( TArray< uint8 >&& ContentPayload )	Sets the content of the request (optional data).
bool	SetContentAsStreamedFile ( const FString& Filename )	Sets the content of the request to stream from a file.
void	SetContentAsString ( const FString& ContentString )	Sets the content of the request as a string encoded as UTF8.
bool	SetContentFromStream ( TSharedRef< FArchive, ESPMode::Thre... )	Sets the content of the request to stream directly from an archive.
void	SetHeader ( const FString& HeaderName, const FString& HeaderValue )	Sets optional header info.
void	SetTimeout ( float InTimeoutSecs )	Sets an optional timeout in seconds for this entire HTTP request to complete.
void	SetURL ( const FString& URL )	Sets the URL for the request Eg.
void	SetVerb ( const FString& Verb )	Sets the verb used by the request.
void	Tick ( float DeltaSeconds )	Used to tick the request

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss