Skip to content

RHAPI_KVV1

Summary

MembersDescriptions
struct FRHAPI_KVV1A key/value pair that represents a setting to be used by the client.

struct FRHAPI_KVV1

struct FRHAPI_KVV1
: public FRHAPI_Model

A key/value pair that represents a setting to be used by the client.

Summary

MembersDescriptions
public FString KeyThe key for the setting.
public FString ValueThe value for the setting.
public FString Notes_Optional
public bool Notes_IsSettrue if Notes_Optional has been set to a value
public virtual bool FromJson(const TSharedPtr< FJsonValue > & JsonValue)Fills this object with data from the passed in JSON.
public virtual void WriteJson(TSharedRef< TJsonWriter<>> & Writer) constWrites the data from this object into the specified JSON Writer stream.
public inline FString & GetKey()Gets the value of Key.
public inline const FString & GetKey() constGets the value of Key.
public inline void SetKey(FString NewValue)Sets the value of Key.
public inline FString & GetValue()Gets the value of Value.
public inline const FString & GetValue() constGets the value of Value.
public inline void SetValue(FString NewValue)Sets the value of Value.
public inline FString & GetNotes()Gets the value of Notes_Optional, regardless of it having been set.
public inline const FString & GetNotes() constGets the value of Notes_Optional, regardless of it having been set.
public inline const FString & GetNotes(const FString & DefaultValue) constGets the value of Notes_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetNotes(FString & OutValue) constFills OutValue with the value of Notes_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetNotesOrNull()Returns a pointer to Notes_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetNotesOrNull() constReturns a pointer to Notes_Optional, if it has been set, otherwise returns nullptr.
public inline void SetNotes(FString NewValue)Sets the value of Notes_Optional and also sets Notes_IsSet to true.
public inline void ClearNotes()Clears the value of Notes_Optional and sets Notes_IsSet to false.

Members

public FString Key

The key for the setting.


#### `public FString `[`Value`](#structFRHAPI__KVV1_1a7371b5d7b85e04f8f8e8826b1f552fe9)

The value for the setting.


#### `public FString `[`Notes_Optional`](#structFRHAPI__KVV1_1a85ee373f386631eb4de63c619e9e32cd)
#### `public bool `[`Notes_IsSet`](#structFRHAPI__KVV1_1a0b4646a683aa065edf28203a13a44358)

true if Notes_Optional has been set to a value


#### `public virtual bool `[`FromJson`](#structFRHAPI__KVV1_1a56c580398961b817d89c625eafe4bbc9)`(const TSharedPtr< FJsonValue > & JsonValue)`

Fills this object with data from the passed in JSON.

Parameters

  • JsonValue Data from the API call.

Returns

true if parsing of the JSON data was successful.


#### `public virtual void `[`WriteJson`](#structFRHAPI__KVV1_1a798858ea9602e85fba57483b811160cd)`(TSharedRef< TJsonWriter<>> & Writer) const`

Writes the data from this object into the specified JSON Writer stream.

Parameters

  • Writer JSON Writer stream to push .

#### `public inline FString & `[`GetKey`](#structFRHAPI__KVV1_1a67d0feb893b0c257bb605749ad8c4a6e)`()`

Gets the value of Key.


#### `public inline const FString & `[`GetKey`](#structFRHAPI__KVV1_1ad0a5f00fbc212bfd868aa0e84b6b3e3c)`() const`

Gets the value of Key.


#### `public inline void `[`SetKey`](#structFRHAPI__KVV1_1a4ab9a2a908a2115bbe3154c7d32c9212)`(FString NewValue)`

Sets the value of Key.


#### `public inline FString & `[`GetValue`](#structFRHAPI__KVV1_1a5b96d26a812685e065ed19287e12a211)`()`

Gets the value of Value.


#### `public inline const FString & `[`GetValue`](#structFRHAPI__KVV1_1ab737344aaeb184d03e0c32cd0e3f0e20)`() const`

Gets the value of Value.


#### `public inline void `[`SetValue`](#structFRHAPI__KVV1_1a138d34e0e42da071a7beeac644eb908c)`(FString NewValue)`

Sets the value of Value.


#### `public inline FString & `[`GetNotes`](#structFRHAPI__KVV1_1aabb05a907e74feee14a516b9574d99e1)`()`

Gets the value of Notes_Optional, regardless of it having been set.


#### `public inline const FString & `[`GetNotes`](#structFRHAPI__KVV1_1a42091b149fc802a59785a4cd2d7f11ab)`() const`

Gets the value of Notes_Optional, regardless of it having been set.


#### `public inline const FString & `[`GetNotes`](#structFRHAPI__KVV1_1a71ffae33467f167421b60a23444a3ef7)`(const FString & DefaultValue) const`

Gets the value of Notes_Optional, if it has been set, otherwise it returns DefaultValue.


#### `public inline bool `[`GetNotes`](#structFRHAPI__KVV1_1a6f418b98db58d45a0d99b3d879f76540)`(FString & OutValue) const`

Fills OutValue with the value of Notes_Optional and returns true if it has been set, otherwise returns false.


#### `public inline FString * `[`GetNotesOrNull`](#structFRHAPI__KVV1_1ad31d046db72075d0e9731f188fe45083)`()`

Returns a pointer to Notes_Optional, if it has been set, otherwise returns nullptr.


#### `public inline const FString * `[`GetNotesOrNull`](#structFRHAPI__KVV1_1a7d5ccfbfd237c43bb1c2425558248bd1)`() const`

Returns a pointer to Notes_Optional, if it has been set, otherwise returns nullptr.


#### `public inline void `[`SetNotes`](#structFRHAPI__KVV1_1a3dc7f59d7e6160327ab676ffa4a86988)`(FString NewValue)`

Sets the value of Notes_Optional and also sets Notes_IsSet to true.


#### `public inline void `[`ClearNotes`](#structFRHAPI__KVV1_1af6138e37d8c64331aa5f9877e5fd3bab)`()`

Clears the value of Notes_Optional and sets Notes_IsSet to false.