Navigation
API > API/Plugins > API/Plugins/WebAPIEditor
| Name | UWebAPIOperation |
| Type | class |
| Header File | /Engine/Plugins/Experimental/Web/WebAPI/Source/WebAPIEditor/Public/Dom/WebAPIOperation.h |
| Include Path | #include "Dom/WebAPIOperation.h" |
Syntax
UCLASS ()
class UWebAPIOperation :
public UObject ,
public IWebAPISchemaObjectInterface
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UWebAPIOperation
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UWebAPIOperation() |
Dom/WebAPIOperation.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bGenerate | bool | Can be disabled to skip generation of this Operation. | Dom/WebAPIOperation.h |
|
| bIsDeprecated | bool | Flags an operation previously available as deprecated. | Dom/WebAPIOperation.h |
|
| Description | FString | Describes this operation. | Dom/WebAPIOperation.h |
|
| Errors | TArray< TObjectPtr< UWebAPIOperationError > > | Array of errors that can be returned. | Dom/WebAPIOperation.h |
|
| GeneratedCodeText | FString | The last generated code as text for debugging. | Dom/WebAPIOperation.h |
|
| Name | FWebAPITypeNameVariant | Name of the Operation. | Dom/WebAPIOperation.h |
|
| Path | FString | The operation path, relative to the base url. This can contain named template args. | Dom/WebAPIOperation.h |
|
| Request | TObjectPtr< UWebAPIOperationRequest > | Request model. | Dom/WebAPIOperation.h |
|
| RequestContentTypes | TArray< FString > | List of possible content types for requests, ie. application/json | Dom/WebAPIOperation.h |
|
| ResponseContentTypes | TArray< FString > | List of possible content types for responses, ie. application/json | Dom/WebAPIOperation.h |
|
| Responses | TArray< TObjectPtr< UWebAPIOperationResponse > > | Array of responses. | Dom/WebAPIOperation.h |
|
| Service | TObjectPtr< class UWebAPIService > | Parent service for this operation. | Dom/WebAPIOperation.h |
|
| Verb | FString | The Http verb, ie. Get, Post, etc. | Dom/WebAPIOperation.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BindToTypeInfo() |
Associates this model with it's own TypeInfo. | Dom/WebAPIOperation.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual EDataValidationResult IsDataValid
(
FDataValidationContext& Context |
Dom/WebAPIOperation.h |
Overridden from IWebAPISchemaObjectInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AppendCodeText
(
const FString& InCodeText |
Appends the last generated code as text for debugging. | Dom/WebAPIOperation.h | |
virtual void SetCodeText
(
const FString& InCodeText |
Sets the last generated code as text for debugging. | Dom/WebAPIOperation.h | |
virtual void SetNamespace
(
const FString& InNamespace |
Recursively sets the namespace of this and all child objects. | Dom/WebAPIOperation.h | |
virtual void Visit
(
TFunctionRef< void(IWebAPISchemaObjectInterface*&)> InVisitor |
Recursively visit each element in the schema. | Dom/WebAPIOperation.h |