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