Navigation
API > API/Plugins > API/Plugins/WebAPIEditor
| Name | FWebAPICodeGenOperation |
| Type | class |
| Header File | /Engine/Plugins/Experimental/Web/WebAPI/Source/WebAPIEditor/Public/CodeGen/Dom/WebAPICodeGenOperation.h |
| Include Path | #include "CodeGen/Dom/WebAPICodeGenOperation.h" |
Syntax
class FWebAPICodeGenOperation : public FWebAPICodeGenBase
Inheritance Hierarchy
- FWebAPICodeGenBase → FWebAPICodeGenOperation
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Super | FWebAPICodeGenBase | Inherited baseclass. | CodeGen/Dom/WebAPICodeGenOperation.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| TypeName | const FName | CodeGen Type. | CodeGen/Dom/WebAPICodeGenOperation.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsDeprecated | bool | Flags an operation previously available as deprecated. | CodeGen/Dom/WebAPICodeGenOperation.h | |
| Name | FWebAPITypeNameVariant | Name with optional prefix, namespace, etc. | CodeGen/Dom/WebAPICodeGenOperation.h | |
| Path | FString | Templated/tokenized Url path relative to the Base Url. | CodeGen/Dom/WebAPICodeGenOperation.h | |
| RequestMediaType | FString | Usually application/json. | CodeGen/Dom/WebAPICodeGenOperation.h | |
| Requests | TArray< TSharedPtr< FWebAPICodeGenOperationRequest > > | Requests for this Operation. | CodeGen/Dom/WebAPICodeGenOperation.h | |
| Responses | TArray< TSharedPtr< FWebAPICodeGenOperationResponse > > | Responses for this Operation. | CodeGen/Dom/WebAPICodeGenOperation.h | |
| SettingsTypeName | FString | The name of the generated Settings class. | CodeGen/Dom/WebAPICodeGenOperation.h | |
| Verb | FString | Http Verb. | CodeGen/Dom/WebAPICodeGenOperation.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const TSharedPtr< FWebAPICodeGenOperationResponse > & FindOrAddResponse
(
const uint32& InResponseCode |
Finds or creates a response with the given name. | CodeGen/Dom/WebAPICodeGenOperation.h | |
void FromWebAPI
(
const UWebAPIOperation* InSrcOperation |
Populates this object from the given WebAPI object. | CodeGen/Dom/WebAPICodeGenOperation.h |
Overridden from FWebAPICodeGenBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void GetIncludePaths
(
TArray< FString >& OutIncludePaths |
Append any include paths for this file to the given Array (not Set, to allow custom order). | CodeGen/Dom/WebAPICodeGenOperation.h | |
virtual void GetModuleDependencies
(
TSet< FString >& OutModules |
Append any dependent modules for this file to the given Set. | CodeGen/Dom/WebAPICodeGenOperation.h | |
virtual FString GetName
(
bool bJustName |
Retrieve the name. The source depends on the CodeGen object type. | CodeGen/Dom/WebAPICodeGenOperation.h | |
virtual const FName & GetTypeName() |
CodeGen Type. | CodeGen/Dom/WebAPICodeGenOperation.h | |
virtual void SetModule
(
const FString& InModule |
Sets the containing module name. | CodeGen/Dom/WebAPICodeGenOperation.h |