Skip to main content

RHAPI_DeserterUpdateRequest

Summary​

MembersDescriptions
struct FRHAPI_DeserterUpdateRequest

struct FRHAPI_DeserterUpdateRequest ​

struct FRHAPI_DeserterUpdateRequest
  : public FRHAPI_Model

Summary​

MembersDescriptions
public FDateTime DeserterExpirationDatetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.
public FDateTime DeserterReset_OptionalDatetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.
public bool DeserterReset_IsSettrue if DeserterReset_Optional has been set to a value
public int32 DeserterCountThe number of times a player has deserted before the expiration.
public TMap< FString, FString > CustomData_OptionalCustom data about a players desertion status.
public bool CustomData_IsSettrue if CustomData_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 & GetDeserterExpiration()Gets the value of DeserterExpiration.
public inline const FDateTime & GetDeserterExpiration() constGets the value of DeserterExpiration.
public inline void SetDeserterExpiration(const FDateTime & NewValue)Sets the value of DeserterExpiration.
public inline void SetDeserterExpiration(FDateTime && NewValue)Sets the value of DeserterExpiration using move semantics.
public inline FDateTime & GetDeserterReset()Gets the value of DeserterReset_Optional, regardless of it having been set.
public inline const FDateTime & GetDeserterReset() constGets the value of DeserterReset_Optional, regardless of it having been set.
public inline const FDateTime & GetDeserterReset(const FDateTime & DefaultValue) constGets the value of DeserterReset_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetDeserterReset(FDateTime & OutValue) constFills OutValue with the value of DeserterReset_Optional and returns true if it has been set, otherwise returns false.
public inline FDateTime * GetDeserterResetOrNull()Returns a pointer to DeserterReset_Optional, if it has been set, otherwise returns nullptr.
public inline const FDateTime * GetDeserterResetOrNull() constReturns a pointer to DeserterReset_Optional, if it has been set, otherwise returns nullptr.
public inline void SetDeserterReset(const FDateTime & NewValue)Sets the value of DeserterReset_Optional and also sets DeserterReset_IsSet to true.
public inline void SetDeserterReset(FDateTime && NewValue)Sets the value of DeserterReset_Optional and also sets DeserterReset_IsSet to true using move semantics.
public inline void ClearDeserterReset()Clears the value of DeserterReset_Optional and sets DeserterReset_IsSet to false.
public inline bool IsDeserterResetSet() constChecks whether DeserterReset_Optional has been set.
public inline int32 & GetDeserterCount()Gets the value of DeserterCount.
public inline const int32 & GetDeserterCount() constGets the value of DeserterCount.
public inline void SetDeserterCount(const int32 & NewValue)Sets the value of DeserterCount.
public inline void SetDeserterCount(int32 && NewValue)Sets the value of DeserterCount using move semantics.
public inline bool IsDeserterCountDefaultValue() constReturns true if DeserterCount matches the default value.
public inline void SetDeserterCountToDefault()Sets the value of DeserterCount to its default
public inline TMap< FString, FString > & GetCustomData()Gets the value of CustomData_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetCustomData() constGets the value of CustomData_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetCustomData(const TMap< FString, FString > & DefaultValue) constGets the value of CustomData_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetCustomData(TMap< FString, FString > & OutValue) constFills OutValue with the value of CustomData_Optional and returns true if it has been set, otherwise returns false.
public inline TMap< FString, FString > * GetCustomDataOrNull()Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
public inline const TMap< FString, FString > * GetCustomDataOrNull() constReturns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
public inline void SetCustomData(const TMap< FString, FString > & NewValue)Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.
public inline void SetCustomData(TMap< FString, FString > && NewValue)Sets the value of CustomData_Optional and also sets CustomData_IsSet to true using move semantics.
public inline void ClearCustomData()Clears the value of CustomData_Optional and sets CustomData_IsSet to false.
public inline bool IsCustomDataSet() constChecks whether CustomData_Optional has been set.

Members​

public FDateTime DeserterExpiration ​

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

public FDateTime DeserterReset_Optional ​

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

public bool DeserterReset_IsSet ​

true if DeserterReset_Optional has been set to a value

public int32 DeserterCount ​

The number of times a player has deserted before the expiration.

public TMap< FString, FString > CustomData_Optional ​

Custom data about a players desertion status.

public bool CustomData_IsSet ​

true if CustomData_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 & GetDeserterExpiration() ​

Gets the value of DeserterExpiration.

public inline const FDateTime & GetDeserterExpiration() const ​

Gets the value of DeserterExpiration.

public inline void SetDeserterExpiration(const FDateTime & NewValue) ​

Sets the value of DeserterExpiration.

public inline void SetDeserterExpiration(FDateTime && NewValue) ​

Sets the value of DeserterExpiration using move semantics.

public inline FDateTime & GetDeserterReset() ​

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

public inline const FDateTime & GetDeserterReset() const ​

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

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

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

public inline bool GetDeserterReset(FDateTime & OutValue) const ​

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

public inline FDateTime * GetDeserterResetOrNull() ​

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

public inline const FDateTime * GetDeserterResetOrNull() const ​

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

public inline void SetDeserterReset(const FDateTime & NewValue) ​

Sets the value of DeserterReset_Optional and also sets DeserterReset_IsSet to true.

public inline void SetDeserterReset(FDateTime && NewValue) ​

Sets the value of DeserterReset_Optional and also sets DeserterReset_IsSet to true using move semantics.

public inline void ClearDeserterReset() ​

Clears the value of DeserterReset_Optional and sets DeserterReset_IsSet to false.

public inline bool IsDeserterResetSet() const ​

Checks whether DeserterReset_Optional has been set.

public inline int32 & GetDeserterCount() ​

Gets the value of DeserterCount.

public inline const int32 & GetDeserterCount() const ​

Gets the value of DeserterCount.

public inline void SetDeserterCount(const int32 & NewValue) ​

Sets the value of DeserterCount.

public inline void SetDeserterCount(int32 && NewValue) ​

Sets the value of DeserterCount using move semantics.

public inline bool IsDeserterCountDefaultValue() const ​

Returns true if DeserterCount matches the default value.

public inline void SetDeserterCountToDefault() ​

Sets the value of DeserterCount to its default

public inline TMap< FString, FString > & GetCustomData() ​

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

public inline const TMap< FString, FString > & GetCustomData() const ​

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

public inline const TMap< FString, FString > & GetCustomData(const TMap< FString, FString > & DefaultValue) const ​

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

public inline bool GetCustomData(TMap< FString, FString > & OutValue) const ​

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

public inline TMap< FString, FString > * GetCustomDataOrNull() ​

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

public inline const TMap< FString, FString > * GetCustomDataOrNull() const ​

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

public inline void SetCustomData(const TMap< FString, FString > & NewValue) ​

Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.

public inline void SetCustomData(TMap< FString, FString > && NewValue) ​

Sets the value of CustomData_Optional and also sets CustomData_IsSet to true using move semantics.

public inline void ClearCustomData() ​

Clears the value of CustomData_Optional and sets CustomData_IsSet to false.

public inline bool IsCustomDataSet() const ​

Checks whether CustomData_Optional has been set.