Skip to content

RHAPI_PlatformUserResponse

Summary

MembersDescriptions
struct FRHAPI_PlatformUserResponseResponse for successfully creating a platform user.

struct FRHAPI_PlatformUserResponse

struct FRHAPI_PlatformUserResponse
: public FRHAPI_Model

Response for successfully creating a platform user.

Summary

MembersDescriptions
public ERHAPI_Platform PlatformPlatform to search/create with.
public FString PlatformUserIdPlatform user ID to search/create with.
public FString DisplayName_OptionalPlatform Display name.
public bool DisplayName_IsSettrue if DisplayName_Optional has been set to a value
public int32 PlayerIdPlayer ID DEPRECATED use player_uuid instead.
public FGuid PlayerUuidPlayer UUID.
public FGuid PersonIdPerson ID.
public int32 ActivePlayerId_OptionalDEPRECATED use active_player_uuid instead. Active player ID, if the player has an active player.
public bool ActivePlayerId_IsSettrue if ActivePlayerId_Optional has been set to a value
public FGuid ActivePlayerUuid_OptionalActive player UUID, if the player has an active player.
public bool ActivePlayerUuid_IsSettrue if ActivePlayerUuid_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 ERHAPI_Platform & GetPlatform()Gets the value of Platform.
public inline const ERHAPI_Platform & GetPlatform() constGets the value of Platform.
public inline void SetPlatform(ERHAPI_Platform NewValue)Sets the value of Platform.
public inline FString & GetPlatformUserId()Gets the value of PlatformUserId.
public inline const FString & GetPlatformUserId() constGets the value of PlatformUserId.
public inline void SetPlatformUserId(FString NewValue)Sets the value of PlatformUserId.
public inline FString & GetDisplayName()Gets the value of DisplayName_Optional, regardless of it having been set.
public inline const FString & GetDisplayName() constGets the value of DisplayName_Optional, regardless of it having been set.
public inline const FString & GetDisplayName(const FString & DefaultValue) constGets the value of DisplayName_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetDisplayName(FString & OutValue) constFills OutValue with the value of DisplayName_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetDisplayNameOrNull()Returns a pointer to DisplayName_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetDisplayNameOrNull() constReturns a pointer to DisplayName_Optional, if it has been set, otherwise returns nullptr.
public inline void SetDisplayName(FString NewValue)Sets the value of DisplayName_Optional and also sets DisplayName_IsSet to true.
public inline void ClearDisplayName()Clears the value of DisplayName_Optional and sets DisplayName_IsSet to false.
public inline int32 & GetPlayerId()Gets the value of PlayerId.
public inline const int32 & GetPlayerId() constGets the value of PlayerId.
public inline void SetPlayerId(int32 NewValue)Sets the value of PlayerId.
public inline bool IsPlayerIdDefaultValue() constReturns true if PlayerId matches the default value.
public inline void SetPlayerIdToDefault()Sets the value of PlayerId to its default
public inline FGuid & GetPlayerUuid()Gets the value of PlayerUuid.
public inline const FGuid & GetPlayerUuid() constGets the value of PlayerUuid.
public inline void SetPlayerUuid(FGuid NewValue)Sets the value of PlayerUuid.
public inline FGuid & GetPersonId()Gets the value of PersonId.
public inline const FGuid & GetPersonId() constGets the value of PersonId.
public inline void SetPersonId(FGuid NewValue)Sets the value of PersonId.
public inline int32 & GetActivePlayerId()Gets the value of ActivePlayerId_Optional, regardless of it having been set.
public inline const int32 & GetActivePlayerId() constGets the value of ActivePlayerId_Optional, regardless of it having been set.
public inline const int32 & GetActivePlayerId(const int32 & DefaultValue) constGets the value of ActivePlayerId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetActivePlayerId(int32 & OutValue) constFills OutValue with the value of ActivePlayerId_Optional and returns true if it has been set, otherwise returns false.
public inline int32 * GetActivePlayerIdOrNull()Returns a pointer to ActivePlayerId_Optional, if it has been set, otherwise returns nullptr.
public inline const int32 * GetActivePlayerIdOrNull() constReturns a pointer to ActivePlayerId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetActivePlayerId(int32 NewValue)Sets the value of ActivePlayerId_Optional and also sets ActivePlayerId_IsSet to true.
public inline void ClearActivePlayerId()Clears the value of ActivePlayerId_Optional and sets ActivePlayerId_IsSet to false.
public inline bool IsActivePlayerIdDefaultValue() constReturns true if ActivePlayerId_Optional is set and matches the default value.
public inline void SetActivePlayerIdToDefault()Sets the value of ActivePlayerId_Optional to its default and also sets ActivePlayerId_IsSet to true.
public inline FGuid & GetActivePlayerUuid()Gets the value of ActivePlayerUuid_Optional, regardless of it having been set.
public inline const FGuid & GetActivePlayerUuid() constGets the value of ActivePlayerUuid_Optional, regardless of it having been set.
public inline const FGuid & GetActivePlayerUuid(const FGuid & DefaultValue) constGets the value of ActivePlayerUuid_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetActivePlayerUuid(FGuid & OutValue) constFills OutValue with the value of ActivePlayerUuid_Optional and returns true if it has been set, otherwise returns false.
public inline FGuid * GetActivePlayerUuidOrNull()Returns a pointer to ActivePlayerUuid_Optional, if it has been set, otherwise returns nullptr.
public inline const FGuid * GetActivePlayerUuidOrNull() constReturns a pointer to ActivePlayerUuid_Optional, if it has been set, otherwise returns nullptr.
public inline void SetActivePlayerUuid(FGuid NewValue)Sets the value of ActivePlayerUuid_Optional and also sets ActivePlayerUuid_IsSet to true.
public inline void ClearActivePlayerUuid()Clears the value of ActivePlayerUuid_Optional and sets ActivePlayerUuid_IsSet to false.

Members

public ERHAPI_Platform Platform

Platform to search/create with.

public FString PlatformUserId

Platform user ID to search/create with.

public FString DisplayName_Optional

Platform Display name.

public bool DisplayName_IsSet

true if DisplayName_Optional has been set to a value

public int32 PlayerId

Player ID DEPRECATED use player_uuid instead.

public FGuid PlayerUuid

Player UUID.

public FGuid PersonId

Person ID.

public int32 ActivePlayerId_Optional

DEPRECATED use active_player_uuid instead. Active player ID, if the player has an active player.

public bool ActivePlayerId_IsSet

true if ActivePlayerId_Optional has been set to a value

public FGuid ActivePlayerUuid_Optional

Active player UUID, if the player has an active player.

public bool ActivePlayerUuid_IsSet

true if ActivePlayerUuid_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_Platform & GetPlatform()

Gets the value of Platform.

public inline const ERHAPI_Platform & GetPlatform() const

Gets the value of Platform.

public inline void SetPlatform(ERHAPI_Platform NewValue)

Sets the value of Platform.

public inline FString & GetPlatformUserId()

Gets the value of PlatformUserId.

public inline const FString & GetPlatformUserId() const

Gets the value of PlatformUserId.

public inline void SetPlatformUserId(FString NewValue)

Sets the value of PlatformUserId.

public inline FString & GetDisplayName()

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

public inline const FString & GetDisplayName() const

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

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

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

public inline bool GetDisplayName(FString & OutValue) const

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

public inline FString * GetDisplayNameOrNull()

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

public inline const FString * GetDisplayNameOrNull() const

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

public inline void SetDisplayName(FString NewValue)

Sets the value of DisplayName_Optional and also sets DisplayName_IsSet to true.

public inline void ClearDisplayName()

Clears the value of DisplayName_Optional and sets DisplayName_IsSet to false.

public inline int32 & GetPlayerId()

Gets the value of PlayerId.

public inline const int32 & GetPlayerId() const

Gets the value of PlayerId.

public inline void SetPlayerId(int32 NewValue)

Sets the value of PlayerId.

public inline bool IsPlayerIdDefaultValue() const

Returns true if PlayerId matches the default value.

public inline void SetPlayerIdToDefault()

Sets the value of PlayerId to its default

public inline FGuid & GetPlayerUuid()

Gets the value of PlayerUuid.

public inline const FGuid & GetPlayerUuid() const

Gets the value of PlayerUuid.

public inline void SetPlayerUuid(FGuid NewValue)

Sets the value of PlayerUuid.

public inline FGuid & GetPersonId()

Gets the value of PersonId.

public inline const FGuid & GetPersonId() const

Gets the value of PersonId.

public inline void SetPersonId(FGuid NewValue)

Sets the value of PersonId.

public inline int32 & GetActivePlayerId()

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

public inline const int32 & GetActivePlayerId() const

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

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

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

public inline bool GetActivePlayerId(int32 & OutValue) const

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

public inline int32 * GetActivePlayerIdOrNull()

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

public inline const int32 * GetActivePlayerIdOrNull() const

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

public inline void SetActivePlayerId(int32 NewValue)

Sets the value of ActivePlayerId_Optional and also sets ActivePlayerId_IsSet to true.

public inline void ClearActivePlayerId()

Clears the value of ActivePlayerId_Optional and sets ActivePlayerId_IsSet to false.

public inline bool IsActivePlayerIdDefaultValue() const

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

public inline void SetActivePlayerIdToDefault()

Sets the value of ActivePlayerId_Optional to its default and also sets ActivePlayerId_IsSet to true.

public inline FGuid & GetActivePlayerUuid()

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

public inline const FGuid & GetActivePlayerUuid() const

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

public inline const FGuid & GetActivePlayerUuid(const FGuid & DefaultValue) const

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

public inline bool GetActivePlayerUuid(FGuid & OutValue) const

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

public inline FGuid * GetActivePlayerUuidOrNull()

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

public inline const FGuid * GetActivePlayerUuidOrNull() const

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

public inline void SetActivePlayerUuid(FGuid NewValue)

Sets the value of ActivePlayerUuid_Optional and also sets ActivePlayerUuid_IsSet to true.

public inline void ClearActivePlayerUuid()

Clears the value of ActivePlayerUuid_Optional and sets ActivePlayerUuid_IsSet to false.