RHAPI_PurgeRequest
Summary
Members | Descriptions |
---|---|
struct FRHAPI_PurgeRequest | Purge request to purge a person from the system. This will remove all data about that player from the system. |
struct FRHAPI_PurgeRequest
struct FRHAPI_PurgeRequest : public FRHAPI_Model
Purge request to purge a person from the system. This will remove all data about that player from the system.
Summary
Members | Descriptions |
---|---|
public FDateTime SuggestedPurgeTime_Optional | Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone. |
public bool SuggestedPurgeTime_IsSet | true if SuggestedPurgeTime_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 FDateTime & GetSuggestedPurgeTime () | Gets the value of SuggestedPurgeTime_Optional, regardless of it having been set. |
public inline const FDateTime & GetSuggestedPurgeTime () const | Gets the value of SuggestedPurgeTime_Optional, regardless of it having been set. |
public inline const FDateTime & GetSuggestedPurgeTime (const FDateTime & DefaultValue) const | Gets the value of SuggestedPurgeTime_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetSuggestedPurgeTime (FDateTime & OutValue) const | Fills OutValue with the value of SuggestedPurgeTime_Optional and returns true if it has been set, otherwise returns false. |
public inline FDateTime * GetSuggestedPurgeTimeOrNull () | Returns a pointer to SuggestedPurgeTime_Optional, if it has been set, otherwise returns nullptr. |
public inline const FDateTime * GetSuggestedPurgeTimeOrNull () const | Returns a pointer to SuggestedPurgeTime_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetSuggestedPurgeTime (FDateTime NewValue) | Sets the value of SuggestedPurgeTime_Optional and also sets SuggestedPurgeTime_IsSet to true. |
public inline void ClearSuggestedPurgeTime () | Clears the value of SuggestedPurgeTime_Optional and sets SuggestedPurgeTime_IsSet to false. |
Members
public FDateTime
SuggestedPurgeTime_Optional
Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.
public bool
SuggestedPurgeTime_IsSet
true if SuggestedPurgeTime_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 FDateTime &
GetSuggestedPurgeTime
()
Gets the value of SuggestedPurgeTime_Optional, regardless of it having been set.
public inline const FDateTime &
GetSuggestedPurgeTime
() const
Gets the value of SuggestedPurgeTime_Optional, regardless of it having been set.
public inline const FDateTime &
GetSuggestedPurgeTime
(const FDateTime & DefaultValue) const
Gets the value of SuggestedPurgeTime_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool
GetSuggestedPurgeTime
(FDateTime & OutValue) const
Fills OutValue with the value of SuggestedPurgeTime_Optional and returns true if it has been set, otherwise returns false.
public inline FDateTime *
GetSuggestedPurgeTimeOrNull
()
Returns a pointer to SuggestedPurgeTime_Optional, if it has been set, otherwise returns nullptr.
public inline const FDateTime *
GetSuggestedPurgeTimeOrNull
() const
Returns a pointer to SuggestedPurgeTime_Optional, if it has been set, otherwise returns nullptr.
public inline void
SetSuggestedPurgeTime
(FDateTime NewValue)
Sets the value of SuggestedPurgeTime_Optional and also sets SuggestedPurgeTime_IsSet to true.
public inline void
ClearSuggestedPurgeTime
()
Clears the value of SuggestedPurgeTime_Optional and sets SuggestedPurgeTime_IsSet to false.