FSignalRInvokeResult Class Reference

Represents the result of a SignalR method invocation, containing either a value or error information. More...

#include <IHubConnection.h>

Inheritance diagram for FSignalRInvokeResult:

Public Member Functions
	FSignalRInvokeResult (const FSignalRValue &Value)
	FSignalRInvokeResult (const FSignalRInvokeResult &OtherValue)
	FSignalRInvokeResult (FSignalRInvokeResult &&OtherValue) noexcept
FSignalRInvokeResult &	operator= (const FSignalRInvokeResult &OtherValue)
FSignalRInvokeResult &	operator= (FSignalRInvokeResult &&OtherValue) noexcept
FORCEINLINE bool	HasError () const
	Checks if the invoke result contains an error.
FORCEINLINE const FString &	GetErrorMessage () const
Public Member Functions inherited from FSignalRValue
	FSignalRValue ()
	Create an object representing a EValueType::Null value.
	FSignalRValue (std::nullptr_t)
	Create an object representing a EValueType::Null value.
	FSignalRValue (const int32 InValue)
	Create an object representing a EValueType::Number with the given integer value.
	FSignalRValue (const uint32 InValue)
	Create an object representing a EValueType::Number with the given unsigned integer value.
	FSignalRValue (const int64 InValue)
	Create an object representing a EValueType::Number with the given 64-bit integer value.
	FSignalRValue (const uint64 InValue)
	Create an object representing a EValueType::Number with the given unsigned 64-bit integer value.
	FSignalRValue (const float InValue)
	Create an object representing a EValueType::Number with the given float value.
	FSignalRValue (const double InValue)
	Create an object representing a EValueType::Number with the given double value.
	FSignalRValue (const TMap< FString, FSignalRValue > &InValue)
	Create an object representing a EValueType::Object with the given map of string-values.
	FSignalRValue (TMap< FString, FSignalRValue > &&InValue)
	Create an object representing a EValueType::Object with the given map of string-values.
	FSignalRValue (const TArray< FSignalRValue > &InValue)
	Create an object representing a EValueType::Array with the given array of values.
	FSignalRValue (TArray< FSignalRValue > &&InValue)
	Create an object representing a EValueType::Array with the given array of values.
	FSignalRValue (const FString &InValue)
	Create an object representing a EValueType::String with the given string value.
	FSignalRValue (FString &&InValue)
	Create an object representing a EValueType::String with the given string value.
	FSignalRValue (bool InValue)
	Create an object representing a EValueType::Boolean with the given bool value.
	FSignalRValue (const TArray< uint8 > &InValue)
	Create an object representing a EValueType::Binary with the given array of byte's.
	FSignalRValue (TArray< uint8 > &&InValue)
	Create an object representing a EValueType::Binary with the given array of byte's.
	FSignalRValue (const FSignalRValue &OtherValue)
	Copies an existing value.
	FSignalRValue (FSignalRValue &&OtherValue) noexcept
	Moves an existing value.
	~FSignalRValue ()=default
	Cleans up the resources associated with the value.
FSignalRValue &	operator= (const FSignalRValue &OtherValue)
	Copies an existing value.
FSignalRValue &	operator= (FSignalRValue &&OtherValue) noexcept
	Moves an existing value.
FORCEINLINE bool	IsNumber () const
FORCEINLINE bool	IsObject () const
FORCEINLINE bool	IsString () const
FORCEINLINE bool	IsNull () const
FORCEINLINE bool	IsArray () const
FORCEINLINE bool	IsBoolean () const
FORCEINLINE bool	IsBinary () const
FORCEINLINE EValueType	GetType () const
FORCEINLINE int64	AsInt () const
FORCEINLINE uint64	AsUInt () const
FORCEINLINE float	AsFloat () const
FORCEINLINE double	AsDouble () const
FORCEINLINE double	AsNumber () const
FORCEINLINE const TMap< FString, FSignalRValue > &	AsObject () const
FORCEINLINE const TArray< FSignalRValue > &	AsArray () const
FORCEINLINE const FString &	AsString () const
FORCEINLINE bool	AsBool () const
FORCEINLINE const TArray< uint8 > &	AsBinary () const

Static Public Member Functions
static FORCEINLINE FSignalRInvokeResult	Error (const FString &ErrorMessage)
	Creates an error result with the specified message.

Friends
struct	FSignalRInvokeResultWrapper

Additional Inherited Members
Public Types inherited from FSignalRValue
enum class	EValueType {   Number , Object , Array , String ,   Null , Boolean , Binary }
	Enumeration of possible value types that can be stored in a FSignalRValue. More...

Detailed Description

Represents the result of a SignalR method invocation, containing either a value or error information.

Constructor & Destructor Documentation

FSignalRInvokeResult() [1/3]

FSignalRInvokeResult::FSignalRInvokeResult ( const FSignalRValue & Value )

inline

FSignalRInvokeResult() [2/3]

FSignalRInvokeResult::FSignalRInvokeResult ( const FSignalRInvokeResult & OtherValue )

inline

FSignalRInvokeResult() [3/3]

FSignalRInvokeResult::FSignalRInvokeResult ( FSignalRInvokeResult && OtherValue )

inlinenoexcept

Member Function Documentation

Error()

static FORCEINLINE FSignalRInvokeResult FSignalRInvokeResult::Error ( const FString & ErrorMessage )

inlinestatic

Creates an error result with the specified message.

Parameters

ErrorMessage

The error message to include in the result.

Returns

A FSignalRInvokeResult instance representing an error.

GetErrorMessage()

FORCEINLINE const FString & FSignalRInvokeResult::GetErrorMessage ( ) const

inline

Returns

The error message associated with this result.

HasError()

FORCEINLINE bool FSignalRInvokeResult::HasError ( ) const

inline

Checks if the invoke result contains an error.

Returns

True if this result represents an error, false otherwise.

operator=() [1/2]

FSignalRInvokeResult & FSignalRInvokeResult::operator= ( const FSignalRInvokeResult & OtherValue )

inline

operator=() [2/2]

FSignalRInvokeResult & FSignalRInvokeResult::operator= ( FSignalRInvokeResult && OtherValue )

inlinenoexcept

Friends And Related Symbol Documentation

FSignalRInvokeResultWrapper

friend struct FSignalRInvokeResultWrapper

friend

---

The documentation for this class was generated from the following file:

• IHubConnection.h