RHAPI_AgreementMessage
Summary
Members | Descriptions |
---|---|
struct FRHAPI_AgreementMessage | Error message for when a user has not agreed to the EULA, TOS, or Privacy Policy. |
struct FRHAPI_AgreementMessage
struct FRHAPI_AgreementMessage
: public FRHAPI_Model
Error message for when a user has not agreed to the EULA, TOS, or Privacy Policy.
Summary
Members | Descriptions |
---|---|
public bool AuthSuccess_Optional | |
public bool AuthSuccess_IsSet | true if AuthSuccess_Optional has been set to a value |
public FString ErrorCode | |
public FString Desc | |
public bool NeedsEula_Optional | Whether the user needs to accept the End User License Agreement. |
public bool NeedsEula_IsSet | true if NeedsEula_Optional has been set to a value |
public bool NeedsTos_Optional | Whether the user needs to accept the Terms of Service. |
public bool NeedsTos_IsSet | true if NeedsTos_Optional has been set to a value |
public bool NeedsPrivacyPolicy_Optional | Whether the user needs to accept the Privacy Policy. |
public bool NeedsPrivacyPolicy_IsSet | true if NeedsPrivacyPolicy_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 bool & GetAuthSuccess () | Gets the value of AuthSuccess_Optional, regardless of it having been set. |
public inline const bool & GetAuthSuccess () const | Gets the value of AuthSuccess_Optional, regardless of it having been set. |
public inline const bool & GetAuthSuccess (const bool & DefaultValue) const | Gets the value of AuthSuccess_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetAuthSuccess (bool & OutValue) const | Fills OutValue with the value of AuthSuccess_Optional and returns true if it has been set, otherwise returns false. |
public inline bool * GetAuthSuccessOrNull () | Returns a pointer to AuthSuccess_Optional, if it has been set, otherwise returns nullptr. |
public inline const bool * GetAuthSuccessOrNull () const | Returns a pointer to AuthSuccess_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetAuthSuccess (bool NewValue) | Sets the value of AuthSuccess_Optional and also sets AuthSuccess_IsSet to true. |
public inline void ClearAuthSuccess () | Clears the value of AuthSuccess_Optional and sets AuthSuccess_IsSet to false. |
public inline bool IsAuthSuccessDefaultValue () const | Returns true if AuthSuccess_Optional is set and matches the default value. |
public inline void SetAuthSuccessToDefault () | Sets the value of AuthSuccess_Optional to its default and also sets AuthSuccess_IsSet to true. |
public inline FString & GetErrorCode () | Gets the value of ErrorCode. |
public inline const FString & GetErrorCode () const | Gets the value of ErrorCode. |
public inline void SetErrorCode (FString NewValue) | Sets the value of ErrorCode. |
public inline FString & GetDesc () | Gets the value of Desc. |
public inline const FString & GetDesc () const | Gets the value of Desc. |
public inline void SetDesc (FString NewValue) | Sets the value of Desc. |
public inline bool & GetNeedsEula () | Gets the value of NeedsEula_Optional, regardless of it having been set. |
public inline const bool & GetNeedsEula () const | Gets the value of NeedsEula_Optional, regardless of it having been set. |
public inline const bool & GetNeedsEula (const bool & DefaultValue) const | Gets the value of NeedsEula_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetNeedsEula (bool & OutValue) const | Fills OutValue with the value of NeedsEula_Optional and returns true if it has been set, otherwise returns false. |
public inline bool * GetNeedsEulaOrNull () | Returns a pointer to NeedsEula_Optional, if it has been set, otherwise returns nullptr. |
public inline const bool * GetNeedsEulaOrNull () const | Returns a pointer to NeedsEula_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetNeedsEula (bool NewValue) | Sets the value of NeedsEula_Optional and also sets NeedsEula_IsSet to true. |
public inline void ClearNeedsEula () | Clears the value of NeedsEula_Optional and sets NeedsEula_IsSet to false. |
public inline bool IsNeedsEulaDefaultValue () const | Returns true if NeedsEula_Optional is set and matches the default value. |
public inline void SetNeedsEulaToDefault () | Sets the value of NeedsEula_Optional to its default and also sets NeedsEula_IsSet to true. |
public inline bool & GetNeedsTos () | Gets the value of NeedsTos_Optional, regardless of it having been set. |
public inline const bool & GetNeedsTos () const | Gets the value of NeedsTos_Optional, regardless of it having been set. |
public inline const bool & GetNeedsTos (const bool & DefaultValue) const | Gets the value of NeedsTos_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetNeedsTos (bool & OutValue) const | Fills OutValue with the value of NeedsTos_Optional and returns true if it has been set, otherwise returns false. |
public inline bool * GetNeedsTosOrNull () | Returns a pointer to NeedsTos_Optional, if it has been set, otherwise returns nullptr. |
public inline const bool * GetNeedsTosOrNull () const | Returns a pointer to NeedsTos_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetNeedsTos (bool NewValue) | Sets the value of NeedsTos_Optional and also sets NeedsTos_IsSet to true. |
public inline void ClearNeedsTos () | Clears the value of NeedsTos_Optional and sets NeedsTos_IsSet to false. |
public inline bool IsNeedsTosDefaultValue () const | Returns true if NeedsTos_Optional is set and matches the default value. |
public inline void SetNeedsTosToDefault () | Sets the value of NeedsTos_Optional to its default and also sets NeedsTos_IsSet to true. |
public inline bool & GetNeedsPrivacyPolicy () | Gets the value of NeedsPrivacyPolicy_Optional, regardless of it having been set. |
public inline const bool & GetNeedsPrivacyPolicy () const | Gets the value of NeedsPrivacyPolicy_Optional, regardless of it having been set. |
public inline const bool & GetNeedsPrivacyPolicy (const bool & DefaultValue) const | Gets the value of NeedsPrivacyPolicy_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetNeedsPrivacyPolicy (bool & OutValue) const | Fills OutValue with the value of NeedsPrivacyPolicy_Optional and returns true if it has been set, otherwise returns false. |
public inline bool * GetNeedsPrivacyPolicyOrNull () | Returns a pointer to NeedsPrivacyPolicy_Optional, if it has been set, otherwise returns nullptr. |
public inline const bool * GetNeedsPrivacyPolicyOrNull () const | Returns a pointer to NeedsPrivacyPolicy_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetNeedsPrivacyPolicy (bool NewValue) | Sets the value of NeedsPrivacyPolicy_Optional and also sets NeedsPrivacyPolicy_IsSet to true. |
public inline void ClearNeedsPrivacyPolicy () | Clears the value of NeedsPrivacyPolicy_Optional and sets NeedsPrivacyPolicy_IsSet to false. |
public inline bool IsNeedsPrivacyPolicyDefaultValue () const | Returns true if NeedsPrivacyPolicy_Optional is set and matches the default value. |
public inline void SetNeedsPrivacyPolicyToDefault () | Sets the value of NeedsPrivacyPolicy_Optional to its default and also sets NeedsPrivacyPolicy_IsSet to true. |
Members
public bool
AuthSuccess_Optional
public bool
AuthSuccess_IsSet
true if AuthSuccess_Optional has been set to a value
public FString
ErrorCode
public FString
Desc
public bool
NeedsEula_Optional
Whether the user needs to accept the End User License Agreement.
public bool
NeedsEula_IsSet
true if NeedsEula_Optional has been set to a value
public bool
NeedsTos_Optional
Whether the user needs to accept the Terms of Service.
public bool
NeedsTos_IsSet
true if NeedsTos_Optional has been set to a value
public bool
NeedsPrivacyPolicy_Optional
Whether the user needs to accept the Privacy Policy.
public bool
NeedsPrivacyPolicy_IsSet
true if NeedsPrivacyPolicy_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 bool &
GetAuthSuccess
()
Gets the value of AuthSuccess_Optional, regardless of it having been set.
public inline const bool &
GetAuthSuccess
() const
Gets the value of AuthSuccess_Optional, regardless of it having been set.
public inline const bool &
GetAuthSuccess
(const bool & DefaultValue) const
Gets the value of AuthSuccess_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool
GetAuthSuccess
(bool & OutValue) const
Fills OutValue with the value of AuthSuccess_Optional and returns true if it has been set, otherwise returns false.
public inline bool *
GetAuthSuccessOrNull
()
Returns a pointer to AuthSuccess_Optional, if it has been set, otherwise returns nullptr.
public inline const bool *
GetAuthSuccessOrNull
() const
Returns a pointer to AuthSuccess_Optional, if it has been set, otherwise returns nullptr.
public inline void
SetAuthSuccess
(bool NewValue)
Sets the value of AuthSuccess_Optional and also sets AuthSuccess_IsSet to true.
public inline void
ClearAuthSuccess
()
Clears the value of AuthSuccess_Optional and sets AuthSuccess_IsSet to false.
public inline bool
IsAuthSuccessDefaultValue
() const
Returns true if AuthSuccess_Optional is set and matches the default value.
public inline void
SetAuthSuccessToDefault
()
Sets the value of AuthSuccess_Optional to its default and also sets AuthSuccess_IsSet to true.
public inline FString &
GetErrorCode
()
Gets the value of ErrorCode.
public inline const FString &
GetErrorCode
() const
Gets the value of ErrorCode.
public inline void
SetErrorCode
(FString NewValue)
Sets the value of ErrorCode.
public inline FString &
GetDesc
()
Gets the value of Desc.
public inline const FString &
GetDesc
() const
Gets the value of Desc.
public inline void
SetDesc
(FString NewValue)
Sets the value of Desc.
public inline bool &
GetNeedsEula
()
Gets the value of NeedsEula_Optional, regardless of it having been set.
public inline const bool &
GetNeedsEula
() const
Gets the value of NeedsEula_Optional, regardless of it having been set.
public inline const bool &
GetNeedsEula
(const bool & DefaultValue) const
Gets the value of NeedsEula_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool
GetNeedsEula
(bool & OutValue) const
Fills OutValue with the value of NeedsEula_Optional and returns true if it has been set, otherwise returns false.
public inline bool *
GetNeedsEulaOrNull
()
Returns a pointer to NeedsEula_Optional, if it has been set, otherwise returns nullptr.
public inline const bool *
GetNeedsEulaOrNull
() const
Returns a pointer to NeedsEula_Optional, if it has been set, otherwise returns nullptr.
public inline void
SetNeedsEula
(bool NewValue)
Sets the value of NeedsEula_Optional and also sets NeedsEula_IsSet to true.
public inline void
ClearNeedsEula
()
Clears the value of NeedsEula_Optional and sets NeedsEula_IsSet to false.
public inline bool
IsNeedsEulaDefaultValue
() const
Returns true if NeedsEula_Optional is set and matches the default value.
public inline void
SetNeedsEulaToDefault
()
Sets the value of NeedsEula_Optional to its default and also sets NeedsEula_IsSet to true.
public inline bool &
GetNeedsTos
()
Gets the value of NeedsTos_Optional, regardless of it having been set.
public inline const bool &
GetNeedsTos
() const
Gets the value of NeedsTos_Optional, regardless of it having been set.
public inline const bool &
GetNeedsTos
(const bool & DefaultValue) const
Gets the value of NeedsTos_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool
GetNeedsTos
(bool & OutValue) const
Fills OutValue with the value of NeedsTos_Optional and returns true if it has been set, otherwise returns false.
public inline bool *
GetNeedsTosOrNull
()
Returns a pointer to NeedsTos_Optional, if it has been set, otherwise returns nullptr.
public inline const bool *
GetNeedsTosOrNull
() const
Returns a pointer to NeedsTos_Optional, if it has been set, otherwise returns nullptr.
public inline void
SetNeedsTos
(bool NewValue)
Sets the value of NeedsTos_Optional and also sets NeedsTos_IsSet to true.
public inline void
ClearNeedsTos
()
Clears the value of NeedsTos_Optional and sets NeedsTos_IsSet to false.
public inline bool
IsNeedsTosDefaultValue
() const
Returns true if NeedsTos_Optional is set and matches the default value.
public inline void
SetNeedsTosToDefault
()
Sets the value of NeedsTos_Optional to its default and also sets NeedsTos_IsSet to true.
public inline bool &
GetNeedsPrivacyPolicy
()
Gets the value of NeedsPrivacyPolicy_Optional, regardless of it having been set.
public inline const bool &
GetNeedsPrivacyPolicy
() const
Gets the value of NeedsPrivacyPolicy_Optional, regardless of it having been set.
public inline const bool &
GetNeedsPrivacyPolicy
(const bool & DefaultValue) const
Gets the value of NeedsPrivacyPolicy_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool
GetNeedsPrivacyPolicy
(bool & OutValue) const
Fills OutValue with the value of NeedsPrivacyPolicy_Optional and returns true if it has been set, otherwise returns false.
public inline bool *
GetNeedsPrivacyPolicyOrNull
()
Returns a pointer to NeedsPrivacyPolicy_Optional, if it has been set, otherwise returns nullptr.
public inline const bool *
GetNeedsPrivacyPolicyOrNull
() const
Returns a pointer to NeedsPrivacyPolicy_Optional, if it has been set, otherwise returns nullptr.
public inline void
SetNeedsPrivacyPolicy
(bool NewValue)
Sets the value of NeedsPrivacyPolicy_Optional and also sets NeedsPrivacyPolicy_IsSet to true.
public inline void
ClearNeedsPrivacyPolicy
()
Clears the value of NeedsPrivacyPolicy_Optional and sets NeedsPrivacyPolicy_IsSet to false.
public inline bool
IsNeedsPrivacyPolicyDefaultValue
() const
Returns true if NeedsPrivacyPolicy_Optional is set and matches the default value.
public inline void
SetNeedsPrivacyPolicyToDefault
()
Sets the value of NeedsPrivacyPolicy_Optional to its default and also sets NeedsPrivacyPolicy_IsSet to true.