RHAPI_CreatePlatformUserRequest
Summary
Members | Descriptions |
---|---|
struct FRHAPI_CreatePlatformUserRequest | Request parameters to create a user exists. |
struct FRHAPI_CreatePlatformUserRequest
Request parameters to create a user exists.
Summary
Members | Descriptions |
---|---|
public ERHAPI_Platform Platform | Platform to create with. |
public FString PlatformUserId | Platform user ID to create with. |
public FString DisplayName_Optional | Display name used when creating a new player. |
public bool DisplayName_IsSet | true if DisplayName_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_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. |
Members
public ERHAPI_Platform
Platform
Platform to create with.
public FString
PlatformUserId
Platform user ID to create with.
public FString
DisplayName_Optional
Display name used when creating a new player.
public bool
DisplayName_IsSet
true if DisplayName_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.