RHAPI_ClientVisibleSettings
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_ClientVisibleSettings |
struct FRHAPI_ClientVisibleSettings
struct FRHAPI_ClientVisibleSettings
: public FRHAPI_ModelSummary
| Members | Descriptions |
|---|---|
public int32 SelfPingIntervalSeconds_Optional | How frequently the client should tell this service that it’s online. |
public bool SelfPingIntervalSeconds_IsSet | true if SelfPingIntervalSeconds_Optional has been set to a value |
public int32 LastSeenAgeConsideredOfflineSeconds_Optional | If a client hasn’t said that it’s online within this time period, it will be treated as offline when others query its presence. |
public bool LastSeenAgeConsideredOfflineSeconds_IsSet | true if LastSeenAgeConsideredOfflineSeconds_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 int32 & GetSelfPingIntervalSeconds() | Gets the value of SelfPingIntervalSeconds_Optional, regardless of it having been set. |
public inline const int32 & GetSelfPingIntervalSeconds() const | Gets the value of SelfPingIntervalSeconds_Optional, regardless of it having been set. |
public inline const int32 & GetSelfPingIntervalSeconds(const int32 & DefaultValue) const | Gets the value of SelfPingIntervalSeconds_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetSelfPingIntervalSeconds(int32 & OutValue) const | Fills OutValue with the value of SelfPingIntervalSeconds_Optional and returns true if it has been set, otherwise returns false. |
public inline int32 * GetSelfPingIntervalSecondsOrNull() | Returns a pointer to SelfPingIntervalSeconds_Optional, if it has been set, otherwise returns nullptr. |
public inline const int32 * GetSelfPingIntervalSecondsOrNull() const | Returns a pointer to SelfPingIntervalSeconds_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetSelfPingIntervalSeconds(int32 NewValue) | Sets the value of SelfPingIntervalSeconds_Optional and also sets SelfPingIntervalSeconds_IsSet to true. |
public inline void ClearSelfPingIntervalSeconds() | Clears the value of SelfPingIntervalSeconds_Optional and sets SelfPingIntervalSeconds_IsSet to false. |
public inline bool IsSelfPingIntervalSecondsDefaultValue() const | Returns true if SelfPingIntervalSeconds_Optional is set and matches the default value. |
public inline void SetSelfPingIntervalSecondsToDefault() | Sets the value of SelfPingIntervalSeconds_Optional to its default and also sets SelfPingIntervalSeconds_IsSet to true. |
public inline int32 & GetLastSeenAgeConsideredOfflineSeconds() | Gets the value of LastSeenAgeConsideredOfflineSeconds_Optional, regardless of it having been set. |
public inline const int32 & GetLastSeenAgeConsideredOfflineSeconds() const | Gets the value of LastSeenAgeConsideredOfflineSeconds_Optional, regardless of it having been set. |
public inline const int32 & GetLastSeenAgeConsideredOfflineSeconds(const int32 & DefaultValue) const | Gets the value of LastSeenAgeConsideredOfflineSeconds_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetLastSeenAgeConsideredOfflineSeconds(int32 & OutValue) const | Fills OutValue with the value of LastSeenAgeConsideredOfflineSeconds_Optional and returns true if it has been set, otherwise returns false. |
public inline int32 * GetLastSeenAgeConsideredOfflineSecondsOrNull() | Returns a pointer to LastSeenAgeConsideredOfflineSeconds_Optional, if it has been set, otherwise returns nullptr. |
public inline const int32 * GetLastSeenAgeConsideredOfflineSecondsOrNull() const | Returns a pointer to LastSeenAgeConsideredOfflineSeconds_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetLastSeenAgeConsideredOfflineSeconds(int32 NewValue) | Sets the value of LastSeenAgeConsideredOfflineSeconds_Optional and also sets LastSeenAgeConsideredOfflineSeconds_IsSet to true. |
public inline void ClearLastSeenAgeConsideredOfflineSeconds() | Clears the value of LastSeenAgeConsideredOfflineSeconds_Optional and sets LastSeenAgeConsideredOfflineSeconds_IsSet to false. |
public inline bool IsLastSeenAgeConsideredOfflineSecondsDefaultValue() const | Returns true if LastSeenAgeConsideredOfflineSeconds_Optional is set and matches the default value. |
public inline void SetLastSeenAgeConsideredOfflineSecondsToDefault() | Sets the value of LastSeenAgeConsideredOfflineSeconds_Optional to its default and also sets LastSeenAgeConsideredOfflineSeconds_IsSet to true. |
Members
public int32 SelfPingIntervalSeconds_Optional
How frequently the client should tell this service that it’s online.
public bool SelfPingIntervalSeconds_IsSet
true if SelfPingIntervalSeconds_Optional has been set to a value
public int32 LastSeenAgeConsideredOfflineSeconds_Optional
If a client hasn’t said that it’s online within this time period, it will be treated as offline when others query its presence.
public bool LastSeenAgeConsideredOfflineSeconds_IsSet
true if LastSeenAgeConsideredOfflineSeconds_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
JsonValueData 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
WriterJSON Writer stream to push .
public inline int32 & GetSelfPingIntervalSeconds()
Gets the value of SelfPingIntervalSeconds_Optional, regardless of it having been set.
public inline const int32 & GetSelfPingIntervalSeconds() const
Gets the value of SelfPingIntervalSeconds_Optional, regardless of it having been set.
public inline const int32 & GetSelfPingIntervalSeconds(const int32 & DefaultValue) const
Gets the value of SelfPingIntervalSeconds_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetSelfPingIntervalSeconds(int32 & OutValue) const
Fills OutValue with the value of SelfPingIntervalSeconds_Optional and returns true if it has been set, otherwise returns false.
public inline int32 * GetSelfPingIntervalSecondsOrNull()
Returns a pointer to SelfPingIntervalSeconds_Optional, if it has been set, otherwise returns nullptr.
public inline const int32 * GetSelfPingIntervalSecondsOrNull() const
Returns a pointer to SelfPingIntervalSeconds_Optional, if it has been set, otherwise returns nullptr.
public inline void SetSelfPingIntervalSeconds(int32 NewValue)
Sets the value of SelfPingIntervalSeconds_Optional and also sets SelfPingIntervalSeconds_IsSet to true.
public inline void ClearSelfPingIntervalSeconds()
Clears the value of SelfPingIntervalSeconds_Optional and sets SelfPingIntervalSeconds_IsSet to false.
public inline bool IsSelfPingIntervalSecondsDefaultValue() const
Returns true if SelfPingIntervalSeconds_Optional is set and matches the default value.
public inline void SetSelfPingIntervalSecondsToDefault()
Sets the value of SelfPingIntervalSeconds_Optional to its default and also sets SelfPingIntervalSeconds_IsSet to true.
public inline int32 & GetLastSeenAgeConsideredOfflineSeconds()
Gets the value of LastSeenAgeConsideredOfflineSeconds_Optional, regardless of it having been set.
public inline const int32 & GetLastSeenAgeConsideredOfflineSeconds() const
Gets the value of LastSeenAgeConsideredOfflineSeconds_Optional, regardless of it having been set.
public inline const int32 & GetLastSeenAgeConsideredOfflineSeconds(const int32 & DefaultValue) const
Gets the value of LastSeenAgeConsideredOfflineSeconds_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetLastSeenAgeConsideredOfflineSeconds(int32 & OutValue) const
Fills OutValue with the value of LastSeenAgeConsideredOfflineSeconds_Optional and returns true if it has been set, otherwise returns false.
public inline int32 * GetLastSeenAgeConsideredOfflineSecondsOrNull()
Returns a pointer to LastSeenAgeConsideredOfflineSeconds_Optional, if it has been set, otherwise returns nullptr.
public inline const int32 * GetLastSeenAgeConsideredOfflineSecondsOrNull() const
Returns a pointer to LastSeenAgeConsideredOfflineSeconds_Optional, if it has been set, otherwise returns nullptr.
public inline void SetLastSeenAgeConsideredOfflineSeconds(int32 NewValue)
Sets the value of LastSeenAgeConsideredOfflineSeconds_Optional and also sets LastSeenAgeConsideredOfflineSeconds_IsSet to true.
public inline void ClearLastSeenAgeConsideredOfflineSeconds()
Clears the value of LastSeenAgeConsideredOfflineSeconds_Optional and sets LastSeenAgeConsideredOfflineSeconds_IsSet to false.
public inline bool IsLastSeenAgeConsideredOfflineSecondsDefaultValue() const
Returns true if LastSeenAgeConsideredOfflineSeconds_Optional is set and matches the default value.
public inline void SetLastSeenAgeConsideredOfflineSecondsToDefault()
Sets the value of LastSeenAgeConsideredOfflineSeconds_Optional to its default and also sets LastSeenAgeConsideredOfflineSeconds_IsSet to true.