Navigation
API > API/Plugins > API/Plugins/WebAPIEditor
Holds information for a name and it's alternatives.
| Name | FWebAPINameInfo |
| Type | struct |
| Header File | /Engine/Plugins/Experimental/Web/WebAPI/Source/WebAPIEditor/Public/Dom/WebAPISchema.h |
| Include Path | #include "Dom/WebAPISchema.h" |
Syntax
USTRUCT (BlueprintType )
struct FWebAPINameInfo
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Dom/WebAPISchema.h | |||
FWebAPINameInfo
(
const FString& InName, |
Optionally provide TypeInfo to infer a prefix, for example "b" for booleans. | Dom/WebAPISchema.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| JsonName | FString | Field name as sent to and received from the external API. | Dom/WebAPISchema.h |
|
| Name | FString | Name without prefix or namespace, ie. "SomeParameter", not "InSomeParameter". | Dom/WebAPISchema.h |
|
| Prefix | FString | Type Prefix, usually for parameters ("In"/"Out") or booleans "b". | Dom/WebAPISchema.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FString GetDisplayName() |
The name for UI display. | Dom/WebAPISchema.h | |
FString GetJsonName() |
The json field name that the target API expects, rather than the UE friendly one. | Dom/WebAPISchema.h | |
| Get the fully formatted name as a valid member name. | Dom/WebAPISchema.h | ||
FString ToString
(
bool bInJustName |
Get the fully formatted name, with prefix. | Dom/WebAPISchema.h |