Skip to main content

RHAPI_SettingData

Summary​

MembersDescriptions
struct FRHAPI_SettingDataSetting version/value document from a specific setting type/key for a player.

struct FRHAPI_SettingData ​

struct FRHAPI_SettingData
  : public FRHAPI_Model

Setting version/value document from a specific setting type/key for a player.

Summary​

MembersDescriptions
public int32 VVersion of the Setting Type schema that was used to validate the value document.
public FRHAPI_JsonValue ValueSetting Value document.
public bool Value_IsNulltrue if Value has been explicitly set to null
public FString Etag_Optional
public bool Etag_IsSettrue if Etag_Optional has been set to a value
public bool Etag_IsNulltrue if Etag_Optional has been explicitly set to null
public FDateTime LastModified_OptionalDatetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.
public bool LastModified_IsSettrue if LastModified_Optional has been set to a value
public bool LastModified_IsNulltrue if LastModified_Optional has been explicitly set to null
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 int32 & GetV()Gets the value of V.
public inline const int32 & GetV() constGets the value of V.
public inline void SetV(const int32 & NewValue)Sets the value of V.
public inline void SetV(int32 && NewValue)Sets the value of V using move semantics.
public inline bool IsVDefaultValue() constReturns true if V matches the default value.
public inline void SetVToDefault()Sets the value of V to its default
public inline FRHAPI_JsonValue&GetValue()Gets the value of Value.
public inline const FRHAPI_JsonValue&GetValue() constGets the value of Value.
public inline void SetValue(const FRHAPI_JsonValue & NewValue)Sets the value of Value.
public inline void SetValue(FRHAPI_JsonValue && NewValue)Sets the value of Value using move semantics.
public inline void SetValueToNull()Sets the value explicitly to be treated as null.
public inline bool IsValueNull() constChecks whether Value is set to null.
public inline FString & GetEtag()Gets the value of Etag_Optional, regardless of it having been set.
public inline const FString & GetEtag() constGets the value of Etag_Optional, regardless of it having been set.
public inline const FString & GetEtag(const FString & DefaultValue) constGets the value of Etag_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetEtag(FString & OutValue) constFills OutValue with the value of Etag_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetEtagOrNull()Returns a pointer to Etag_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetEtagOrNull() constReturns a pointer to Etag_Optional, if it has been set, otherwise returns nullptr.
public inline void SetEtag(const FString & NewValue)Sets the value of Etag_Optional and also sets Etag_IsSet to true.
public inline void SetEtag(FString && NewValue)Sets the value of Etag_Optional and also sets Etag_IsSet to true using move semantics.
public inline void ClearEtag()Clears the value of Etag_Optional and sets Etag_IsSet to false.
public inline bool IsEtagSet() constChecks whether Etag_Optional has been set.
public inline void SetEtagToNull()Sets the value explicitly to be treated as null.
public inline bool IsEtagNull() constChecks whether Etag_Optional is set to null.
public inline FDateTime & GetLastModified()Gets the value of LastModified_Optional, regardless of it having been set.
public inline const FDateTime & GetLastModified() constGets the value of LastModified_Optional, regardless of it having been set.
public inline const FDateTime & GetLastModified(const FDateTime & DefaultValue) constGets the value of LastModified_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetLastModified(FDateTime & OutValue) constFills OutValue with the value of LastModified_Optional and returns true if it has been set, otherwise returns false.
public inline FDateTime * GetLastModifiedOrNull()Returns a pointer to LastModified_Optional, if it has been set, otherwise returns nullptr.
public inline const FDateTime * GetLastModifiedOrNull() constReturns a pointer to LastModified_Optional, if it has been set, otherwise returns nullptr.
public inline void SetLastModified(const FDateTime & NewValue)Sets the value of LastModified_Optional and also sets LastModified_IsSet to true.
public inline void SetLastModified(FDateTime && NewValue)Sets the value of LastModified_Optional and also sets LastModified_IsSet to true using move semantics.
public inline void ClearLastModified()Clears the value of LastModified_Optional and sets LastModified_IsSet to false.
public inline bool IsLastModifiedSet() constChecks whether LastModified_Optional has been set.
public inline void SetLastModifiedToNull()Sets the value explicitly to be treated as null.
public inline bool IsLastModifiedNull() constChecks whether LastModified_Optional is set to null.

Members​

public int32 V ​

Version of the Setting Type schema that was used to validate the value document.

public FRHAPI_JsonValue Value ​

Setting Value document.

public bool Value_IsNull ​

true if Value has been explicitly set to null

public FString Etag_Optional ​

public bool Etag_IsSet ​

true if Etag_Optional has been set to a value

public bool Etag_IsNull ​

true if Etag_Optional has been explicitly set to null

public FDateTime LastModified_Optional ​

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.

public bool LastModified_IsSet ​

true if LastModified_Optional has been set to a value

public bool LastModified_IsNull ​

true if LastModified_Optional has been explicitly set to null

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 int32 & GetV() ​

Gets the value of V.

public inline const int32 & GetV() const ​

Gets the value of V.

public inline void SetV(const int32 & NewValue) ​

Sets the value of V.

public inline void SetV(int32 && NewValue) ​

Sets the value of V using move semantics.

public inline bool IsVDefaultValue() const ​

Returns true if V matches the default value.

public inline void SetVToDefault() ​

Sets the value of V to its default

public inline FRHAPI_JsonValue&GetValue() ​

Gets the value of Value.

public inline const FRHAPI_JsonValue&GetValue() const ​

Gets the value of Value.

public inline void SetValue(const FRHAPI_JsonValue & NewValue) ​

Sets the value of Value.

public inline void SetValue(FRHAPI_JsonValue && NewValue) ​

Sets the value of Value using move semantics.

public inline void SetValueToNull() ​

Sets the value explicitly to be treated as null.

public inline bool IsValueNull() const ​

Checks whether Value is set to null.

public inline FString & GetEtag() ​

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

public inline const FString & GetEtag() const ​

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

public inline const FString & GetEtag(const FString & DefaultValue) const ​

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

public inline bool GetEtag(FString & OutValue) const ​

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

public inline FString * GetEtagOrNull() ​

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

public inline const FString * GetEtagOrNull() const ​

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

public inline void SetEtag(const FString & NewValue) ​

Sets the value of Etag_Optional and also sets Etag_IsSet to true.

public inline void SetEtag(FString && NewValue) ​

Sets the value of Etag_Optional and also sets Etag_IsSet to true using move semantics.

public inline void ClearEtag() ​

Clears the value of Etag_Optional and sets Etag_IsSet to false.

public inline bool IsEtagSet() const ​

Checks whether Etag_Optional has been set.

public inline void SetEtagToNull() ​

Sets the value explicitly to be treated as null.

public inline bool IsEtagNull() const ​

Checks whether Etag_Optional is set to null.

public inline FDateTime & GetLastModified() ​

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

public inline const FDateTime & GetLastModified() const ​

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

public inline const FDateTime & GetLastModified(const FDateTime & DefaultValue) const ​

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

public inline bool GetLastModified(FDateTime & OutValue) const ​

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

public inline FDateTime * GetLastModifiedOrNull() ​

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

public inline const FDateTime * GetLastModifiedOrNull() const ​

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

public inline void SetLastModified(const FDateTime & NewValue) ​

Sets the value of LastModified_Optional and also sets LastModified_IsSet to true.

public inline void SetLastModified(FDateTime && NewValue) ​

Sets the value of LastModified_Optional and also sets LastModified_IsSet to true using move semantics.

public inline void ClearLastModified() ​

Clears the value of LastModified_Optional and sets LastModified_IsSet to false.

public inline bool IsLastModifiedSet() const ​

Checks whether LastModified_Optional has been set.

public inline void SetLastModifiedToNull() ​

Sets the value explicitly to be treated as null.

public inline bool IsLastModifiedNull() const ​

Checks whether LastModified_Optional is set to null.