Navigation
API > API/Plugins > API/Plugins/WebAPIEditor
Describes a single property within a model.
| Name | UWebAPIProperty |
| Type | class |
| Header File | /Engine/Plugins/Experimental/Web/WebAPI/Source/WebAPIEditor/Public/Dom/WebAPIModel.h |
| Include Path | #include "Dom/WebAPIModel.h" |
Syntax
UCLASS ()
class UWebAPIProperty : public UWebAPIModelBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UWebAPIModelBase → UWebAPIProperty
Implements Interfaces
Derived Classes
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsArray | bool | If the property is an array of Type. | Dom/WebAPIModel.h |
|
| bIsMixin | bool | When the properties inside of this should be treated as though they're directly in the parent. | Dom/WebAPIModel.h |
|
| DefaultValue | FString | Default value (optional) as a string. | Dom/WebAPIModel.h |
|
| DefaultValues | TArray< FString > | Array of values if needed, ie. enum | Dom/WebAPIModel.h |
|
| Name | FWebAPINameVariant | Name of the Property. | Dom/WebAPIModel.h |
|
| Type | FWebAPITypeNameVariant | Type of the Property. | Dom/WebAPIModel.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FString GetDefaultValue
(
bool bQualified |
Default value as a string, if applicable. | Dom/WebAPIModel.h | |
virtual bool IsRequired() |
Returns if this property is required to have it's value set by the user. | Dom/WebAPIModel.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual EDataValidationResult IsDataValid
(
FDataValidationContext& Context |
Dom/WebAPIModel.h |
Overridden from IWebAPISchemaObjectInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void SetNamespace
(
const FString& InNamespace |
Recursively sets the namespace of this and all child objects. | Dom/WebAPIModel.h |