Navigation
API > API/Plugins > API/Plugins/WebAPIEditor
Baseclass with common properties for various Schema classes.
| Name | UWebAPIModelBase |
| Type | class |
| Header File | /Engine/Plugins/Experimental/Web/WebAPI/Source/WebAPIEditor/Public/Dom/WebAPISchema.h |
| Include Path | #include "Dom/WebAPISchema.h" |
Syntax
UCLASS (MinimalAPI, Abstract)
class UWebAPIModelBase :
public UObject ,
public IWebAPISchemaObjectInterface
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UWebAPIModelBase
Implements Interfaces
Derived Classes
UWebAPIModelBase derived class hierarchy
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsReadOnly | bool | By default all properties are read & write. | Dom/WebAPISchema.h |
|
| bIsRequired | bool | By default all properties are optional. | Dom/WebAPISchema.h |
|
| bUseMaximumValue | bool | Whether to use Maximum value. | Dom/WebAPISchema.h |
|
| bUseMinimumValue | bool | Whether to use Minimum value. | Dom/WebAPISchema.h |
|
| bUsePattern | bool | Whether to use a Regex Pattern for validation. | Dom/WebAPISchema.h |
|
| Description | FString | Describes this model. | Dom/WebAPISchema.h |
|
| MaximumValue | double | Maximum value. Can also indicate maximum string length. | Dom/WebAPISchema.h |
|
| MinimumValue | double | Minimum value. Can also indicate minimum string length. | Dom/WebAPISchema.h |
|
| Pattern | FString | Regex Pattern to validate against. | Dom/WebAPISchema.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BindToTypeInfo() |
Associates this model with it's own TypeInfo. | Dom/WebAPISchema.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual EDataValidationResult IsDataValid
(
FDataValidationContext& Context |
Dom/WebAPISchema.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/WebAPISchema.h |