Navigation
API > API/Plugins > API/Plugins/WebAPI
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UDeveloperSettings
- UWebAPIDeveloperSettings
References
| Module | WebAPI |
| Header | /Engine/Plugins/Experimental/Web/WebAPI/Source/WebAPI/Public/WebAPIDeveloperSettings.h |
| Include | #include "WebAPIDeveloperSettings.h" |
Syntax
UCLASS&40;Abstract, Config&61;"Engine", defaultconfig&41;
class UWebAPIDeveloperSettings :
public UDeveloperSettings,
public FWebAPIHttpResponseHandlerInterface
Remarks
The base class of any auto generated WebAPI settings object.
Variables
| Type | Name | Description | |
|---|---|---|---|
| TArray< TSharedPtr< FWebAPIAuthenticationSchemeHandler > > | AuthenticationHandlers | ||
| TArray< TObjectPtr< UWebAPIAuthenticationSettings > > | AuthenticationSettings | Authentication settings per security scheme. | |
| FString | BaseUrl | The Url path relative to the host address, ie. "/V1". | |
| bool | bLogRequests | Whether to print requests to the output log, useful for debugging. | |
| bool | bOverrideScheme | Whether to override the URI scheme. | |
| FString | DateTimeFormat | The date-time format this API uses to encode/decode from string. | |
| FString | Host | The default host address to access this API. | |
| FString | URISchemeOverride | User specified Uniform Resource Identifier scheme. | |
| TArray< FString > | URISchemes | Uniform Resource Identifier schemes (ie. https, http). | |
| FString | UserAgent | The UserAgent to encode in Http request headers. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| FString | Returns a fully formatted Url, including the sub-path. | ||
| const TArray< TSharedPtr< FWebAPIAuthenticationSchemeHandler > > & | |||
| FString | GetURI () |
Returns the most secure URI, or the user specified URI if enabled. | |
| bool | HandleHttpResponse
(
EHttpResponseCodes::Type InResponseCode, |
Called for all responses, providing the opportunity for custom interception. | |
| TMap< FString, FString > | MakeDefaultHeaders
(
const FName& InVerb |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| void | PostEditChangeChainProperty
(
FPropertyChangedChainEvent& PropertyChangedEvent |
This alternate version of PostEditChange is called when properties inside structs are modified. |