description: Convenience function to create a simple Http request.

code: [TFuture](API\Runtime\Core\Async\TFuture)< [TTuple](API\Runtime\Core\Misc\TTuple)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IHttpResponse](API\Runtime\HTTP\Interfaces\IHttpResponse), ESPMode::ThreadSafe >, bool > > MakeHttpRequest ( const [FString](API\Runtime\Core\Containers\FString) & InVerb, [TUniqueFunction](API\Runtime\Core\Templates\TUniqueFunction)< void(const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [IHttpRequest](API\Runtime\HTTP\Interfaces\IHttpRequest), ESPMode::ThreadSafe >)> OnRequestCreated )


description: Get or create pooled operation for the given OperationType.

module: WebAPI

code: template<typename OperationType> [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< OperationType > MakeOperation ( const [UWebAPIDeveloperSettings](API\Plugins\WebAPI\UWebAPIDeveloperSettings) * InSettings )


code: [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UWebAPIOperationObject](API\Plugins\WebAPI\UWebAPIOperationObject) > MakeOperation ( const [UWebAPIDeveloperSettings](API\Plugins\WebAPI\UWebAPIDeveloperSettings) * InSettings, const [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [UWebAPIOperationObject](API\Plugins\WebAPI\UWebAPIOperationObject) > & InClass )


description: Returns the provided operation to the pool, making it available for re-use.

code: template<typename OperationType> void ReleaseOperation ( const [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< OperationType > & InOperation )


code: void ReleaseOperation ( const [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [UWebAPIOperationObject](API\Plugins\WebAPI\UWebAPIOperationObject) > & InClass, const [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UWebAPIOperationObject](API\Plugins\WebAPI\UWebAPIOperationObject) > & InOperation )


description: Retry any failed and buffered requests for the given host.

code: void RetryRequestsForHost ( const [FString](API\Runtime\Core\Containers\FString) & InHost )


description: Pure virtual that must be overloaded by the inheriting class. It will be called from within LevelTick.cpp after ticking all actors or from the rendering thread (depending on bIsRenderingThreadObject)

code: virtual void Tick ( float DeltaTime )


className: UWebAPISubsystem

description: Common functionality and top-level parent for shared objects.


description: Return the host (only) from the provided Url.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, BlueprintPure, Category="WebAPI") static [FString](API\Runtime\Core\Containers\FString) GetHostFromUrl ( const [FString](API\Runtime\Core\Containers\FString) & InUrl )


description: Return the message from the provided response.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, BlueprintPure, Category="WebAPI") static const [FText](API\Runtime\Core\Internationalization\FText) & GetResponseMessage ( const [FWebAPIMessageResponse](API\Plugins\WebAPI\FWebAPIMessageResponse) & MessageResponse )


className: UWebAPIUtilities

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UWebAPIUtilities : public [UBlueprintFunctionLibrary](API\Runtime\Engine\Kismet\UBlueprintFunctionLibrary)


module: WebAPIEditor

code: template<typename T> auto Requires ( T & Val, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & Arg )


className: CFromJsonable

description: Describes a type that provides a FromJson function.

code: struct CFromJsonable


code: template<typename T> auto Requires()


className: CMap

description: Describes a type the is derived fromTMap.

code: struct CMap


description: Append any include paths for this file to the given Array (not Set, to allow custom order).

code: virtual void GetIncludePaths ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutIncludePaths ) const


description: Append any include paths for this file to the given Set.

code: virtual void GetIncludePaths ( [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & OutIncludePaths ) const


description: Append any dependent modules for this file to the given Set.

code: virtual void GetModuleDependencies ( [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & OutModules ) const


description: Retrieve the name. The source depends on the CodeGen object type.

code: virtual [FString](API\Runtime\Core\Containers\FString) GetName ( bool bJustName )


description: CodeGen Type.

code: virtual const [FName](API\Runtime\Core\UObject\FName) & GetTypeName()


description: Sets the containing module name.

code: virtual void SetModule ( const [FString](API\Runtime\Core\Containers\FString) & InModule )


className: CNumerical

description: Concept to check if T has NumericLimits, and isn't a bool.

code: struct CNumerical


code: virtual ~FWebAPICodeGenBase()


className: FWebAPICodeGenBase

code: class FWebAPICodeGenBase

Description

type: FString

description: Description for this object.

Metadata

type: TMap<FString, ...

description: U* metadata, with or without a value.

Module

description: Containing module name.

Namespace

description: Type Namespace, can be empty for built-in types.

ServiceName

description: For Operations and Operation Parameters.

Specifiers

description: U* specifiers, with or without a value.


description: Finds or creates a function with the given name.

code: const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FWebAPICodeGenFunction](API\Plugins\WebAPIEditor\CodeGen\Dom\FWebAPICodeGenFunction) > & FindOrAddFunction ( const [FWebAPINameVariant](API\Plugins\WebAPIEditor\Dom\FWebAPINameVariant) & InName )


className: Super

description: Inherited baseclass.


className: TypeName

description: CodeGen Type.

code: static const [FName](API\Runtime\Core\UObject\FName) TypeName = TEXT("Class");


code: FWebAPICodeGenClass ( const [FWebAPICodeGenStruct](API\Plugins\WebAPIEditor\CodeGen\Dom\FWebAPICodeGenStruct) & InStruct )


className: FWebAPICodeGenClass

code: class FWebAPICodeGenClass : public [FWebAPICodeGenStruct](API\Plugins\WebAPIEditor\CodeGen\Dom\FWebAPICodeGenStruct)

Functions

type: TArray<TShared...

description: Functions within this class.


description: Populates this object from the given WebAPI object.

code: void FromWebAPI ( const [UWebAPIEnum](API\Plugins\WebAPIEditor\Dom\UWebAPIEnum) * InSrcEnum )


description: CodeGen Type.

code: static const [FName](API\Runtime\Core\UObject\FName) TypeName = TEXT("Enum");


className: FWebAPICodeGenEnum

code: class FWebAPICodeGenEnum : public [FWebAPICodeGenBase](API\Plugins\WebAPIEditor\CodeGen\Dom\FWebAPICodeGenBase)

DefaultValue

description: Default value as a string, if applicable.

Name

type: FWebAPITypeName...

description: Name of the Enum.

Values

type: TArray<FWebAPI...

description: Values within the Enum.


code: void FromWebAPI ( const [UWebAPIEnumValue](API\Plugins\WebAPIEditor\Dom\UWebAPIEnumValue) * InSrcEnumValue )


description: CodeGen Type.

code: const [FName](API\Runtime\Core\UObject\FName) & GetTypeName()


description: CodeGen Type.

code: static const [FName](API\Runtime\Core\UObject\FName) TypeName = TEXT("EnumValue");


className: FWebAPICodeGenEnumValue

code: struct FWebAPICodeGenEnumValue

Description

description: Description of the Enum Value.

DisplayName

description: Display Name of the Enum Value.

IntegralValue

description: Explicit integral value for an enum (0-255).

JsonName

description: Json Name of the Enum Value.

Name

description: Name of the Enum Value.


description: Adds the given item as a SubItem and appends include paths.

code: void AddItem ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FWebAPICodeGenBase](API\Plugins\WebAPIEditor\CodeGen\Dom\FWebAPICodeGenBase) > & InItem )


code: template<typename CodeGenType> void AddItems ( const [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< CodeGenType >> & InItems )


description: Returns the full, absolute path to the file.


code: virtual void GetIncludePaths ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutIncludePaths ) const


code: virtual void GetIncludePaths ( [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & OutIncludePaths ) const


description: CodeGen Type.

code: virtual const [FName](API\Runtime\Core\UObject\FName) & GetTypeName()


description: Sets the containing module name.

code: virtual void SetModule ( const [FString](API\Runtime\Core\Containers\FString) & InModule )


description: Inherited baseclass.


description: CodeGen Type.

code: static const [FName](API\Runtime\Core\UObject\FName) TypeName = TEXT("File");


className: FWebAPICodeGenFile

description: Contains a list of declarations/definitions to generate for a single file.

code: class FWebAPICodeGenFile : public [FWebAPICodeGenBase](API\Plugins\WebAPIEditor\CodeGen\Dom\FWebAPICodeGenBase)

BaseFilePath

description: Absolute Base Path to output to, usually a Module/Source/x/(Public or Private).

CopyrightNotice

description: Copyright notice to apply to the top of the file. Uses the Project setting unless specified.

FileName

description: Name of the file, excluding extension.

FileType

description: File extension.

IncludePaths

type: TSet<FString>

description: Set of (unique) include paths.

Modules

description: Module dependencies for this file.

RelativeFilePath

description: Relative Path of the file, excluding the filename itself.

SchemaObjects

type: TArray<TWeakOb...

description: Schema objects represented by this file.

SubItems

description: The inner codegen items to create within the file.


description: CodeGen Type.

code: static const [FName](API\Runtime\Core\UObject\FName) TypeName = TEXT("Function");


className: FWebAPICodeGenFunction

code: class FWebAPICodeGenFunction : public [FWebAPICodeGenBase](API\Plugins\WebAPIEditor\CodeGen\Dom\FWebAPICodeGenBase)

bIsConst

type: bool

description: Flag for a constant function.

bIsConstReturnType

description: Flag if the returned value is constant.

bIsOverride

description: Flag if the function is a virtual override.

Body

description: Raw string to insert as the Function implementation.

Name

type: FWebAPINameVari...

description: Name with optional prefix, namespace, etc.

Parameters

description: Parameters for this function.

ReturnType

description: The type to return. If unspecified it will be void.


description: CodeGen Type.

code: static const [FName](API\Runtime\Core\UObject\FName) TypeName = TEXT("FunctionParameter");


className: FWebAPICodeGenFunctionParameter

code: class FWebAPICodeGenFunctionParameter : public [FWebAPICodeGenProperty](API\Plugins\WebAPIEditor\CodeGen\Dom\FWebAPICodeGenProperty)


description: Finds or creates a response with the given name.

code: const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FWebAPICodeGenOperationResponse](API\Plugins\WebAPIEditor\CodeGen\Dom\FWebAPICodeGenOperationResponse) > & FindOrAddResponse ( const uint32 & InResponseCode )


code: void FromWebAPI ( const class [UWebAPIOperation](API\Plugins\WebAPIEditor\Dom\UWebAPIOperation) * InSrcOperation )


description: Append any dependent modules for this file to the given Set.

code: virtual void GetModuleDependencies ( [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & OutModules ) const


description: Retrieve the name. The source depends on the CodeGen object type.

code: virtual [FString](API\Runtime\Core\Containers\FString) GetName ( bool bJustName )


description: CodeGen Type.

code: static const [FName](API\Runtime\Core\UObject\FName) TypeName = TEXT("Operation");


className: FWebAPICodeGenOperation

code: class FWebAPICodeGenOperation : public [FWebAPICodeGenBase](API\Plugins\WebAPIEditor\CodeGen\Dom\FWebAPICodeGenBase)

bIsDeprecated

description: Flags an operation previously available as deprecated.

Path

description: Templated/tokenized Url path relative to the Base Url.

RequestMediaType

description: Usually application/json.

Requests

description: Requests for this Operation.

Responses

description: Responses for this Operation.

SettingsTypeName

description: The name of the generated Settings class.

Verb

description: Http Verb.


description: Populates this object from the given WebAPI object.

code: void FromWebAPI ( const class [UWebAPIOperationParameter](API\Plugins\WebAPIEditor\Dom\UWebAPIOperationParameter) * InSrcOperationParameter )


description: CodeGen Type.

code: static const [FName](API\Runtime\Core\UObject\FName) TypeName = TEXT("OperationParameter");


className: FWebAPICodeGenOperationParameter

code: class FWebAPICodeGenOperationParameter : public [FWebAPICodeGenProperty](API\Plugins\WebAPIEditor\CodeGen\Dom\FWebAPICodeGenProperty)

bIsRequired

description: Mark as required (not-optional).

MediaType

description: The optional media-type, ie. "application/json".

Storage

type: EWebAPIParamete...

description: Where this parameter is stored/encoded in the request.


description: Finds or creates a parameter with the given name.

code: const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FWebAPICodeGenOperationParameter](API\Plugins\WebAPIEditor\CodeGen\Dom\FWebAPICodeGenOperationParameter) > & FindOrAddParameter ( const [FString](API\Runtime\Core\Containers\FString) & InName )


code: void FromWebAPI ( const class [UWebAPIOperationRequest](API\Plugins\WebAPIEditor\Dom\UWebAPIOperationRequest) * InSrcOperationRequest )


description: Append any include paths for this file to the given Array (not Set, to allow custom order).

code: virtual void GetIncludePaths ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutIncludePaths ) const


description: CodeGen Type.

code: virtual const [FName](API\Runtime\Core\UObject\FName) & GetTypeName()


description: Sets the containing module name.

code: virtual void SetModule ( const [FString](API\Runtime\Core\Containers\FString) & InModule )


description: Inherited baseclass.


description: CodeGen Type.

code: static const [FName](API\Runtime\Core\UObject\FName) TypeName = TEXT("OperationRequest");


className: FWebAPICodeGenOperationRequest

description: Encapsulates the request parameters for an operation.

code: class FWebAPICodeGenOperationRequest : public [FWebAPICodeGenStruct](API\Plugins\WebAPIEditor\CodeGen\Dom\FWebAPICodeGenStruct)

Parameters

description: Array of parameters contained in this request.


code: void FromWebAPI ( const class [UWebAPIOperationResponse](API\Plugins\WebAPIEditor\Dom\UWebAPIOperationResponse) * InSrcOperationResponse )


description: CodeGen Type.

code: static const [FName](API\Runtime\Core\UObject\FName) TypeName = TEXT("OperationResponse");


className: FWebAPICodeGenOperationResponse

code: class FWebAPICodeGenOperationResponse : public [FWebAPICodeGenStruct](API\Plugins\WebAPIEditor\CodeGen\Dom\FWebAPICodeGenStruct)

Message

description: Optional message based on the response status or result.

ResponseCode

description: Http response code.

Storage

type: EWebAPIResponse...

description: Where this parameter is stored/encoded in the response.


code: void FromWebAPI ( const class [UWebAPIProperty](API\Plugins\WebAPIEditor\Dom\UWebAPIProperty) * InSrcProperty )


code: virtual void GetModuleDependencies ( [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & OutModules ) const


description: CodeGen Type.

code: static const [FName](API\Runtime\Core\UObject\FName) TypeName = TEXT("Property");


className: FWebAPICodeGenProperty

code: class FWebAPICodeGenProperty : public [FWebAPICodeGenBase](API\Plugins\WebAPIEditor\CodeGen\Dom\FWebAPICodeGenBase)

bIsArray

description: If the property is an array of Type.

bIsConst

description: Constant declaration.

bIsMixin

description: When the properties inside of this should be treated as though they're directly in the parent.

bIsRecursiveType

description: If the property type is the same as it's container.

bIsRequired

description: Bydefault all properties are optional.

DefaultValue

description: Default value as a string, if applicable.

Name

description: Name with optional prefix, namespace, etc.

Type

description: Property Type.


code: void FromWebAPI ( const [UWebAPIDefinition](API\Plugins\WebAPIEditor\UWebAPIDefinition) * InSrcModel )


description: CodeGen Type.

code: static const [FName](API\Runtime\Core\UObject\FName) TypeName = TEXT("Settings");


className: FWebAPICodeGenSettings

description: A settings class is generated from this, it's not in itself a Settings object.

code: class FWebAPICodeGenSettings : public [FWebAPICodeGenBase](API\Plugins\WebAPIEditor\CodeGen\Dom\FWebAPICodeGenBase)

BaseUrl

description: The Url path relative to the host address, ie. "/V1".

DateTimeFormat

description: The date-time format this API uses to encode/decode from string.

Host

description: The default host address to access this API.

ParentType

type: TSoftClassPtr< ...

description: Optional parent type. Useful if you have your own settings for this API that you want to extend.

Schemes

type: TArray<FString...

description: Uniform Resource Identifier schemes (ie. https, http).

UserAgent

description: The UserAgent to encode in Http request headers.


description: Finds or creates a property with the given name.

code: const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FWebAPICodeGenProperty](API\Plugins\WebAPIEditor\CodeGen\Dom\FWebAPICodeGenProperty) > & FindOrAddProperty ( const [FWebAPINameVariant](API\Plugins\WebAPIEditor\Dom\FWebAPINameVariant) & InName )


description: Find and return properties that are of the same type as the containing class.

code: bool FindRecursiveProperties ( [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FWebAPICodeGenProperty](API\Plugins\WebAPIEditor\CodeGen\Dom\FWebAPICodeGenProperty) >> & OutProperties )


description: Populates this object from the given WebAPI object.

code: void FromWebAPI ( const [UWebAPIModel](API\Plugins\WebAPIEditor\Dom\UWebAPIModel) * InSrcModel )


description: Append any include paths for this file to the given Array (not Set, to allow custom order).

code: virtual void GetIncludePaths ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutIncludePaths ) const


description: Retrieve the name. The source depends on the CodeGen object type.

code: virtual [FString](API\Runtime\Core\Containers\FString) GetName ( bool bJustName )


description: CodeGen Type.

code: virtual const [FName](API\Runtime\Core\UObject\FName) & GetTypeName()


description: Inherited baseclass.


description: CodeGen Type.

code: static const [FName](API\Runtime\Core\UObject\FName) TypeName = TEXT("Struct");


className: FWebAPICodeGenStruct

code: class FWebAPICodeGenStruct : public [FWebAPICodeGenBase](API\Plugins\WebAPIEditor\CodeGen\Dom\FWebAPICodeGenBase)

Base

description: Base class. Should be empty if none.

Properties

description: Properties within this struct.


className: EWebAPIGenerationResult

code: enum EWebAPIGenerationResult { Failed = 0, Succeeded = 1, FailedWithErrors = 2, FailedWithWarnings = 3, SucceededWithWarnings = 4, }


className: FOnNamespaceChangedDelegate

description: Encapsulates a new pseudo-namespace.

code: typedef TMulticastDelegate_OneParam< void, const [FString](API\Runtime\Core\Containers\FString) & > FOnNamespaceChangedDelegate


description: Resolves and returns an instance of the CodeGeneratorClass.

code: [TScriptInterface](API\Runtime\CoreUObject\UObject\TScriptInterface)< class [IWebAPICodeGeneratorInterface](API\Plugins\WebAPIEditor\CodeGen\IWebAPICodeGeneratorInterface) > GetGeneratorClass() const


description: Returns the specified pseudo-namespace.

code: const [FString](API\Runtime\Core\Containers\FString) & GetNamespace() const


description: When the pseudo-namespace changes.


description: Sets the specified pseudo-namespace.

code: void SetNamespace ( const [FString](API\Runtime\Core\Containers\FString) & InNamespace )


code: FWebAPICodeGeneratorSettings()


className: FWebAPICodeGeneratorSettings

description: Encapsulates settings for WebAPI code generation.

bOverrideGeneratorClass

description: Whether to override the Code Generator class specified in project settings.

bWriteResult

description: Disable to prevent the generator writing files/assets.

CodeGeneratorClass

description: The Code Generator to use.

CopyrightNotice

description: The copyright notice to apply to generated files.

GeneratedSettingsBaseClass

description: The generated settings baseclass (optional).

ModelOutputPath

description: The relative output path for generated models.

OperationOutputPath

description: The relative output path for generated operations.

TargetModule

type: FWebAPIDefiniti...

description: The C++ Unreal module determines the location of the generated files.


description: Resolves and returns the path, use instead of AbsolutePath.


className: FWebAPIDefinitionTargetModule

description: Contains information about the target module for code generation files.

AbsolutePath

description: The absolute location of the directory for this module.

Name

description: The name of the module.


description: Generate code for the given WebAPI Definition.

code: [TFuture](API\Runtime\Core\Async\TFuture)< [EWebAPIGenerationResult](API\Plugins\WebAPIEditor\CodeGen\EWebAPIGenerationResult) > Generate ( const [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [UWebAPIDefinition](API\Plugins\WebAPIEditor\UWebAPIDefinition) > & InDefinition )


description: Check to see if this generator is available for use.

code: [TFuture](API\Runtime\Core\Async\TFuture)< bool > IsAvailable()


className: IWebAPICodeGeneratorInterface

description: Interface for code generation for a given WebAPI Definition/Schema.

code: class IWebAPICodeGeneratorInterface


code: template<typename CodeGenType> bool CheckNameConflicts ( const [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [UWebAPIDefinition](API\Plugins\WebAPIEditor\UWebAPIDefinition) > & InDefinition, const [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< CodeGenType >> & InItems ) const


code: template<> bool CheckNameConflicts ( const [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [UWebAPIDefinition](API\Plugins\WebAPIEditor\UWebAPIDefinition) > & InDefinition, const [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FWebAPICodeGenFile](API\Plugins\WebAPIEditor\CodeGen\Dom\FWebAPICodeGenFile) >> & InItems ) const


code: virtual [TFuture](API\Runtime\Core\Async\TFuture)< [EWebAPIGenerationResult](API\Plugins\WebAPIEditor\CodeGen\EWebAPIGenerationResult) > Generate ( const [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [UWebAPIDefinition](API\Plugins\WebAPIEditor\UWebAPIDefinition) > & InDefinition )


description: Converts the given Enum to a CodeGen Enum object.

code: virtual [TFuture](API\Runtime\Core\Async\TFuture)< [EWebAPIGenerationResult](API\Plugins\WebAPIEditor\CodeGen\EWebAPIGenerationResult) > GenerateEnum ( const [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [UWebAPIDefinition](API\Plugins\WebAPIEditor\UWebAPIDefinition) > & InDefinition, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FWebAPICodeGenEnum](API\Plugins\WebAPIEditor\CodeGen\Dom\FWebAPICodeGenEnum) > & InEnum )


description: Converts the given Definition to a CodeGen File object.

code: virtual [TFuture](API\Runtime\Core\Async\TFuture)< [EWebAPIGenerationResult](API\Plugins\WebAPIEditor\CodeGen\EWebAPIGenerationResult) > GenerateFile ( const [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [UWebAPIDefinition](API\Plugins\WebAPIEditor\UWebAPIDefinition) > & InDefinition, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FWebAPICodeGenFile](API\Plugins\WebAPIEditor\CodeGen\Dom\FWebAPICodeGenFile) > & InFile )


description: Converts the given Model to a CodeGen Struct object.

code: virtual [TFuture](API\Runtime\Core\Async\TFuture)< [EWebAPIGenerationResult](API\Plugins\WebAPIEditor\CodeGen\EWebAPIGenerationResult) > GenerateModel ( const [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [UWebAPIDefinition](API\Plugins\WebAPIEditor\UWebAPIDefinition) > & InDefinition, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FWebAPICodeGenStruct](API\Plugins\WebAPIEditor\CodeGen\Dom\FWebAPICodeGenStruct) > & InStruct )


description: Converts the given Service to a CodeGen Operation array.

code: virtual [TFuture](API\Runtime\Core\Async\TFuture)< [EWebAPIGenerationResult](API\Plugins\WebAPIEditor\CodeGen\EWebAPIGenerationResult) > GenerateServiceOperations ( const [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [UWebAPIDefinition](API\Plugins\WebAPIEditor\UWebAPIDefinition) > & InDefinition, const [FString](API\Runtime\Core\Containers\FString) & InServiceName, const [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FWebAPICodeGenOperation](API\Plugins\WebAPIEditor\CodeGen\Dom\FWebAPICodeGenOperation) >> & InOperations )


description: Converts the given Definition to a CodeGen Settings object.

code: virtual [TFuture](API\Runtime\Core\Async\TFuture)< [EWebAPIGenerationResult](API\Plugins\WebAPIEditor\CodeGen\EWebAPIGenerationResult) > GenerateSettings ( const [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [UWebAPIDefinition](API\Plugins\WebAPIEditor\UWebAPIDefinition) > & InDefinition, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FWebAPICodeGenClass](API\Plugins\WebAPIEditor\CodeGen\Dom\FWebAPICodeGenClass) > & InSettingsClass )


code: virtual [TFuture](API\Runtime\Core\Async\TFuture)< bool > IsAvailable()


className: LogName

code: static constexpr const TCHAR * LogName = TEXT("Code Generator");


className: UWebAPICodeGeneratorBase

description: WebAPICodeGenerator base implementation. Converts WebAPI schema to code gen primitives. Use of this baseclass is optional.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract) class UWebAPICodeGeneratorBase : public [UObject](API\Runtime\CoreUObject\UObject\UObject), public [IWebAPICodeGeneratorInterface](API\Plugins\WebAPIEditor\CodeGen\IWebAPICodeGeneratorInterface)


className: UWebAPICodeGeneratorInterface

code: class UWebAPICodeGeneratorInterface : public [UInterface](API\Runtime\CoreUObject\UObject\UInterface)


className: EWebAPIModelCompositionType

code: enum EWebAPIModelCompositionType { Single, Multiple, All, }


className: EWebAPIParameterStorage

headerPath: {key}: {value}

code: enum EWebAPIParameterStorage { Path, Query, Header, Cookie, Body, }


className: EWebAPIResponseStorage

code: enum EWebAPIResponseStorage { Body, Header, }


className: EWebAPISchemaType

description: Schema type allows same name but different Schema types, ie. both a service and model with the name "Pet".

code: enum EWebAPISchemaType { Model, Service, Operation, Property, Parameter, Unspecified = 128, }


description: The name for UI display.


description: The json field name that the target API expects, rather than the UE friendly one.


description: Get the fully formatted name, with prefix.

code: [FString](API\Runtime\Core\Containers\FString) ToString ( bool bInJustName ) const


description: Get the fully formatted name as a valid member name.

code: [FString](API\Runtime\Core\Containers\FString) ToMemberName ( const [FString](API\Runtime\Core\Containers\FString) & InPrefix ) const


className: FWebAPINameInfo

description: Holds information for a name and it's alternatives.

JsonName

description: Field name as sent to and received from the external API.

description: Name without prefix or namespace, ie. "SomeParameter", not "InSomeParameter".

Prefix

description: Type Prefix, usually for parameters ("In"/"Out") or booleans "b".


description: Check if this has a valid NameInfo.

code: bool HasNameInfo() const


description: Optionally provide TypeInfo to infer a prefix, for example "b" for booleans.

code: FWebAPINameInfo ( const [FString](API\Runtime\Core\Containers\FString) & InName, const [FString](API\Runtime\Core\Containers\FString) & InJsonName, const [FWebAPITypeNameVariant](API\Plugins\WebAPIEditor\Dom\FWebAPITypeNameVariant) & InTypeInfo )


description: Check that either NameInfo is set and valid, or a NameString is non-empty.

code: bool IsValid() const


description: Get the fully formatted name as a valid member name. Optionally provide a prefix for invalid member names (ie. that start with a number).


description: Copy-assignment.

code: [FWebAPINameVariant](API\Plugins\WebAPIEditor\Dom\FWebAPINameVariant) & operator= ( const [FString](API\Runtime\Core\Containers\FString) & InStringName )


description: Retrieve the String of whichever property is valid.


code: FWebAPINameVariant ( const [FWebAPINameInfo](API\Plugins\WebAPIEditor\Dom\FWebAPINameInfo) & InNameInfo )


code: FWebAPINameVariant ( const [FString](API\Runtime\Core\Containers\FString) & InStringName )


code: FWebAPINameVariant ( const TCHAR * InStringName )


className: FWebAPINameVariant

description: Holds eitherFWebAPINameInfoorFString.

NameInfo

type: FWebAPINameInfo

description: NameInfo.

NameString

description: String.


description: Check if this has valid TypeInfo.

code: bool HasTypeInfo() const


description: Check that either TypeInfo is set and valid, or a TypeString is non-empty.


description: Copy-assignment.

code: [FWebAPITypeNameVariant](API\Plugins\WebAPIEditor\Dom\FWebAPITypeNameVariant) & operator= ( const [FString](API\Runtime\Core\Containers\FString) & InStringName )


code: FWebAPITypeNameVariant ( const [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UWebAPITypeInfo](API\Plugins\WebAPIEditor\Dom\UWebAPITypeInfo) > & InTypeName )


code: FWebAPITypeNameVariant ( const [FString](API\Runtime\Core\Containers\FString) & InStringName )


code: FWebAPITypeNameVariant ( const TCHAR * InStringName )


className: FWebAPITypeNameVariant

description: Holds eitherUWebAPITypeInfoorFString.

TypeInfo

type: TSoftObjectPtr<...

description: TypeInfo.

TypeString

description: String.


description: Appends the last generated code as text for debugging.

code: virtual void AppendCodeText ( const [FString](API\Runtime\Core\Containers\FString) & InCodeText )


description: Used for sorting in the UI.

code: virtual [FString](API\Runtime\Core\Containers\FString) GetSortKey() const


description: Sets the last generated code as text for debugging.

code: virtual void SetCodeText ( const [FString](API\Runtime\Core\Containers\FString) & InCodeText )


description: Recursively sets the namespace of this and all child objects.

code: virtual void SetNamespace ( const [FString](API\Runtime\Core\Containers\FString) & InNamespace )


code: virtual bool ToJson ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & OutJson )


description: Recursively visit each element in the schema.

code: virtual void Visit ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void([IWebAPISchemaObjectInterface](API\Plugins\WebAPIEditor\Dom\IWebAPISchemaObjectInterface) *&)> InVisitor )


className: IWebAPISchemaObjectInterface

code: class IWebAPISchemaObjectInterface


description: Creates a uniqueFNamefor TypeInfo's based on the given parameters.

code: namespace UE { namespace WebAPI { [FName](API\Runtime\Core\UObject\FName) UE::WebAPI::MakeTypeInfoName ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InOuter, const [EWebAPISchemaType](API\Plugins\WebAPIEditor\Dom\EWebAPISchemaType) & InSchemaType, const [FString](API\Runtime\Core\Containers\FString) & InName ) } }


className: UWebAPICompositeModel

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(MinimalAPI) class UWebAPICompositeModel : public [UWebAPIModelBase](API\Plugins\WebAPIEditor\Dom\UWebAPIModelBase)

CompositionType

type: EWebAPIModelCom...

description: Type of composition.

GeneratedCodeText

description: The last generated code as text for debugging.

Name

description: Name of the composition.

Types

description: Array of one or more types contained in the composition.


description: Add and return a reference to a new Enum Value.


description: Associates this model with it's own TypeInfo.

code: virtual void BindToTypeInfo()


description: Default value as a string, usually the first enum value.

code: [FString](API\Runtime\Core\Containers\FString) GetDefaultValue ( bool bQualified ) const


className: UWebAPIEnum

description: Describes a (usually) API-specific class representing an enum.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UWebAPIEnum : public [UWebAPIModelBase](API\Plugins\WebAPIEditor\Dom\UWebAPIModelBase)

bGenerate

description: Will be set based on dependent operations.

DefaultValue

type: FString

description: Current or Default Value of the Enum.

Name

description: Name of the Enum.

Type

description: The enum base type, always uint8.

Values

type: TArray<TObject...

description: Values within the Enum.


className: UWebAPIEnumValue

description: Describes a single value within a enum.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(MinimalAPI) class UWebAPIEnumValue : public [UWebAPIModelBase](API\Plugins\WebAPIEditor\Dom\UWebAPIModelBase)

Name

description: Name of the EnumValue.


description:
Generic function to validate objects during changelist validations, etc.
Returns Valid if this object has data validation rules set up for it and the data for this object is valid. Returns Invalid if it does not pass the rules. Returns NotValidated if no rules are set for this object.

code: virtual EDataValidationResult IsDataValid ( class [FDataValidationContext](API\Runtime\CoreUObject\Misc\FDataValidationContext) & Context ) const


className: UWebAPIModel

description: Describes a (usually) API-specific struct or class representing a model.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UWebAPIModel : public [UWebAPIModelBase](API\Plugins\WebAPIEditor\Dom\UWebAPIModelBase)

DefaultValue

description: Default value (optional) as a string.

description: Name of the Model.

Properties

description: Array of properties contained in this model.

Type

description: The corresponding TypeInfo for this Model.


className: UWebAPIModelBase

description: Baseclass with common properties for various Schema classes.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(MinimalAPI, Abstract) class UWebAPIModelBase : public [UObject](API\Runtime\CoreUObject\UObject\UObject), public [IWebAPISchemaObjectInterface](API\Plugins\WebAPIEditor\Dom\IWebAPISchemaObjectInterface)

bIsReadOnly

description: Bydefault all properties are read & write.

bIsRequired

description: Bydefault all properties are optional.

bUseMaximumValue

description: Whether to use Maximum value.

bUseMinimumValue

description: Whether to use Minimum value.

bUsePattern

description: Whether to use a Regex Pattern for validation.

Description

description: Describes this model.

MaximumValue

type: double

description: Maximum value. Can also indicate maximum string length.

MinimumValue

description: Minimum value. Can also indicate minimum string length.

Pattern

description: Regex Pattern to validate against.


description: Appends the last generated code as text for debugging.


className: UWebAPIOperation

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UWebAPIOperation : public [UObject](API\Runtime\CoreUObject\UObject\UObject), public [IWebAPISchemaObjectInterface](API\Plugins\WebAPIEditor\Dom\IWebAPISchemaObjectInterface)

bGenerate

description: Can be disabled to skip generation of this Operation.

bIsDeprecated

description: Flags an operation previously available as deprecated.

Description

description: Describes this operation.

Errors

description: Array of errors that can be returned.

GeneratedCodeText

description: The last generated code as text for debugging.

Name

type: FWebAPITypeName...

description: Name of the Operation.

Path

description: The operation path, relative to the base url. This can contain named template args.

Request

type: TObjectPtr<UWe...

description: Request model.

RequestContentTypes

description: List of possible content types for requests, ie. application/json

ResponseContentTypes

description: List of possible content types for responses, ie. application/json

Responses

description: Array of responses.

Service

type: TObjectPtr< cla...

description: Parent service for this operation.

Verb

description: The Http verb, ie. Get, Post, etc.


className: UWebAPIOperationError

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(MinimalAPI) class UWebAPIOperationError : public [UObject](API\Runtime\CoreUObject\UObject\UObject), public [IWebAPISchemaObjectInterface](API\Plugins\WebAPIEditor\Dom\IWebAPISchemaObjectInterface)

Code

description: Http response code.

Description

description: Describes this error, usually the error message.


description: Returns if this property is required to have it's value set by the user.

code: virtual bool IsRequired() const


description: Recursively sets the namespace of this and all child objects.


className: UWebAPIOperationParameter

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(MinimalAPI) class UWebAPIOperationParameter : public [UWebAPIProperty](API\Plugins\WebAPIEditor\Dom\UWebAPIProperty)

MediaType

description: The optional media-type, ie. "application/json".

Model

description: Optional model definition.

Storage

description: Where this parameter is stored/encoded in the request.


description: Recursively visit each element in the schema.


className: UWebAPIOperationRequest

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(MinimalAPI) class UWebAPIOperationRequest : public [UWebAPIModel](API\Plugins\WebAPIEditor\Dom\UWebAPIModel)

Parameters

description: Array of parameters contained in this request.


className: UWebAPIOperationResponse

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(MinimalAPI) class UWebAPIOperationResponse : public [UWebAPIModel](API\Plugins\WebAPIEditor\Dom\UWebAPIModel)

Code

description: Http response code.

Message

description: Optional message based on the response status or result.

Storage

description: Where this parameter is stored/encoded in the response.


description: Sets the last generated code as text for debugging.

code: virtual void SetCodeText ( const [FString](API\Runtime\Core\Containers\FString) & InCodeText )


className: UWebAPIParameter

description: A re-usable Parameter.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UWebAPIParameter : public [UWebAPIModel](API\Plugins\WebAPIEditor\Dom\UWebAPIModel)

bIsArray

description: If the property is an array of Type.

Model

description: Optional model definition.

Property

description: Single value property that this Parameter wraps.


description: Default value as a string, if applicable.


className: UWebAPIProperty

description: Describes a single property within a model.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UWebAPIProperty : public [UWebAPIModelBase](API\Plugins\WebAPIEditor\Dom\UWebAPIModelBase)

bIsArray

description: If the property is an array of Type.

bIsMixin

description: When the properties inside of this should be treated as though they're directly in the parent.

DefaultValue

description: Default value (optional) as a string.

DefaultValues

description: Array of values if needed, ie. enum

Name

description: Name of the Property.

Type

description: Type of the Property.


description: Add and return a reference to a new Enum.

code: [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< class [UWebAPIEnum](API\Plugins\WebAPIEditor\Dom\UWebAPIEnum) > AddEnum ( const [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UWebAPITypeInfo](API\Plugins\WebAPIEditor\Dom\UWebAPITypeInfo) > & InTypeInfo )


description: Add and return a reference to a new Model

code: template<typename ModelType> [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< ModelType > AddModel ( const [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UWebAPITypeInfo](API\Plugins\WebAPIEditor\Dom\UWebAPITypeInfo) > & InTypeInfo )


description: Add and return a reference to a new Parameter. These can be referenced by operations rather than defining them inline.

code: [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< class [UWebAPIParameter](API\Plugins\WebAPIEditor\Dom\UWebAPIParameter) > AddParameter ( const [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UWebAPITypeInfo](API\Plugins\WebAPIEditor\Dom\UWebAPITypeInfo) > & InTypeInfo )


description: Resets the Schema to defaults.

code: void Clear()


code: const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FWebAPIMessageLog](API\Plugins\WebAPIEditor\FWebAPIMessageLog) > & GetMessageLog() const


description: Find/Add and return a reference to an existing/new Service.

code: [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< class [UWebAPIService](API\Plugins\WebAPIEditor\Dom\UWebAPIService) > GetOrMakeService ( const [FString](API\Runtime\Core\Containers\FString) & InName )


description:
Generic function to validate objects during changelist validations, etc.
Returns Valid if this object has data validation rules set up for it and the data for this object is valid. Returns Invalid if it does not pass the rules. Returns NotValidated if no rules are set for this object.

code: virtual EDataValidationResult IsDataValid ( class [FDataValidationContext](API\Runtime\CoreUObject\Misc\FDataValidationContext) & Context ) const


className: LogName

code: static constexpr const TCHAR * LogName = TEXT("WebAPI Schema");


className: UWebAPISchema

description: Describes the intermediate structure from which to generate code.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType) class UWebAPISchema : public [UObject](API\Runtime\CoreUObject\UObject\UObject), public [IWebAPISchemaObjectInterface](API\Plugins\WebAPIEditor\Dom\IWebAPISchemaObjectInterface)

APIName

description: Name of the API.

BaseUrl

description: The Url path relative to the host address, ie. "/V1".

DateTimeFormat

description: The date-time format this API uses to encode/decode from string.

Host

description: The default host address to access this API.

Models

description: Models can be a combination of classes, structs and enums used by this API.

Services

type: TMap<FString, ...

description: Each service contains one or more operations.

TypeRegistry

description: Contains all referenced types for this API.

URISchemes

description: Uniform Resource Identifier schemes (ie. https, http).

UserAgent

description: The UserAgent to encode in Http request headers.

Version

description: The API version can be any arbitrary string that is useful if there are several versions.


className: UWebAPISchemaObjectInterface

code: class UWebAPISchemaObjectInterface : public [UInterface](API\Runtime\CoreUObject\UObject\UInterface)


description: Recursively visit each element in the schema.

code: virtual void Visit ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void([IWebAPISchemaObjectInterface](API\Plugins\WebAPIEditor\Dom\IWebAPISchemaObjectInterface) *&)> InVisitor )


className: UWebAPIService

description: A service generally contains a sub-section of the API containing operations related to a particular subject.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(MinimalAPI) class UWebAPIService : public [UWebAPIModelBase](API\Plugins\WebAPIEditor\Dom\UWebAPIModelBase)

bGenerate

type: bool

description: Can be disabled to skip generation of this Service and it's operations.

Name

description: Name of the Service.

Operations

description: Operations contained within the service.


description: Recursively sets the namespace of this and all child objects.

code: virtual void SetNamespace ( const [FString](API\Runtime\Core\Containers\FString) & InNamespace )


description: Finds the TypeInfo with the give name.

code: const [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UWebAPITypeInfo](API\Plugins\WebAPIEditor\Dom\UWebAPITypeInfo) > * FindBuiltinType ( const [FString](API\Runtime\Core\Containers\FString) & InName )


description: Used to retrieve PinColor.

code: static const [UGraphEditorSettings](API\Editor\GraphEditor\UGraphEditorSettings) * GetGraphEditorSettings()


description: Find or create the TypeInfo for the given built-in type.

code: const [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UWebAPITypeInfo](API\Plugins\WebAPIEditor\Dom\UWebAPITypeInfo) > & GetOrMakeBuiltinType ( const [FString](API\Runtime\Core\Containers\FString) & InName, const [FString](API\Runtime\Core\Containers\FString) & InJsonName, const [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) & InPinColor, const [FString](API\Runtime\Core\Containers\FString) & InPrefix, [FName](API\Runtime\Core\UObject\FName) InDeclarationType )


description: Initializes and registers the built-in types.

code: virtual void Initialize ( [FSubsystemCollectionBase](API\Runtime\Engine\Subsystems\FSubsystemCollectionBase) & Collection )


className: ToFromJsonObject

description: For JsonObjectWrapper, manipulate the JsonObject directly (also JsonObjectToString, JsonObjectFromString).

code: static const [FName](API\Runtime\Core\UObject\FName) ToFromJsonObject = TEXT("ToFromJsonObject");


className: ToFromJsonType

description: For JsonType, when there is a ToJson/FromJson overload for the given value.

code: static const [FName](API\Runtime\Core\UObject\FName) ToFromJsonType = TEXT("ToFromHandler");


className: UnnamedTypeName

description: The name of a TypeInfo when it's unnamed/unknown.

code: static constexpr const TCHAR * UnnamedTypeName = TEXT("Unnamed");


className: UWebAPIStaticTypeRegistry

description: Holds Type information for built-in types.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UWebAPIStaticTypeRegistry : public [UEngineSubsystem](API\Runtime\Engine\Subsystems\UEngineSubsystem)

Enum

description: Unnamed enum.

JsonObject

description: Json object.

Nullptr

description: List of common built-in types, static for easy comparisons, etc.

Object

description: Unnamed object.

WebAPIMessageResponse

description: WebAPI Message Response object.


description: Duplicate this TypeInfo to the provided TypeRegistry.

code: [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UWebAPITypeInfo](API\Plugins\WebAPIEditor\Dom\UWebAPITypeInfo) > Duplicate ( const [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< class [UWebAPITypeRegistry](API\Plugins\WebAPIEditor\Dom\UWebAPITypeRegistry) > & InTypeRegistry ) const


description: The name for UI display.


description: Default value as a string.

code: [FString](API\Runtime\Core\Containers\FString) GetDefaultValue ( bool bQualified ) const


description: The json field name that the target API expects, rather than the UE friendly one.


description:
Generic function to validate objects during changelist validations, etc.
Returns Valid if this object has data validation rules set up for it and the data for this object is valid. Returns Invalid if it does not pass the rules. Returns NotValidated if no rules are set for this object.

code: virtual EDataValidationResult IsDataValid ( class [FDataValidationContext](API\Runtime\CoreUObject\Misc\FDataValidationContext) & Context ) const


description: Set's the name and updates the underlying object id.

code: void SetName ( const [FString](API\Runtime\Core\Containers\FString) & InName )


description: Set's this type as nested, using the provided Type as ContainingType.

code: void SetNested ( const [FWebAPITypeNameVariant](API\Plugins\WebAPIEditor\Dom\FWebAPITypeNameVariant) & InNester )


description: Get the fully formatted name as a valid member name. Optionally provide a prefix for invalid member names (ie. that start with a number).

code: [FString](API\Runtime\Core\Containers\FString) ToMemberName ( const [FString](API\Runtime\Core\Containers\FString) & InPrefix ) const


description: Get the fully formatted name, with prefix and namespace.

code: [FString](API\Runtime\Core\Containers\FString) ToString ( bool bInJustName ) const


className: UWebAPITypeInfo

description: Holds information for an existing or pending type.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType) class UWebAPITypeInfo : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

bIsBuiltinType

description: If this is false, the type is to be generated and should have a namespace.

bIsNested

description: Flag specifying whether this type is used exclusively by a parent type (isn't shared).

ContainingType

description: When the type is nested, this specifies who "owns" it.

DebugString

description: Misc info for debug.

DeclarationType

type: FName

description: Declaration type, ie. struct, enum.

DefaultValue

description: Default value as a string, if applicable.

DisplayName

description: Optional display name, different to the actual name, ie. "JsonObject" vs. "JsonObjectWrapper".

IncludePaths

type: TSet<FString>

description: Relative include paths required when referencing this type.

JsonName

description: Field name as sent to and received from the external API.

JsonPropertyToSerialize

description: Optional sub-property to serialize, instead of the object itself.

JsonType

description: Json type. Should correspond with values in EJson.

Model

description: Associated model, if any.

Modules

description: Module dependencies for this type.

Name

description: Type Name without prefix or namespace, ie. "Vector", not "FVector".

Namespace

description: Type Namespace, can be empty for built-in types.

PinColor

type: FSlateColor

description: Color for UI.

Prefix

description: Type Prefix, usually "F", "U", "A", or "E".

PrintFormatExpression

description: Optional tokenized string expression to get the value for printf, ie. ToString({Property})

PrintFormatSpecifier

description: Optional specifier for printf, ie. "s", "d".

SchemaType

type: EWebAPISchemaTy...

description: SchemaType to discern between ie. a Service and a Model with the same name.

Suffix

description: Optional suffix, ie. "Parameter", "Item", etc.


description: Checks for any unnamed types, logs a message and returns false if one or more unnamed still exist.

code: bool CheckAllNamed() const


description: Checks for and outputs any unnamed types, logs a message and returns false if one or more unnamed still exist.

code: bool CheckAllNamed ( [TArray](API\Runtime\Core\Containers\TArray)< [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UWebAPITypeInfo](API\Plugins\WebAPIEditor\Dom\UWebAPITypeInfo) >> & OutUnnamedTypes ) const


description: Clears all stored type information.

code: void Clear()


description: Find and return the TypeInfo for the given SchemaType and Name. Returns nullptr if not found.

code: const [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UWebAPITypeInfo](API\Plugins\WebAPIEditor\Dom\UWebAPITypeInfo) > * FindGeneratedType ( const [EWebAPISchemaType](API\Plugins\WebAPIEditor\Dom\EWebAPISchemaType) & InSchemaType, const [FString](API\Runtime\Core\Containers\FString) & InName )


description: Returns the array containing all registered TypeInfo's for generation.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UWebAPITypeInfo](API\Plugins\WebAPIEditor\Dom\UWebAPITypeInfo) > > & GetGeneratedTypes() const


description: Returns the mutable array containing all registered TypeInfo's for generation.

code: [TArray](API\Runtime\Core\Containers\TArray)< [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UWebAPITypeInfo](API\Plugins\WebAPIEditor\Dom\UWebAPITypeInfo) > > & GetMutableGeneratedTypes()


code: [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UWebAPITypeInfo](API\Plugins\WebAPIEditor\Dom\UWebAPITypeInfo) > GetOrMakeGeneratedType ( const [EWebAPISchemaType](API\Plugins\WebAPIEditor\Dom\EWebAPISchemaType) & InSchemaType, const [FString](API\Runtime\Core\Containers\FString) & InName, const [FString](API\Runtime\Core\Containers\FString) & InJsonName, const [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< const [UWebAPITypeInfo](API\Plugins\WebAPIEditor\Dom\UWebAPITypeInfo) > & InTemplateTypeInfo )


description: Providing the schema type allows for a Model and Service (for example) to have the same name but not be considered the same type.

code: [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UWebAPITypeInfo](API\Plugins\WebAPIEditor\Dom\UWebAPITypeInfo) > GetOrMakeGeneratedType ( const [EWebAPISchemaType](API\Plugins\WebAPIEditor\Dom\EWebAPISchemaType) & InSchemaType, const [FString](API\Runtime\Core\Containers\FString) & InName, const [FString](API\Runtime\Core\Containers\FString) & InJsonName, const [FString](API\Runtime\Core\Containers\FString) & InPrefix, [FName](API\Runtime\Core\UObject\FName) InDeclarationType )


description: For use by the WebAPI Message Log.

code: static constexpr const TCHAR * LogName = TEXT("WebAPI TypeRegistry");


className: UWebAPITypeRegistry

description: Holds Type information for a given Schema.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UWebAPITypeRegistry : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


className: EVerbosityLevel

description: Log verbosity level

code: enum EVerbosityLevel { Log, Warning, Error, Log, Warning, Error, }


className: EWebAPIConversionResult

code: enum EWebAPIConversionResult { Failed = 0, Succeeded = 1, FailedWithErrors = 2, FailedWithWarnings = 3, }


description: Check if the factory can import the given file (and it's contents).

code: virtual bool CanImportWebAPI ( const [FString](API\Runtime\Core\Containers\FString) & InFileName, const [FString](API\Runtime\Core\Containers\FString) & InFileContents )


description:
Check to see if the handler is capable of reimporting the object
true if this handler is capable of reimporting the provided object

code: virtual bool CanReimport ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Obj, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutFilenames )


description:
Whether the specified file can be imported by this factory.
true if the file is supported, false otherwise.

code: virtual bool FactoryCanImport ( const [FString](API\Runtime\Core\Containers\FString) & Filename )


description:
The default implementation of this method will load the contents of the entire file into a byte buffer and call FactoryCreateBinary. User defined factories may override this behavior to process the provided file name on their own.
The new object.

code: virtual [UObject](API\Runtime\CoreUObject\UObject\UObject) * FactoryCreateFile ( [UClass](API\Runtime\CoreUObject\UObject\UClass) * InClass, [UObject](API\Runtime\CoreUObject\UObject\UObject) * InParent, [FName](API\Runtime\Core\UObject\FName) InName, EObjectFlags Flags, const [FString](API\Runtime\Core\Containers\FString) & Filename, const TCHAR * Parms, [FFeedbackContext](API\Runtime\Core\Misc\FFeedbackContext) * Warn, bool & bOutOperationCanceled )


description: Perform the import or re-import.

code: virtual [TFuture](API\Runtime\Core\Async\TFuture)< bool > ImportWebAPI ( [UWebAPIDefinition](API\Plugins\WebAPIEditor\UWebAPIDefinition) * InDefinition, const [FString](API\Runtime\Core\Containers\FString) & InFileName, const [FString](API\Runtime\Core\Containers\FString) & InFileContents )


description: Checks that the provided file contains a valid file extension.

code: virtual bool IsValidFile ( const [FString](API\Runtime\Core\Containers\FString) & InFilename ) const


description: Checks that the provided file extension (not the whole file name or path!) is valid for this factory.

code: virtual bool IsValidFileExtension ( const [FString](API\Runtime\Core\Containers\FString) & InFileExtension ) const


code: static constexpr const TCHAR * LogName = TEXT("WebAPI Definition Factory");


description: Called after a successful import.

code: virtual [TFuture](API\Runtime\Core\Async\TFuture)< void > PostImportWebAPI ( [UWebAPIDefinition](API\Plugins\WebAPIEditor\UWebAPIDefinition) * InDefinition )


description: Could be on-disk or URL.

code: [FString](API\Runtime\Core\Containers\FString) ReadFileContents ( const [FString](API\Runtime\Core\Containers\FString) & InFileName ) const


description: Attempt to reimport the specified object from its sourceEReimportResult::Succeededif this handler was able to handle reimporting the provided object,EReimportResult::Failedif this handler was unable to handle reimporting the provided object orEReimportResult::Cancelledif the handler was cancelled part-way through re-importing the provided object.

code: virtual [EReimportResult::Type](API\Editor\UnrealEd\EReimportResult__Type) Reimport ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Obj )


description: Sets the reimport path(s) for the specified object

code: virtual void SetReimportPaths ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Obj, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & NewReimportPaths )


className: UWebAPIDefinitionFactory

description: Base Factory for WebAPIDefinition.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, BlueprintType) class UWebAPIDefinitionFactory : public [UFactory](API\Editor\UnrealEd\Factories\UFactory), public [FReimportHandler](API\Editor\UnrealEd\FReimportHandler)


className: FOnWebAPIProvidersChanged

code: typedef TMulticastDelegate_NoParams< void > FOnWebAPIProvidersChanged


code: template<typename ValueType> bool operator() ( ValueType & OutValue )


code: FVariantObjectVisitor ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & InJsonObject, const [FString](API\Runtime\Core\Containers\FString) & InFieldName )


className: FVariantObjectVisitor

code: struct FVariantObjectVisitor

FieldName

type: constFString

JsonObject

type: constTSharedPt...


code: FVariantValueVisitor ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonValue](API\Runtime\Json\Dom\FJsonValue) > & InJsonValue )


className: FVariantValueVisitor

description: Variant.

code: struct FVariantValueVisitor


description: Get the singleton instance.

code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FWebAPIEditorUtilities](API\Plugins\WebAPIEditor\FWebAPIEditorUtilities) > Get()


description: Get all required headers to reference the provided class.

code: bool GetHeadersForClass ( const [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [UObject](API\Runtime\CoreUObject\UObject\UObject) > & InClass, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutHeaders )


description: Get all required modules to reference the provided class.

code: bool GetModulesForClass ( const [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [UObject](API\Runtime\CoreUObject\UObject\UObject) > & InClass, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutModules )


className: FWebAPIEditorUtilities

code: class FWebAPIEditorUtilities


description: Removes all messages from log.

code: void ClearLog() const


description: Log listing interface.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMessageLogListing](API\Developer\MessageLog\IMessageLogListing) > GetMessageLogListing() const


description: Log an information message

code: void LogInfo ( const [FText](API\Runtime\Core\Internationalization\FText) & InMessage, const [FString](API\Runtime\Core\Containers\FString) & InCallerName )


description: Logs an error message

code: void LogError ( const [FText](API\Runtime\Core\Internationalization\FText) & InMessage, const [FString](API\Runtime\Core\Containers\FString) & InCallerName )


description: Logs a warning message

code: void LogWarning ( const [FText](API\Runtime\Core\Internationalization\FText) & InMessage, const [FString](API\Runtime\Core\Containers\FString) & InCallerName )


className: FWebAPIMessageLog

description: WebAPI Message Log, unique to each definition (when editing).

code: class FWebAPIMessageLog : public [TSharedFromThis< FWebAPIMessageLog >](API\Runtime\Core\Templates\TSharedFromThis)


description: Return the default name given to array properties.

code: const [FString](API\Runtime\Core\Containers\FString) & GetDefaultArrayPropertyName()


description: Return the default name given to (single item) properties.

code: const [FString](API\Runtime\Core\Containers\FString) & GetDefaultPropertyName()


description: Return the name of an "unset" value for a generated enum. This allows optional enums that aren't otherwise supported as FProperties.

code: const [FString](API\Runtime\Core\Containers\FString) & GetUnsetEnumValueName()


description: Makes a unique TypeName based on the provided Parameter name.

code: [FString](API\Runtime\Core\Containers\FString) MakeParameterTypeName ( const [FWebAPINameVariant](API\Plugins\WebAPIEditor\Dom\FWebAPINameVariant) & InParameterName ) const


description: Makes a unique TypeName based on the provided Model and Property names.

code: [FString](API\Runtime\Core\Containers\FString) MakeNestedPropertyTypeName ( const [FWebAPITypeNameVariant](API\Plugins\WebAPIEditor\Dom\FWebAPITypeNameVariant) & InModelName, const [FWebAPINameVariant](API\Plugins\WebAPIEditor\Dom\FWebAPINameVariant) & InPropertyName ) const


description: Makes a unique TypeName based on the provided Service and Operations names.

code: [FName](API\Runtime\Core\UObject\FName) MakeOperationObjectName ( const [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UWebAPIService](API\Plugins\WebAPIEditor\Dom\UWebAPIService) > & InService, const [FWebAPITypeNameVariant](API\Plugins\WebAPIEditor\Dom\FWebAPITypeNameVariant) & InOperationName ) const


description: Makes a unique TypeName based on the provided Operation name.

code: [FString](API\Runtime\Core\Containers\FString) MakeRequestTypeName ( const [FWebAPITypeNameVariant](API\Plugins\WebAPIEditor\Dom\FWebAPITypeNameVariant) & InOperationName ) const


description: Makes a unique TypeName based on the provided Operation name and response code.

code: [FString](API\Runtime\Core\Containers\FString) MakeResponseTypeName ( const [FWebAPITypeNameVariant](API\Plugins\WebAPIEditor\Dom\FWebAPITypeNameVariant) & InOperationName, const uint32 & InResponseCode ) const


description: Strips the provided string of invalid characters for a member name. Optionally provide a prefix for invalid member names (ie. that start with a number).

code: [FString](API\Runtime\Core\Containers\FString) MakeValidMemberName ( const [FWebAPINameVariant](API\Plugins\WebAPIEditor\Dom\FWebAPINameVariant) & InString, const [FString](API\Runtime\Core\Containers\FString) & InPrefix ) const


description: Returns a pluralized version of the provided string. Currently only works for english words.

code: [FString](API\Runtime\Core\Containers\FString) Pluralize ( const [FString](API\Runtime\Core\Containers\FString) & InString ) const


description: Returns a singularized version of the provided plural string. Currently only works for english words.

code: [FString](API\Runtime\Core\Containers\FString) Singularize ( const [FString](API\Runtime\Core\Containers\FString) & InString ) const


description: Converts the given string to it's initials.

code: [FString](API\Runtime\Core\Containers\FString) ToInitials ( const [FWebAPINameVariant](API\Plugins\WebAPIEditor\Dom\FWebAPINameVariant) & InString ) const


description: Converts the given string to Pascal Case (aka. Upper Camel Case).

code: [FString](API\Runtime\Core\Containers\FString) ToPascalCase ( const [FWebAPINameVariant](API\Plugins\WebAPIEditor\Dom\FWebAPINameVariant) & InString ) const


description: Get the singleton instance.

code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FWebAPIStringUtilities](API\Plugins\WebAPIEditor\FWebAPIStringUtilities) > Get()


className: FWebAPIProviderSettings

description: Encapsulates settings for WebAPI providers.

bEnableArbitraryJsonPayloads

description: Enable this option to allow the user to supply arbitrary json data to any request without parameters.


description: Converts the input string to its initials.

code: [FString](API\Runtime\Core\Containers\FString) ToInitials ( FStringView InString )


description: Makes the input string valid for use as a member name, ie. no reserved characters. Provide an optional prefix to apply to invalid names (ie. start with a number).

code: [FString](API\Runtime\Core\Containers\FString) MakeValidMemberName ( FStringView InString, const [FString](API\Runtime\Core\Containers\FString) & InPrefix ) const


description: Converts the input string to PascalCase. The result may still contain characters illegal for a member name.

code: [FString](API\Runtime\Core\Containers\FString) ToPascalCase ( FStringView InString )


className: FWebAPIStringUtilities

code: class FWebAPIStringUtilities

BreakIterator

type: TSharedPtr<IBr...


description: Gets the validity of the template string.

code: bool IsValid()


description: Gets the validity of the template string for the given named arguments.

code: bool IsValid ( const FStringFormatNamedArguments & InArgs )


code: [FString](API\Runtime\Core\Containers\FString) PopulateTemplate ( const FStringFormatNamedArguments & InArgs )


code: FWebAPITemplateString ( [FString](API\Runtime\Core\Containers\FString) && InString )


className: FWebAPITemplateString


description: Adds and registers a WebAPI code generator.

code: bool AddCodeGenerator ( [FName](API\Runtime\Core\UObject\FName) InCodeGeneratorName, const [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [UObject](API\Runtime\CoreUObject\UObject\UObject) > & InCodeGenerator )


description: Adds and registers a WebAPI provider.

code: bool AddProvider ( [FName](API\Runtime\Core\UObject\FName) InProviderName, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IWebAPIProviderInterface](API\Plugins\WebAPIEditor\IWebAPIProviderInterface) > InProvider )


description:
Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed

code: static [IWebAPIEditorModuleInterface](API\Plugins\WebAPIEditor\IWebAPIEditorModuleInterface) & Get()


className: FOnRegisterLayoutExtensions

code: class FOnRegisterLayoutExtensions : public TBaseMulticastDelegate_OneParam< void, FLayoutExtender & >


description: Retrieve a registered code generator by its name.

code: [TScriptInterface](API\Runtime\CoreUObject\UObject\TScriptInterface)< [IWebAPICodeGeneratorInterface](API\Plugins\WebAPIEditor\CodeGen\IWebAPICodeGeneratorInterface) > GetCodeGenerator ( [FName](API\Runtime\Core\UObject\FName) InCodeGeneratorName )


description: Retrieve all registered code generators.

code: bool GetCodeGenerators ( [TArray](API\Runtime\Core\Containers\TArray)< [TScriptInterface](API\Runtime\CoreUObject\UObject\TScriptInterface)< [IWebAPICodeGeneratorInterface](API\Plugins\WebAPIEditor\CodeGen\IWebAPICodeGeneratorInterface) >> & OutCodeGenerators )


description: Retrieve a registered provider by its name.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IWebAPIProviderInterface](API\Plugins\WebAPIEditor\IWebAPIProviderInterface) > GetProvider ( [FName](API\Runtime\Core\UObject\FName) InProviderName )


description: Retrieve all registered providers.

code: bool GetProviders ( [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IWebAPIProviderInterface](API\Plugins\WebAPIEditor\IWebAPIProviderInterface) >> & OutProviders )


description: Returns the static type registry to retrieve metadata for built-in types.

code: [UWebAPIStaticTypeRegistry](API\Plugins\WebAPIEditor\Dom\UWebAPIStaticTypeRegistry) * GetStaticTypeRegistry() const


description: Whenever a Provider is added or removed.


description: Removes a WebAPI code generator.

code: void RemoveCodeGenerator ( [FName](API\Runtime\Core\UObject\FName) InCodeGeneratorName )


description: Removes a WebAPI provider.

code: void RemoveProvider ( [FName](API\Runtime\Core\UObject\FName) InProviderName )


className: IWebAPIEditorModuleInterface

code: class IWebAPIEditorModuleInterface : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface), public [IHasMenuExtensibility](API\Editor\UnrealEd\Toolkits\IHasMenuExtensibility), public [IHasToolBarExtensibility](API\Editor\UnrealEd\Toolkits\IHasToolBarExtensibility)


description: Convert and modify the WebAPISchema for the given Definition. Returns true if successful.

code: [TFuture](API\Runtime\Core\Async\TFuture)< [EWebAPIConversionResult](API\Plugins\WebAPIEditor\EWebAPIConversionResult) > ConvertToWebAPISchema ( const [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [UWebAPIDefinition](API\Plugins\WebAPIEditor\UWebAPIDefinition) > & InDefinition )


code: virtual ~IWebAPIProviderInterface()


className: IWebAPIProviderInterface

description: Interface for a provider of a WebAPI Schema

code: class IWebAPIProviderInterface : public [TSharedFromThis< IWebAPIProviderInterface >](API\Runtime\Core\Templates\TSharedFromThis)


className: TIsStringLike

description: String-like value types.

code: template<typename ValueType, typename Enable> struct TIsStringLike


className: ElementType

code: typedef ObjectType ElementType


description: Returns the object referenced by this Json Reference, creating it if it doesn't exist.

code: ObjectType * Get()


description: Returns the object referenced by this Json Reference, or nullptr if it doesn't exist.

code: ObjectType * Get() const


code: const [FString](API\Runtime\Core\Containers\FString) & GetPath() const


description: Returns true if there were one or more segments.

code: bool GetPathSegments ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutSegments ) const


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< ObjectType > GetShared() const


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< ObjectType > GetShared()


description: Checks if the underlying object has been set.

code: bool IsSet() const


description: Checks if the object is valid, or it's pending reference resolution.

code: bool IsValid() const


className: Mode

code: static constexpr ESPMode Mode = ESPMode::ThreadSafe;


description: Pointer to the underlying object.

code: ObjectType * operator->() const


className: TJsonReference::operator bool

description: Checks to see if this is actually pointing to an object.

code: operator bool() const


description: Dereferences the object

code: ObjectType & operator*() const


description: Sets the object path and flags it as a pending reference (to be resolved later).

code: void ResolveDeferred ( const [FString](API\Runtime\Core\Containers\FString) & InJsonPath )


description: Set's the object if it's not already set.

code: bool Set ( ObjectType && InObject )


code: bool Set ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< ObjectType > && InObject )


code: bool Set ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< ObjectType > & InObject )


description: Attempts to resolve the reference, returns true if successful or already set.

code: bool TryResolve ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & InRootObject, const [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< ObjectType([TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > &)> & InSetter )


description: Constructs an empty Json Reference.

code: TJsonReference()


className: TJsonReference

description: Contains either an object constructed in place, or a reference to an object declared elsewhere.

code: template<class ObjectType> class TJsonReference

bHasPendingResolve

description: Flag indicating this is a reference but not yet resolved.

Object

type: TSharedPtr< Obj...

description: Underling object pointer.

Path

description: The specified path to the actual object definition.


description: Numeric.

code: namespace UE { namespace Json { template<typename ValueType> constexpr [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< [TypeTraits::TIsNumeric_V](API\Plugins\WebAPIEditor\TIsNumeric_V)< ValueType >, void >::Type UE::Json::As ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonValue](API\Runtime\Json\Dom\FJsonValue) > & InJsonValue, ValueType & OutValue ) } }


description: String.

code: namespace UE { namespace Json { template<typename ValueType> constexpr [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< [TypeTraits::TIsStringLike](API\Plugins\WebAPIEditor\TIsStringLike)< ValueType >::Value, void >::Type UE::Json::As ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonValue](API\Runtime\Json\Dom\FJsonValue) > & InJsonValue, ValueType & OutValue ) } }


description: Bool.

code: namespace UE { namespace Json { template<typename ValueType> constexpr [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< std::is_same_v< ValueType, bool >, void >::Type UE::Json::As ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonValue](API\Runtime\Json\Dom\FJsonValue) > & InJsonValue, ValueType & OutValue ) } }


code: namespace UE { namespace Json { template<typename ValueType> constexpr [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< [TypeTraits::TIsNumeric_V](API\Plugins\WebAPIEditor\TIsNumeric_V)< ValueType >, bool >::Type UE::Json::TryGet ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonValue](API\Runtime\Json\Dom\FJsonValue) > & InJsonValue, ValueType & OutValue ) } }


description: TJsonReference.

code: namespace UE { namespace Json { template<typename ValueType> bool UE::Json::TryGet ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonValue](API\Runtime\Json\Dom\FJsonValue) > & InJsonValue, [TJsonReference](API\Plugins\WebAPIEditor\TJsonReference)< ValueType > & OutValue ) } }


description: String.

code: namespace UE { namespace Json { template<typename ValueType> [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< std::is_same_v< ValueType, [TJsonReference](API\Plugins\WebAPIEditor\TJsonReference)< typename ValueType::ElementType > >, bool >::Type UE::Json::TryGet ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonValue](API\Runtime\Json\Dom\FJsonValue) > & InJsonValue, ValueType & OutValue ) } }


description: String.

code: namespace UE { namespace Json { template<typename ValueType> [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< !std::is_same_v< ValueType, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< typename ValueType::ElementType > > &&!std::is_same_v< ValueType, [TJsonReference](API\Plugins\WebAPIEditor\TJsonReference)< typename ValueType::ElementType > > &&![TIsTMap](API\Runtime\Core\Containers\TIsTMap)< ValueType >::Value &&!TIsTArray_V< ValueType > &&![TypeTraits::TIsStringLike](API\Plugins\WebAPIEditor\TIsStringLike)< ValueType >::Value &&![TIsPODType](API\Runtime\Core\Math\TIsPODType)< ValueType >::Value &&![TypeTraits::THasFromJson_V](API\Plugins\WebAPIEditor\THasFromJson_V)< ValueType >, bool >::Type UE::Json::TryGet ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonValue](API\Runtime\Json\Dom\FJsonValue) > & InJsonValue, ValueType & OutValue ) } }


description: SharedPtr.

code: namespace UE { namespace Json { template<typename ValueType> bool UE::Json::TryGet ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonValue](API\Runtime\Json\Dom\FJsonValue) > & InJsonValue, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< ValueType > & OutValue ) } }


description: String.

code: namespace UE { namespace Json { template<typename ValueType> [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< std::is_same_v< ValueType, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< typename ValueType::ElementType > >, bool >::Type UE::Json::TryGet ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonValue](API\Runtime\Json\Dom\FJsonValue) > & InJsonValue, ValueType & OutValue ) } }


description: SharedRef.

code: namespace UE { namespace Json { template<typename ValueType> bool UE::Json::TryGet ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonValue](API\Runtime\Json\Dom\FJsonValue) > & InJsonValue, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< ValueType > & OutValue ) } }


description: Optional.

code: namespace UE { namespace Json { template<typename ValueType> constexpr [TEnableIf](API\Runtime\Core\Templates\TEnableIf)<![TIsEnumClass](API\Runtime\Core\Templates\TIsEnumClass)< ValueType >::Value, bool >::Type UE::Json::TryGet ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonValue](API\Runtime\Json\Dom\FJsonValue) > & InJsonValue, [TOptional](API\Runtime\Core\IO\TOptional)< ValueType > & OutValue ) } }


description: Optional SharedRef.

code: namespace UE { namespace Json { template<typename ValueType> bool UE::Json::TryGet ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonValue](API\Runtime\Json\Dom\FJsonValue) > & InJsonValue, [TOptional](API\Runtime\Core\IO\TOptional)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< ValueType >> & OutValue ) } }


description: Optional UniqueObj.

code: namespace UE { namespace Json { template<typename ValueType> bool UE::Json::TryGet ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonValue](API\Runtime\Json\Dom\FJsonValue) > & InJsonValue, [TOptional](API\Runtime\Core\IO\TOptional)< [TUniqueObj](API\Runtime\Core\Templates\TUniqueObj)< ValueType >> & OutValue ) } }


description: String.

code: namespace UE { namespace Json { template<typename ValueType, typename> bool UE::Json::TryGet ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonValue](API\Runtime\Json\Dom\FJsonValue) > & InJsonValue, ValueType & OutValue ) } }


description: Enum.

code: namespace UE { namespace Json { template<typename EnumType> [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< [TIsEnumClass](API\Runtime\Core\Templates\TIsEnumClass)< EnumType >::Value, bool >::Type UE::Json::TryGet ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonValue](API\Runtime\Json\Dom\FJsonValue) > & InJsonValue, EnumType & OutValue, const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), EnumType > & InNameToValue ) } }


description: Optional Enum.

code: namespace UE { namespace Json { template<typename EnumType> constexpr [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< [TIsEnumClass](API\Runtime\Core\Templates\TIsEnumClass)< EnumType >::Value, bool >::Type UE::Json::TryGet ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonValue](API\Runtime\Json\Dom\FJsonValue) > & InJsonValue, [TOptional](API\Runtime\Core\IO\TOptional)< EnumType > & OutValue, const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), EnumType > & InNameToValue ) } }


description: String.

code: namespace UE { namespace Json { template<typename ValueType> constexpr [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< std::is_same_v< ValueType, bool >, bool >::Type UE::Json::TryGet ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonValue](API\Runtime\Json\Dom\FJsonValue) > & InJsonValue, ValueType & OutValue ) } }


description: Array.

code: namespace UE { namespace Json { template<typename ContainerType> [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< TIsTArray_V< ContainerType >, bool >::Type UE::Json::TryGet ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonValue](API\Runtime\Json\Dom\FJsonValue) > & InJsonValue, ContainerType & OutValues ) } }


description: Map.

code: namespace UE { namespace Json { template<typename KeyType, typename ValueType> [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< [TypeTraits::TIsStringLike](API\Plugins\WebAPIEditor\TIsStringLike)< KeyType >::Value, bool >::Type UE::Json::TryGet ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonValue](API\Runtime\Json\Dom\FJsonValue) > & InJsonValue, [TMap](API\Runtime\Core\Containers\TMap)< KeyType, ValueType > & OutValues ) } }


code: namespace UE { namespace Json { template<typename MapType> [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< [TIsTMap](API\Runtime\Core\Containers\TIsTMap)< MapType >::Value, bool >::Type UE::Json::TryGet ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonValue](API\Runtime\Json\Dom\FJsonValue) > & InJsonValue, MapType & OutValues ) } }


description: String.

code: namespace UE { namespace Json { template<typename ValueType> constexpr [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< [TypeTraits::TIsStringLike](API\Plugins\WebAPIEditor\TIsStringLike)< ValueType >::Value, bool >::Type UE::Json::TryGet ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonValue](API\Runtime\Json\Dom\FJsonValue) > & InJsonValue, ValueType & OutValue ) } }


description: String.

code: namespace UE { namespace Json { template<typename ValueType> [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< ![TypeTraits::TIsDerivedFromMap_V](API\Plugins\WebAPIEditor\TIsDerivedFromMap_V)< ValueType > &&[TypeTraits::THasFromJson_V](API\Plugins\WebAPIEditor\THasFromJson_V)< ValueType >, bool >::Type UE::Json::TryGet ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonValue](API\Runtime\Json\Dom\FJsonValue) > & InJsonValue, ValueType & OutValue ) } }


description: Variant.

code: namespace UE { namespace Json { template<typename... ValueTypes> bool UE::Json::TryGet ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonValue](API\Runtime\Json\Dom\FJsonValue) > & InJsonValue, [TVariant](API\Runtime\Core\Misc\TVariant)< ValueTypes... > & OutValue ) } }


description: UniqueObj.

code: namespace UE { namespace Json { template<typename ValueType> bool UE::Json::TryGet ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonValue](API\Runtime\Json\Dom\FJsonValue) > & InJsonValue, [TUniqueObj](API\Runtime\Core\Templates\TUniqueObj)< ValueType > & OutValue ) } }


code: namespace UE { namespace Json { template<typename ValueType> constexpr [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< [TypeTraits::TIsNumeric_V](API\Plugins\WebAPIEditor\TIsNumeric_V)< ValueType >, bool >::Type UE::Json::TryGetField ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & InJsonObject, const [FString](API\Runtime\Core\Containers\FString) & InFieldName, ValueType & OutValue ) } }


code: namespace UE { namespace Json { template<typename ValueType> bool UE::Json::TryGetField ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & InJsonObject, const [FString](API\Runtime\Core\Containers\FString) & InFieldName, [TJsonReference](API\Plugins\WebAPIEditor\TJsonReference)< ValueType > & OutValue ) } }


code: namespace UE { namespace Json { template<typename ValueType> [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< std::is_same_v< ValueType, [TJsonReference](API\Plugins\WebAPIEditor\TJsonReference)< typename ValueType::ElementType > >, bool >::Type UE::Json::TryGetField ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & InJsonObject, const [FString](API\Runtime\Core\Containers\FString) & InFieldName, ValueType & OutValue ) } }


description: TIsTMap,.

code: namespace UE { namespace Json { template<typename ValueType> [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< !std::is_same_v< ValueType, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< typename ValueType::ElementType > > &&!std::is_same_v< ValueType, [TJsonReference](API\Plugins\WebAPIEditor\TJsonReference)< typename ValueType::ElementType > > &&![TIsTMap](API\Runtime\Core\Containers\TIsTMap)< ValueType >::Value &&!TIsTArray_V< ValueType > &&![TypeTraits::TIsStringLike](API\Plugins\WebAPIEditor\TIsStringLike)< ValueType >::Value &&![TIsPODType](API\Runtime\Core\Math\TIsPODType)< ValueType >::Value &&![TypeTraits::THasFromJson_V](API\Plugins\WebAPIEditor\THasFromJson_V)< ValueType >, bool >::Type UE::Json::TryGetField ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & InJsonObject, const [FString](API\Runtime\Core\Containers\FString) & InFieldName, ValueType & OutValue ) } }


code: namespace UE { namespace Json { template<typename ValueType> bool UE::Json::TryGetField ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & InJsonObject, const [FString](API\Runtime\Core\Containers\FString) & InFieldName, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< ValueType > & OutValue ) } }


description: TIsTMap,.

code: namespace UE { namespace Json { template<typename ValueType> [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< std::is_same_v< ValueType, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< typename ValueType::ElementType > >, bool >::Type UE::Json::TryGetField ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & InJsonObject, const [FString](API\Runtime\Core\Containers\FString) & InFieldName, ValueType & OutValue ) } }


code: namespace UE { namespace Json { template<typename ValueType> bool UE::Json::TryGetField ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & InJsonObject, const [FString](API\Runtime\Core\Containers\FString) & InFieldName, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< ValueType > & OutValue ) } }


code: namespace UE { namespace Json { template<typename ValueType> [TEnableIf](API\Runtime\Core\Templates\TEnableIf)<![TIsEnumClass](API\Runtime\Core\Templates\TIsEnumClass)< ValueType >::Value, bool >::Type UE::Json::TryGetField ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & InJsonObject, const [FString](API\Runtime\Core\Containers\FString) & InFieldName, [TOptional](API\Runtime\Core\IO\TOptional)< ValueType > & OutValue ) } }


code: namespace UE { namespace Json { template<typename ValueType> bool UE::Json::TryGetField ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & InJsonObject, const [FString](API\Runtime\Core\Containers\FString) & InFieldName, [TOptional](API\Runtime\Core\IO\TOptional)< [TUniqueObj](API\Runtime\Core\Templates\TUniqueObj)< ValueType >> & OutValue ) } }


code: namespace UE { namespace Json { template<typename ValueType> bool UE::Json::TryGetField ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & InJsonObject, const [FString](API\Runtime\Core\Containers\FString) & InFieldName, [TOptional](API\Runtime\Core\IO\TOptional)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< ValueType >> & OutValue ) } }


code: namespace UE { namespace Json { template<typename ValueType, typename> bool UE::Json::TryGetField ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & InJsonObject, const [FString](API\Runtime\Core\Containers\FString) & InFieldName, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & OutValue ) } }


description: TIsTMap,.

code: namespace UE { namespace Json { template<typename ValueType> constexpr [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< [TypeTraits::TIsStringLike](API\Plugins\WebAPIEditor\TIsStringLike)< ValueType >::Value, bool >::Type UE::Json::TryGetField ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & InJsonObject, const [FString](API\Runtime\Core\Containers\FString) & InFieldName, ValueType & OutValue ) } }


code: namespace UE { namespace Json { template<typename EnumType> constexpr [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< [TIsEnumClass](API\Runtime\Core\Templates\TIsEnumClass)< EnumType >::Value, bool >::Type UE::Json::TryGetField ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & InJsonObject, const [FString](API\Runtime\Core\Containers\FString) & InFieldName, EnumType & OutValue, const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), EnumType > & InNameToValue ) } }


code: namespace UE { namespace Json { template<typename EnumType> constexpr [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< [TIsEnumClass](API\Runtime\Core\Templates\TIsEnumClass)< EnumType >::Value, bool >::Type UE::Json::TryGetField ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & InJsonObject, const [FString](API\Runtime\Core\Containers\FString) & InFieldName, [TOptional](API\Runtime\Core\IO\TOptional)< EnumType > & OutValue, const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), EnumType > & InNameToValue ) } }


code: namespace UE { namespace Json { template<typename ValueType> constexpr [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< std::is_same_v< ValueType, bool >, bool >::Type UE::Json::TryGetField ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & InJsonObject, const [FString](API\Runtime\Core\Containers\FString) & InFieldName, ValueType & OutValue ) } }


code: namespace UE { namespace Json { template<typename ContainerType> constexpr [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< TIsTArray_V< ContainerType >, bool >::Type UE::Json::TryGetField ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & InJsonObject, const [FString](API\Runtime\Core\Containers\FString) & InFieldName, ContainerType & OutValues ) } }


code: namespace UE { namespace Json { template<typename KeyType, typename ValueType> constexpr [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< [TypeTraits::TIsStringLike](API\Plugins\WebAPIEditor\TIsStringLike)< KeyType >::Value, bool >::Type UE::Json::TryGetField ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & InJsonObject, const [FString](API\Runtime\Core\Containers\FString) & InFieldName, [TMap](API\Runtime\Core\Containers\TMap)< KeyType, ValueType > & OutValues ) } }


code: namespace UE { namespace Json { template<typename MapType> constexpr [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< [TIsTMap](API\Runtime\Core\Containers\TIsTMap)< MapType >::Value, bool >::Type UE::Json::TryGetField ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & InJsonObject, const [FString](API\Runtime\Core\Containers\FString) & InFieldName, MapType & OutValues ) } }


code: namespace UE { namespace Json { template<typename ValueType> [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< ![TypeTraits::TIsDerivedFromMap_V](API\Plugins\WebAPIEditor\TIsDerivedFromMap_V)< ValueType > &&[TypeTraits::THasFromJson_V](API\Plugins\WebAPIEditor\THasFromJson_V)< ValueType >, bool >::Type UE::Json::TryGetField ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & InJsonObject, const [FString](API\Runtime\Core\Containers\FString) & InFieldName, ValueType & OutValue ) } }


code: namespace UE { namespace Json { template<typename... ValueTypes> bool UE::Json::TryGetField ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & InJsonObject, const [FString](API\Runtime\Core\Containers\FString) & InFieldName, [TVariant](API\Runtime\Core\Misc\TVariant)< ValueTypes... > & OutValue ) } }


code: namespace UE { namespace Json { template<typename ValueType> bool UE::Json::TryGetField ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & InJsonObject, const [FString](API\Runtime\Core\Containers\FString) & InFieldName, [TUniqueObj](API\Runtime\Core\Templates\TUniqueObj)< ValueType > & OutValue ) } }


className: UE::Json::TryGetField< FString >

code: namespace UE { namespace Json { template<> bool UE::Json::TryGetField< FString > ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & InJsonObject, const [FString](API\Runtime\Core\Containers\FString) & InFieldName, [FString](API\Runtime\Core\Containers\FString) & OutValue ) } }


className: UE::Json::TryGetField< FText >

code: namespace UE { namespace Json { template<> bool UE::Json::TryGetField< FText > ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & InJsonObject, const [FString](API\Runtime\Core\Containers\FString) & InFieldName, [FText](API\Runtime\Core\Internationalization\FText) & OutValue ) } }


className: UE::Json::TryGet< FString >

description: String.

code: namespace UE { namespace Json { template<> bool UE::Json::TryGet< FString > ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonValue](API\Runtime\Json\Dom\FJsonValue) > & InJsonValue, [FString](API\Runtime\Core\Containers\FString) & OutValue ) } }


className: UE::Json::TryGet< FText >

description: Text.

code: namespace UE { namespace Json { template<> bool UE::Json::TryGet< FText > ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonValue](API\Runtime\Json\Dom\FJsonValue) > & InJsonValue, [FText](API\Runtime\Core\Internationalization\FText) & OutValue ) } }


code: namespace UE { namespace Json { template<size_t TypeIndex, typename... ValueTypes> bool UE::Json::TryParse ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonValue](API\Runtime\Json\Dom\FJsonValue) > & InJsonValue, [TVariant](API\Runtime\Core\Misc\TVariant)< ValueTypes... > & OutValue ) } }


code: template<typename DataCacheType> DataCacheType * AddOrGetImportedDataCache ( [FName](API\Runtime\Core\UObject\FName) InKey )


description: Retrieves the custom data for the given key, or creates it if it doesn't exist.

code: [UObject](API\Runtime\CoreUObject\UObject\UObject) * AddOrGetImportedDataCache ( [FName](API\Runtime\Core\UObject\FName) InKey, const [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [UObject](API\Runtime\CoreUObject\UObject\UObject) > & InDataCacheClass )


description: Get the user-specified Copyright Notice, or from the Project Settings if unspecified.


description: Settings for the code generation.

code: const [FWebAPICodeGeneratorSettings](API\Plugins\WebAPIEditor\CodeGen\FWebAPICodeGeneratorSettings) & GetGeneratorSettings() const


description: Settings for the code generation.


code: const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FWebAPIMessageLog](API\Plugins\WebAPIEditor\FWebAPIMessageLog) > & GetMessageLog() const


description: Settings for the WebAPI provider.

code: const [FWebAPIProviderSettings](API\Plugins\WebAPIEditor\FWebAPIProviderSettings) & GetProviderSettings() const


description: Settings for the WebAPI provider.


code: const [UWebAPISchema](API\Plugins\WebAPIEditor\Dom\UWebAPISchema) * GetWebAPISchema() const


description:
Generic function to validate objects during changelist validations, etc.
Returns Valid if this object has data validation rules set up for it and the data for this object is valid. Returns Invalid if it does not pass the rules. Returns NotValidated if no rules are set for this object.

code: virtual EDataValidationResult IsDataValid ( class [FDataValidationContext](API\Runtime\CoreUObject\Misc\FDataValidationContext) & Context ) const


code: virtual ~UWebAPIDefinition()


className: UWebAPIDefinition

description: The asset containing various options and the schema itself.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(AutoCollapseCategories="ImportSettings") class UWebAPIDefinition : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

AssetImportData

description: Importing data and options used for this definition.


description: Gets the category for the settings, some high level grouping like, Editor, Engine, Game...etc.

code: virtual [FName](API\Runtime\Core\UObject\FName) GetCategoryName() const


description: Gets the settings container name for the settings, either Project or Editor

code: virtual [FName](API\Runtime\Core\UObject\FName) GetContainerName() const


code: [TScriptInterface](API\Runtime\CoreUObject\UObject\TScriptInterface)< class [IWebAPICodeGeneratorInterface](API\Plugins\WebAPIEditor\CodeGen\IWebAPICodeGeneratorInterface) > GetGeneratorClass() const


className: UWebAPIEditorSettings

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Config=Engine, defaultconfig, Meta=(DisplayName="WebAPI")) class UWebAPIEditorSettings : public [UDeveloperSettings](API\Runtime\DeveloperSettings\Engine\UDeveloperSettings)

CodeGeneratorClass

type: TSoftClassPtr< ...


description: Implement this for deinitialization of instances of the system

code: virtual void Deinitialize()


className: FOnModuleCreated

description: After a new module or plugin is created.

code: typedef TMulticastDelegate_OneParam< void, [FString](API\Runtime\Core\Containers\FString) > FOnModuleCreated


className: FOnWebAPIDefinitionPreImport

description: Before a WebAPI Definition is being (re)imported.

code: typedef TMulticastDelegate_OneParam< void, [UWebAPIDefinition](API\Plugins\WebAPIEditor\UWebAPIDefinition) * > FOnWebAPIDefinitionPreImport


className: FOnWebAPIDefinitionPostImport

description: After a WebAPI Definition is being (re)imported.

code: typedef TMulticastDelegate_ThreeParams< void, bool, [FName](API\Runtime\Core\UObject\FName), [UWebAPIDefinition](API\Plugins\WebAPIEditor\UWebAPIDefinition) * > FOnWebAPIDefinitionPostImport


description: Implement this for initialization of instances of the system

code: virtual void Initialize ( [FSubsystemCollectionBase](API\Runtime\Engine\Subsystems\FSubsystemCollectionBase) & Collection )