RHAPI_AppSetting

Summary

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

struct FRHAPI_AppSetting

struct FRHAPI_AppSetting
  : public FRHAPI_Model

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

Summary

Members	Descriptions
public FString Key	The key for the setting.
public FString Value	The value for the setting.
public FString Notes_Optional	Notes to describe the key value pair.
public bool Notes_IsSet	true 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) const	Writes 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() const	Gets 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() const	Gets 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() const	Gets the value of Notes_Optional, regardless of it having been set.
public inline const FString & GetNotes(const FString & DefaultValue) const	Gets the value of Notes_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetNotes(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()	Returns a pointer to Notes_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetNotesOrNull() const	Returns 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

The value for the setting.

public FString Notes_Optional

Notes to describe the key value pair.

public bool Notes_IsSet

true 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.

Parameters

• JsonValue Data from the API call.

Returns

true if parsing of the JSON data was successful.

public virtual void WriteJson(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()

Gets the value of Key.

public inline const FString & GetKey() const

Gets 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() const

Gets 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() const

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

public inline const FString & GetNotes(const FString & DefaultValue) const

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

public inline bool GetNotes(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()

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

public inline const FString * GetNotesOrNull() const

Returns 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.