Skip to content

RHAPI_PurgeRequest

Summary

MembersDescriptions
struct FRHAPI_PurgeRequestPurge 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

MembersDescriptions
public FDateTime SuggestedPurgeTime_OptionalDatetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.
public bool SuggestedPurgeTime_IsSettrue 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) constWrites 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() constGets the value of SuggestedPurgeTime_Optional, regardless of it having been set.
public inline const FDateTime & GetSuggestedPurgeTime(const FDateTime & DefaultValue) constGets the value of SuggestedPurgeTime_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetSuggestedPurgeTime(FDateTime & OutValue) constFills 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() constReturns 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`](#structFRHAPI__PurgeRequest_1aeebdf2921a2e20d78da7649f9942d975)

true if SuggestedPurgeTime_Optional has been set to a value


#### `public virtual bool `[`FromJson`](#structFRHAPI__PurgeRequest_1ae2926f8ed4d7ada3270a24fa22581b04)`(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`](#structFRHAPI__PurgeRequest_1a9f8aea049ea3ea3f3804fed6fc4af285)`(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`](#structFRHAPI__PurgeRequest_1a90f105ad324cb69521d1fb64afccdb9d)`()`

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


#### `public inline const FDateTime & `[`GetSuggestedPurgeTime`](#structFRHAPI__PurgeRequest_1aa373f9ebde40d495c28fd2d85fec7e08)`() const`

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


#### `public inline const FDateTime & `[`GetSuggestedPurgeTime`](#structFRHAPI__PurgeRequest_1aa77827115c501ea8218a1feb85aa1168)`(const FDateTime & DefaultValue) const`

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


#### `public inline bool `[`GetSuggestedPurgeTime`](#structFRHAPI__PurgeRequest_1a809a8c516d3eddc8691bd59e3bdae36a)`(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`](#structFRHAPI__PurgeRequest_1ada5179545649871f9f6f1f67241de802)`()`

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


#### `public inline const FDateTime * `[`GetSuggestedPurgeTimeOrNull`](#structFRHAPI__PurgeRequest_1a8c060bac1f0fb9d171a069be84fd27a6)`() const`

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


#### `public inline void `[`SetSuggestedPurgeTime`](#structFRHAPI__PurgeRequest_1a984eb6ce9ebd05540f22ef48a4481a66)`(FDateTime NewValue)`

Sets the value of SuggestedPurgeTime_Optional and also sets SuggestedPurgeTime_IsSet to true.


#### `public inline void `[`ClearSuggestedPurgeTime`](#structFRHAPI__PurgeRequest_1a90e1c3b323ef9c0d6582d92a4ba4b990)`()`

Clears the value of SuggestedPurgeTime_Optional and sets SuggestedPurgeTime_IsSet to false.