Navigation
API > API/Plugins > API/Plugins/WebAPIEditor
References
| Module | WebAPIEditor |
| Header | /Engine/Plugins/Experimental/Web/WebAPI/Source/WebAPIEditor/Public/WebAPIJsonUtilities.h |
| Include | #include "WebAPIJsonUtilities.h" |
Syntax
template<class ObjectType>
class TJsonReference
Remarks
Contains either an object constructed in place, or a reference to an object declared elsewhere.
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
bool | bHasPendingResolve | Flag indicating this is a reference but not yet resolved. |
 |
TSharedPtr< ObjectType > | Object | Underling object pointer. |
 |
FString | Path | The specified path to the actual object definition. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Constructs an empty Json Reference. |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
ObjectType * | Get () |
Returns the object referenced by this Json Reference, or nullptr if it doesn't exist. |
 |
ObjectType * | Get () |
Returns the object referenced by this Json Reference, creating it if it doesn't exist. |
  |
FString | ||
  |
const FString & | GetPath () |
|
  |
bool | GetPathSegments
(
TArray< FString >& OutSegments |
Returns true if there were one or more segments. |
  |
TSharedPtr< ObjectType > | GetShared () |
Returns the object referenced by this Json Reference, or nullptr if it doesn't exist. |
 |
TSharedPtr< ObjectType > | GetShared () |
Returns the object referenced by this Json Reference, creating it if it doesn't exist. |
  |
bool | IsSet () |
Checks if the underlying object has been set. |
  |
bool | IsValid () |
Checks if the object is valid, or it's pending reference resolution. |
 |
void | ResolveDeferred
(
const FString& InJsonPath |
Sets the object path and flags it as a pending reference (to be resolved later). |
 |
bool | Set
(
TSharedPtr< ObjectType >&& InObject |
Set's the object if it's not already set. |
 |
bool | Set
(
ObjectType&& InObject |
Set's the object if it's not already set. |
 |
bool | Set
(
const TSharedPtr< ObjectType >& InObject |
Set's the object if it's not already set. |
 |
bool | TryResolve
(
const TSharedRef< FJsonObject >& InRootObject, |
Attempts to resolve the reference, returns true if successful or already set. |
Operators
| Type | Name | Description | |
|---|---|---|---|
  |
Checks to see if this is actually pointing to an object. | ||
  |
ObjectType & | operator* () |
Dereferences the object |
  |
ObjectType * | operator-> () |
Pointer to the underlying object. |
Typedefs
| Name | Description |
|---|---|
| ElementType |
Constants
| Name | Description |
|---|---|
| Mode |