UWebAPIDeveloperSettings | Unreal Engine 5.6 Documentation

The base class of any auto generated WebAPI settings object.


Name	UWebAPIDeveloperSettings
Type	class
Header File	/Engine/Plugins/Experimental/Web/WebAPI/Source/WebAPI/Public/WebAPIDeveloperSettings.h
Include Path	#include "WebAPIDeveloperSettings.h"

Syntax

UCLASS (Abstract, Config="Engine", defaultconfig)  
class UWebAPIDeveloperSettings :  
    public UDeveloperSettings ,  
    public FWebAPIHttpResponseHandlerInterface

Inheritance Hierarchy

FWebAPIHttpResponseHandlerInterface → UWebAPIDeveloperSettings
UObjectBase → UObjectBaseUtility → UObject → UDeveloperSettings → UWebAPIDeveloperSettings

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UWebAPIDeveloperSettings()		WebAPIDeveloperSettings.h

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
AuthenticationSettings	TArray< TObjectPtr< UWebAPIAuthenticationSettings > >	Authentication settings per security scheme.	WebAPIDeveloperSettings.h	EditAnywhere BlueprintReadWrite Instanced NoClear EditFixedSize Category="Security" Meta=(TitleProperty="SchemeName")
BaseUrl	FString	The Url path relative to the host address, ie. "/V1".	WebAPIDeveloperSettings.h	Config EditAnywhere BlueprintReadWrite Category="Settings"
bLogRequests	bool	Whether to print requests to the output log, useful for debugging.	WebAPIDeveloperSettings.h	Config EditAnywhere BlueprintReadWrite Category="Developer"
bOverrideScheme	bool	Whether to override the URI scheme.	WebAPIDeveloperSettings.h	Config EditAnywhere BlueprintReadWrite Category="Settings" Meta=(InlineEditConditionToggle)
DateTimeFormat	FString	The date-time format this API uses to encode/decode from string.	WebAPIDeveloperSettings.h	Config EditAnywhere BlueprintReadWrite Category="Settings"
Host	FString	The default host address to access this API.	WebAPIDeveloperSettings.h	Config EditAnywhere BlueprintReadWrite Category="Settings"
URISchemeOverride	FString	User specified Uniform Resource Identifier scheme.	WebAPIDeveloperSettings.h	Config EditAnywhere BlueprintReadWrite Category="Settings" Meta=(EditCondition="bOverrideScheme")
URISchemes	TArray< FString >	Uniform Resource Identifier schemes (ie. https, http).	WebAPIDeveloperSettings.h	VisibleAnywhere BlueprintReadWrite Category="Settings"
UserAgent	FString	The UserAgent to encode in Http request headers.	WebAPIDeveloperSettings.h	Config EditAnywhere BlueprintReadWrite Category="Settings"

Functions

Public

Name	Remarks	Include Path
FString FormatUrl ( const FString& InSubPath ) const	Returns a fully formatted Url, including the sub-path.	WebAPIDeveloperSettings.h
virtual const TArray< TSharedPtr< FWebAPIAuthenticationSchemeHandler > > & GetAuthenticationHandlers()		WebAPIDeveloperSettings.h
FString GetURI()	Returns the most secure URI, or the user specified URI if enabled.	WebAPIDeveloperSettings.h
virtual TMap< FString, FString > MakeDefaultHeaders ( const FName& InVerb ) const		WebAPIDeveloperSettings.h
virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedEvent )		WebAPIDeveloperSettings.h

Protected

Name	Remarks	Include Path	Unreal Specifiers
virtual bool HandleHttpResponse ( EHttpResponseCodes::Type InResponseCode, TSharedPtr< class IHttpResponse, ESPMode::ThreadSafe > InResponse, bool bInWasSuccessful, UWebAPIDeveloperSettings* InSettings )	Called for all responses, providing the opportunity for custom interception.	WebAPIDeveloperSettings.h

Navigation

Syntax

Inheritance Hierarchy

Constructors

Variables

Public

Functions

Public

Protected