Navigation
API > API/Plugins > API/Plugins/WebAPIEditor
A settings class is generated from this, it's not in itself a Settings object.
| Name | FWebAPICodeGenSettings |
| Type | class |
| Header File | /Engine/Plugins/Experimental/Web/WebAPI/Source/WebAPIEditor/Public/CodeGen/Dom/WebAPICodeGenSettings.h |
| Include Path | #include "CodeGen/Dom/WebAPICodeGenSettings.h" |
Syntax
class FWebAPICodeGenSettings : public FWebAPICodeGenBase
Inheritance Hierarchy
- FWebAPICodeGenBase → FWebAPICodeGenSettings
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Super | FWebAPICodeGenBase | Inherited baseclass. | CodeGen/Dom/WebAPICodeGenSettings.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| TypeName | const FName | CodeGen Type. | CodeGen/Dom/WebAPICodeGenSettings.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BaseUrl | FString | The Url path relative to the host address, ie. "/V1". | CodeGen/Dom/WebAPICodeGenSettings.h | |
| DateTimeFormat | FString | The date-time format this API uses to encode/decode from string. | CodeGen/Dom/WebAPICodeGenSettings.h | |
| Host | FString | The default host address to access this API. | CodeGen/Dom/WebAPICodeGenSettings.h | |
| Name | FWebAPITypeNameVariant | Name with optional prefix, namespace, etc. | CodeGen/Dom/WebAPICodeGenSettings.h | |
| ParentType | TSoftClassPtr< UDeveloperSettings > | Optional parent type. Useful if you have your own settings for this API that you want to extend. | CodeGen/Dom/WebAPICodeGenSettings.h | |
| Schemes | TArray< FString > | Uniform Resource Identifier schemes (ie. https, http). | CodeGen/Dom/WebAPICodeGenSettings.h | |
| UserAgent | FString | The UserAgent to encode in Http request headers. | CodeGen/Dom/WebAPICodeGenSettings.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void FromWebAPI
(
const UWebAPIDefinition* InSrcModel |
Populates this object from the given WebAPI object. | CodeGen/Dom/WebAPICodeGenSettings.h |
Overridden from FWebAPICodeGenBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void GetIncludePaths
(
TArray< FString >& OutIncludePaths |
Append any include paths for this file to the given Array (not Set, to allow custom order). | CodeGen/Dom/WebAPICodeGenSettings.h | |
virtual void GetModuleDependencies
(
TSet< FString >& OutModules |
Append any dependent modules for this file to the given Set. | CodeGen/Dom/WebAPICodeGenSettings.h | |
virtual const FName & GetTypeName() |
CodeGen Type. | CodeGen/Dom/WebAPICodeGenSettings.h |