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

#include <AppleHttp.h>

+ Inheritance diagram for FAppleHttpResponse:

Public Member Functions

virtual TArray< FString > GetAllHeaders () const override
 
virtual FString GetContentType () const override
 
virtual uint64 GetContentLength () const override
 
bool IsReady () const
 
const uint64 GetNumBytesReceived () const
 
const uint64 GetNumBytesWritten () const
 
void CleanSharedObjects ()
 
void SetNewAppleHttpEventDelegate (FNewAppleHttpEventDelegate &&Delegate)
 
void SetHeaders (TMap< FString, FString > &&InHeaders)
 
FAppleHttpResponseDelegate * GetResponseDelegate () const
 
 FAppleHttpResponse (FAppleHttpRequest &InRequest)
 
virtual ~FAppleHttpResponse ()
 
void AppendToPayload (const uint8 *Ptr, int64 Size)
 
- Public Member Functions inherited from FHttpResponseCommon
 FHttpResponseCommon (const FHttpRequestCommon &HttpRequest)
 
virtual FString GetURLParameter (const FString &ParameterName) const override
 
virtual const FString & GetURL () const override
 
virtual const FString & GetEffectiveURL () const override
 
virtual EHttpRequestStatus::Type GetStatus () const override
 
virtual EHttpFailureReason GetFailureReason () const override
 
virtual int32 GetResponseCode () const override
 
virtual FUtf8StringView GetContentAsUtf8StringView () const override
 
virtual FString GetHeader (const FString &HeaderName) const override
 
virtual const TArray< uint8 > & GetContent () const override
 
virtual FString GetContentAsString () const override
 
- Public Member Functions inherited from IHttpResponse
virtual ~IHttpResponse ()=default
 
- Public Member Functions inherited from IHttpBase
virtual ~IHttpBase ()=default
 

Friends

class FAppleHttpRequest
 

Additional Inherited Members

- Protected Member Functions inherited from FHttpResponseCommon
void SetRequestStatus (EHttpRequestStatus::Type InCompletionStatus)
 
void SetRequestFailureReason (EHttpFailureReason InFailureReason)
 
void SetEffectiveURL (const FString &InEffectiveURL)
 
void SetResponseCode (int32 InResponseCode)
 
void AppendToPayload (const uint8 *Ptr, int64 Size)
 
- Protected Attributes inherited from FHttpResponseCommon
FString URL
 
FString EffectiveURL
 
EHttpRequestStatus::Type CompletionStatus
 
EHttpFailureReason FailureReason
 
int32 ResponseCode = EHttpResponseCodes::Unknown
 
TArray< uint8 > Payload
 
TMap< FString, FString > Headers
 
bool bIsReady = false
 

Detailed Description

Apple implementation of an Http response

Constructor & Destructor Documentation

◆ FAppleHttpResponse()

FAppleHttpResponse::FAppleHttpResponse ( FAppleHttpRequest &  InRequest)

Constructor

Parameters
InRequest- original request that created this response

◆ ~FAppleHttpResponse()

FAppleHttpResponse::~FAppleHttpResponse ( )
virtual

Destructor

Member Function Documentation

◆ AppendToPayload()

void FHttpResponseCommon::AppendToPayload ( const uint8 *  Ptr,
int64  Size 
)

◆ CleanSharedObjects()

void FAppleHttpResponse::CleanSharedObjects ( )

Cleans internal shared objects between request and response

◆ GetAllHeaders()

TArray< FString > FAppleHttpResponse::GetAllHeaders ( ) const
overridevirtual

Return all headers in an array in "Name: Value" format.

Returns
the header array of strings

Implements IHttpBase.

◆ GetContentLength()

uint64 FAppleHttpResponse::GetContentLength ( ) const
overridevirtual

Shortcut to get the Content-Length header value. Will not always return non-zero. If you want the real length of the payload, get the payload and check it's length.

Returns
the content length (if available)

Implements IHttpBase.

◆ GetContentType()

FString FAppleHttpResponse::GetContentType ( ) const
overridevirtual

Shortcut to get the Content-Type header value (if available)

Returns
the content type.

Implements IHttpBase.

◆ GetNumBytesReceived()

const uint64 FAppleHttpResponse::GetNumBytesReceived ( ) const

Get the number of bytes received so far

◆ GetNumBytesWritten()

const uint64 FAppleHttpResponse::GetNumBytesWritten ( ) const

Get the number of bytes sent so far

◆ GetResponseDelegate()

FAppleHttpResponseDelegate * FAppleHttpResponse::GetResponseDelegate ( ) const

◆ IsReady()

bool FAppleHttpResponse::IsReady ( ) const

Check whether a response is ready or not.

◆ SetHeaders()

void FAppleHttpResponse::SetHeaders ( TMap< FString, FString > &&  InHeaders)

◆ SetNewAppleHttpEventDelegate()

void FAppleHttpResponse::SetNewAppleHttpEventDelegate ( FNewAppleHttpEventDelegate &&  Delegate)

Sets delegate invoked when URLSession:dataTask:didReceiveData or URLSession:task:didCompleteWithError: are triggered Should be set right before task is started

Friends And Related Symbol Documentation

◆ FAppleHttpRequest

friend class FAppleHttpRequest
friend
The documentation for this class was generated from the following files: