RHAPI_Restriction

Summary

Members	Descriptions
struct FRHAPI_Restriction	Restriction applied to a player.

struct FRHAPI_Restriction

struct FRHAPI_Restriction
  : public FRHAPI_Model

Restriction applied to a player.

Summary

Members	Descriptions
public ERHAPI_RestrictionType Type	Type of restriction.
public FString Reason_Optional	Reason the restriction was applied.
public bool Reason_IsSet	true if Reason_Optional has been set to a value
public FDateTime Expiration_Optional	Date the restriction expires. Null means the restriction is permanent.
public bool Expiration_IsSet	true if Expiration_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 ERHAPI_RestrictionType & GetType()	Gets the value of Type.
public inline const ERHAPI_RestrictionType & GetType() const	Gets the value of Type.
public inline void SetType(ERHAPI_RestrictionType NewValue)	Sets the value of Type.
public inline FString & GetReason()	Gets the value of Reason_Optional, regardless of it having been set.
public inline const FString & GetReason() const	Gets the value of Reason_Optional, regardless of it having been set.
public inline const FString & GetReason(const FString & DefaultValue) const	Gets the value of Reason_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetReason(FString & OutValue) const	Fills OutValue with the value of Reason_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetReasonOrNull()	Returns a pointer to Reason_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetReasonOrNull() const	Returns a pointer to Reason_Optional, if it has been set, otherwise returns nullptr.
public inline void SetReason(FString NewValue)	Sets the value of Reason_Optional and also sets Reason_IsSet to true.
public inline void ClearReason()	Clears the value of Reason_Optional and sets Reason_IsSet to false.
public inline FDateTime & GetExpiration()	Gets the value of Expiration_Optional, regardless of it having been set.
public inline const FDateTime & GetExpiration() const	Gets the value of Expiration_Optional, regardless of it having been set.
public inline const FDateTime & GetExpiration(const FDateTime & DefaultValue) const	Gets the value of Expiration_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetExpiration(FDateTime & OutValue) const	Fills OutValue with the value of Expiration_Optional and returns true if it has been set, otherwise returns false.
public inline FDateTime * GetExpirationOrNull()	Returns a pointer to Expiration_Optional, if it has been set, otherwise returns nullptr.
public inline const FDateTime * GetExpirationOrNull() const	Returns a pointer to Expiration_Optional, if it has been set, otherwise returns nullptr.
public inline void SetExpiration(FDateTime NewValue)	Sets the value of Expiration_Optional and also sets Expiration_IsSet to true.
public inline void ClearExpiration()	Clears the value of Expiration_Optional and sets Expiration_IsSet to false.

Members

public ERHAPI_RestrictionType Type

Type of restriction.

public FString Reason_Optional

Reason the restriction was applied.

public bool Reason_IsSet

true if Reason_Optional has been set to a value

public FDateTime Expiration_Optional

Date the restriction expires. Null means the restriction is permanent.

public bool Expiration_IsSet

true if Expiration_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 ERHAPI_RestrictionType & GetType()

Gets the value of Type.

public inline const ERHAPI_RestrictionType & GetType() const

Gets the value of Type.

public inline void SetType(ERHAPI_RestrictionType NewValue)

Sets the value of Type.

public inline FString & GetReason()

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

public inline const FString & GetReason() const

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

public inline const FString & GetReason(const FString & DefaultValue) const

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

public inline bool GetReason(FString & OutValue) const

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

public inline FString * GetReasonOrNull()

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

public inline const FString * GetReasonOrNull() const

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

public inline void SetReason(FString NewValue)

Sets the value of Reason_Optional and also sets Reason_IsSet to true.

public inline void ClearReason()

Clears the value of Reason_Optional and sets Reason_IsSet to false.

public inline FDateTime & GetExpiration()

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

public inline const FDateTime & GetExpiration() const

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

public inline const FDateTime & GetExpiration(const FDateTime & DefaultValue) const

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

public inline bool GetExpiration(FDateTime & OutValue) const

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

public inline FDateTime * GetExpirationOrNull()

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

public inline const FDateTime * GetExpirationOrNull() const

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

public inline void SetExpiration(FDateTime NewValue)

Sets the value of Expiration_Optional and also sets Expiration_IsSet to true.

public inline void ClearExpiration()

Clears the value of Expiration_Optional and sets Expiration_IsSet to false.