Skip to content

RHAPI_FriendsApiConfig

Summary

MembersDescriptions
struct FRHAPI_FriendsApiConfig

struct FRHAPI_FriendsApiConfig

struct FRHAPI_FriendsApiConfig
: public FRHAPI_Model

Summary

MembersDescriptions
public int32 FriendLimit_OptionalMaximum number of friends a user can have.
public bool FriendLimit_IsSettrue if FriendLimit_Optional has been set to a value
public int32 BlockLimit_OptionalMaximum number of blocked users a user can have.
public bool BlockLimit_IsSettrue if BlockLimit_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 int32 & GetFriendLimit()Gets the value of FriendLimit_Optional, regardless of it having been set.
public inline const int32 & GetFriendLimit() constGets the value of FriendLimit_Optional, regardless of it having been set.
public inline const int32 & GetFriendLimit(const int32 & DefaultValue) constGets the value of FriendLimit_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetFriendLimit(int32 & OutValue) constFills OutValue with the value of FriendLimit_Optional and returns true if it has been set, otherwise returns false.
public inline int32 * GetFriendLimitOrNull()Returns a pointer to FriendLimit_Optional, if it has been set, otherwise returns nullptr.
public inline const int32 * GetFriendLimitOrNull() constReturns a pointer to FriendLimit_Optional, if it has been set, otherwise returns nullptr.
public inline void SetFriendLimit(int32 NewValue)Sets the value of FriendLimit_Optional and also sets FriendLimit_IsSet to true.
public inline void ClearFriendLimit()Clears the value of FriendLimit_Optional and sets FriendLimit_IsSet to false.
public inline bool IsFriendLimitDefaultValue() constReturns true if FriendLimit_Optional is set and matches the default value.
public inline void SetFriendLimitToDefault()Sets the value of FriendLimit_Optional to its default and also sets FriendLimit_IsSet to true.
public inline int32 & GetBlockLimit()Gets the value of BlockLimit_Optional, regardless of it having been set.
public inline const int32 & GetBlockLimit() constGets the value of BlockLimit_Optional, regardless of it having been set.
public inline const int32 & GetBlockLimit(const int32 & DefaultValue) constGets the value of BlockLimit_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetBlockLimit(int32 & OutValue) constFills OutValue with the value of BlockLimit_Optional and returns true if it has been set, otherwise returns false.
public inline int32 * GetBlockLimitOrNull()Returns a pointer to BlockLimit_Optional, if it has been set, otherwise returns nullptr.
public inline const int32 * GetBlockLimitOrNull() constReturns a pointer to BlockLimit_Optional, if it has been set, otherwise returns nullptr.
public inline void SetBlockLimit(int32 NewValue)Sets the value of BlockLimit_Optional and also sets BlockLimit_IsSet to true.
public inline void ClearBlockLimit()Clears the value of BlockLimit_Optional and sets BlockLimit_IsSet to false.
public inline bool IsBlockLimitDefaultValue() constReturns true if BlockLimit_Optional is set and matches the default value.
public inline void SetBlockLimitToDefault()Sets the value of BlockLimit_Optional to its default and also sets BlockLimit_IsSet to true.

Members

public int32 FriendLimit_Optional

Maximum number of friends a user can have.

public bool FriendLimit_IsSet

true if FriendLimit_Optional has been set to a value

public int32 BlockLimit_Optional

Maximum number of blocked users a user can have.

public bool BlockLimit_IsSet

true if BlockLimit_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 int32 & GetFriendLimit()

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

public inline const int32 & GetFriendLimit() const

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

public inline const int32 & GetFriendLimit(const int32 & DefaultValue) const

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

public inline bool GetFriendLimit(int32 & OutValue) const

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

public inline int32 * GetFriendLimitOrNull()

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

public inline const int32 * GetFriendLimitOrNull() const

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

public inline void SetFriendLimit(int32 NewValue)

Sets the value of FriendLimit_Optional and also sets FriendLimit_IsSet to true.

public inline void ClearFriendLimit()

Clears the value of FriendLimit_Optional and sets FriendLimit_IsSet to false.

public inline bool IsFriendLimitDefaultValue() const

Returns true if FriendLimit_Optional is set and matches the default value.

public inline void SetFriendLimitToDefault()

Sets the value of FriendLimit_Optional to its default and also sets FriendLimit_IsSet to true.

public inline int32 & GetBlockLimit()

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

public inline const int32 & GetBlockLimit() const

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

public inline const int32 & GetBlockLimit(const int32 & DefaultValue) const

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

public inline bool GetBlockLimit(int32 & OutValue) const

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

public inline int32 * GetBlockLimitOrNull()

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

public inline const int32 * GetBlockLimitOrNull() const

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

public inline void SetBlockLimit(int32 NewValue)

Sets the value of BlockLimit_Optional and also sets BlockLimit_IsSet to true.

public inline void ClearBlockLimit()

Clears the value of BlockLimit_Optional and sets BlockLimit_IsSet to false.

public inline bool IsBlockLimitDefaultValue() const

Returns true if BlockLimit_Optional is set and matches the default value.

public inline void SetBlockLimitToDefault()

Sets the value of BlockLimit_Optional to its default and also sets BlockLimit_IsSet to true.