1. Epic GamesDeveloper
  3. FJsonValue

FJsonValue

A Json Value is a structure that can be any of the Json Types.

API > API/Runtime > API/Runtime/Json

A Json Value is a structure that can be any of the Json Types. It should never be used on its, only its derived types should be used.

   
Name FJsonValue
Type class
Header File /Engine/Source/Runtime/Json/Public/Dom/JsonValue.h
Include Path #include "Dom/JsonValue.h"

Syntax

class FJsonValue

Derived Classes

FJsonValue derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FJsonValue ( const FJsonValue&
)

   Dom/JsonValue.h  
  Dom/JsonValue.h  
  Dom/JsonValue.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FJsonValue()

   Dom/JsonValue.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Type EJson   Dom/JsonValue.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AsArgumentType ( TArray< TSharedPtr< FJsonValue > >& Value
)

   Dom/JsonValue.h  

void AsArgumentType ( bool& Value
)

   Dom/JsonValue.h  

void AsArgumentType ( FString& Value
)

   Dom/JsonValue.h  

void AsArgumentType ( double& Value
)

 Get a field of the same type as the argument Dom/JsonValue.h  
  Dom/JsonValue.h  

const TArray< TSharedPtr< FJsonValue > > & AsArray()

 Returns this value as an array, logging an error and returning an empty array reference if not possible Dom/JsonValue.h  

bool AsBool()

 Returns this value as a boolean, logging an error and returning false if not possible Dom/JsonValue.h  

double AsNumber()

 Returns this value as a double, logging an error and returning zero if this is not an Json Number Dom/JsonValue.h  

virtual const TSharedPtr< FJsonObject > & AsObject()

 Returns this value as an object, throwing an error if this is not an Json Object Dom/JsonValue.h  

FString AsString()

 Returns this value as a string, logging an error and returning an empty string if not possible Dom/JsonValue.h  

FUtf8String AsUtf8String()

 Returns this value as a utf8 string, logging an error and returning an empty string if not possible Dom/JsonValue.h  

virtual SIZE_T GetMemoryFootprint ()

 Returns the memory footprint for this object in Bytes, including sizeof(*this) and allocated memory. Dom/JsonValue.h  

bool IsNull()

 Returns true if this value is a 'null' Dom/JsonValue.h  

virtual bool PreferStringRepresentation()

 Returns whether or not a caller should prefer a string representation of the value, rather than the natural JSON type Dom/JsonValue.h  

virtual bool TryGetArray ( const TArray< TSharedPtr< FJsonValue > >*& OutArray
) const

 Tries to convert this value to an array, returning false if not possible Dom/JsonValue.h  

virtual bool TryGetArray ( TArray< TSharedPtr< FJsonValue > >*& OutArray
)

 Tries to convert this value to an array, returning false if not possible Dom/JsonValue.h  

virtual bool TryGetBool ( bool& OutBool
) const

 Tries to convert this value to a bool, returning false if not possible Dom/JsonValue.h  

virtual bool TryGetNumber ( int64& OutNumber
) const

 Tries to convert this value to a number, returning false if not possible Dom/JsonValue.h  

virtual bool TryGetNumber ( int32& OutNumber
) const

 Tries to convert this value to a number, returning false if not possible Dom/JsonValue.h  

virtual bool TryGetNumber ( int16& OutNumber
) const

 Tries to convert this value to a number, returning false if not possible Dom/JsonValue.h  

virtual bool TryGetNumber ( int8& OutNumber
) const

 Tries to convert this value to a number, returning false if not possible Dom/JsonValue.h  

virtual bool TryGetNumber ( double& OutNumber
) const

 Tries to convert this value to a number, returning false if not possible Dom/JsonValue.h  

virtual bool TryGetNumber ( uint32& OutNumber
) const

 Tries to convert this value to a number, returning false if not possible Dom/JsonValue.h  

virtual bool TryGetNumber ( uint8& OutNumber
) const

 Tries to convert this value to a number, returning false if not possible Dom/JsonValue.h  

virtual bool TryGetNumber ( uint64& OutNumber
) const

 Tries to convert this value to a number, returning false if not possible Dom/JsonValue.h  

virtual bool TryGetNumber ( float& OutNumber
) const

 Tries to convert this value to a number, returning false if not possible Dom/JsonValue.h  

virtual bool TryGetNumber ( uint16& OutNumber
) const

 Tries to convert this value to a number, returning false if not possible Dom/JsonValue.h  

virtual bool TryGetObject ( TSharedPtr< FJsonObject >*& Object
)

 Tries to convert this value to an object, returning false if not possible Dom/JsonValue.h  

virtual bool TryGetObject ( const TSharedPtr< FJsonObject >*& Object
) const

 Tries to convert this value to an object, returning false if not possible Dom/JsonValue.h  

virtual bool TryGetString ( FString& OutString
) const

 Tries to convert this value to a string, returning false if not possible Dom/JsonValue.h  

virtual bool TryGetUtf8String ( FUtf8String& OutString
) const

 Tries to convert this value to a utf8 string, returning false if not possible Dom/JsonValue.h  

Protected

Name Remarks Include Path Unreal Specifiers

void ErrorMessage ( const FString& InType
) const

   Dom/JsonValue.h  

FString GetType()

   Dom/JsonValue.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool CompareEqual ( const FJsonValue& Lhs,
const FJsonValue& Rhs
)

   Dom/JsonValue.h  

static TSharedPtr< FJsonValue > Duplicate ( const TSharedPtr< FJsonValue >& Src
)

   Dom/JsonValue.h  

static TSharedPtr< FJsonValue > Duplicate ( const TSharedPtr< const FJsonValue >& Src
)

   Dom/JsonValue.h  

Operators

Name Remarks Include Path Unreal Specifiers
  Dom/JsonValue.h  
  Dom/JsonValue.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page