UWebAPISchema | Unreal Engine 5.6 Documentation

Describes the intermediate structure from which to generate code.


Name	UWebAPISchema
Type	class
Header File	/Engine/Plugins/Experimental/Web/WebAPI/Source/WebAPIEditor/Public/Dom/WebAPISchema.h
Include Path	#include "Dom/WebAPISchema.h"

Syntax

UCLASS (BlueprintType)  
class UWebAPISchema :  
    public UObject ,  
    public IWebAPISchemaObjectInterface

Name	Remarks	Include Path	Unreal Specifiers
UWebAPISchema()		Dom/WebAPISchema.h

Name	Type	Remarks	Include Path
LogName	const TCHAR *		Dom/WebAPISchema.h

Name	Type	Remarks	Include Path	Unreal Specifiers
APIName	FString	Name of the API.	Dom/WebAPISchema.h	VisibleAnywhere Category="Schema"
BaseUrl	FString	The Url path relative to the host address, ie. "/V1".	Dom/WebAPISchema.h	VisibleAnywhere Category="Schema"
DateTimeFormat	FString	The date-time format this API uses to encode/decode from string.	Dom/WebAPISchema.h	VisibleAnywhere Category="Schema"
Host	FString	The default host address to access this API.	Dom/WebAPISchema.h	VisibleAnywhere Category="Schema"
Models	TArray< TObjectPtr< UWebAPIModelBase > >	Models can be a combination of classes, structs and enums used by this API.	Dom/WebAPISchema.h	VisibleAnywhere Category="Schema"
Services	TMap< FString, TObjectPtr< class UWebAPIService > >	Each service contains one or more operations.	Dom/WebAPISchema.h	VisibleAnywhere Category="Schema"
TypeRegistry	TObjectPtr< UWebAPITypeRegistry >	Contains all referenced types for this API.	Dom/WebAPISchema.h
URISchemes	TArray< FString >	Uniform Resource Identifier schemes (ie. https, http).	Dom/WebAPISchema.h	VisibleAnywhere Category="Schema"
UserAgent	FString	The UserAgent to encode in Http request headers.	Dom/WebAPISchema.h	VisibleAnywhere AdvancedDisplay Category="Schema"
Version	FString	The API version can be any arbitrary string that is useful if there are several versions.	Dom/WebAPISchema.h	VisibleAnywhere Category="Schema"

Name	Remarks	Include Path
UWebAPIEnum * AddEnum ( const TObjectPtr< UWebAPITypeInfo >& InTypeInfo )	Add and return a reference to a new Enum.	Dom/WebAPISchema.h
ModelType * AddModel ( const TObjectPtr< UWebAPITypeInfo >& InTypeInfo )	Add and return a reference to a new Model	Dom/WebAPISchema.h
UWebAPIParameter * AddParameter ( const TObjectPtr< UWebAPITypeInfo >& InTypeInfo )	Add and return a reference to a new Parameter.	Dom/WebAPISchema.h
void Clear()	Resets the Schema to defaults.	Dom/WebAPISchema.h
const TSharedPtr< FWebAPIMessageLog > & GetMessageLog()		Dom/WebAPISchema.h
TObjectPtr< class UWebAPIService > GetOrMakeService ( const FString& InName )	Find/Add and return a reference to an existing/new Service.	Dom/WebAPISchema.h

Name	Remarks	Include Path	Unreal Specifiers
virtual EDataValidationResult IsDataValid ( FDataValidationContext& Context ) const		Dom/WebAPISchema.h

Name	Remarks	Include Path	Unreal Specifiers
virtual void Visit ( TFunctionRef< void(IWebAPISchemaObjectInterface*&)> InVisitor )	Recursively visit each element in the schema.	Dom/WebAPISchema.h