Skip to main content

RHAPI_PlatformUserOperationRequest

Summary​

MembersDescriptions
struct FRHAPI_PlatformUserOperationRequestModel for doing operations on a specific platform user. If platform/userid information is not provided, the information from the token claims will be used instead.

struct FRHAPI_PlatformUserOperationRequest ​

struct FRHAPI_PlatformUserOperationRequest
  : public FRHAPI_Model

Model for doing operations on a specific platform user. If platform/userid information is not provided, the information from the token claims will be used instead.

Summary​

MembersDescriptions
public ERHAPI_Platform Platform_OptionalPlatform ID.
public bool Platform_IsSettrue if Platform_Optional has been set to a value
public FString PlatformUserId_OptionalPlatform User ID.
public bool PlatformUserId_IsSettrue if PlatformUserId_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_Optional, regardless of it having been set.
public inline const ERHAPI_Platform & GetPlatform() constGets the value of Platform_Optional, regardless of it having been set.
public inline const ERHAPI_Platform & GetPlatform(const ERHAPI_Platform & DefaultValue) constGets the value of Platform_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetPlatform(ERHAPI_Platform & OutValue) constFills OutValue with the value of Platform_Optional and returns true if it has been set, otherwise returns false.
public inline ERHAPI_Platform * GetPlatformOrNull()Returns a pointer to Platform_Optional, if it has been set, otherwise returns nullptr.
public inline const ERHAPI_Platform * GetPlatformOrNull() constReturns a pointer to Platform_Optional, if it has been set, otherwise returns nullptr.
public inline void SetPlatform(const ERHAPI_Platform & NewValue)Sets the value of Platform_Optional and also sets Platform_IsSet to true.
public inline void SetPlatform(ERHAPI_Platform && NewValue)Sets the value of Platform_Optional and also sets Platform_IsSet to true using move semantics.
public inline void ClearPlatform()Clears the value of Platform_Optional and sets Platform_IsSet to false.
public inline bool IsPlatformSet() constChecks whether Platform_Optional has been set.
public inline FString & GetPlatformUserId()Gets the value of PlatformUserId_Optional, regardless of it having been set.
public inline const FString & GetPlatformUserId() constGets the value of PlatformUserId_Optional, regardless of it having been set.
public inline const FString & GetPlatformUserId(const FString & DefaultValue) constGets the value of PlatformUserId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetPlatformUserId(FString & OutValue) constFills OutValue with the value of PlatformUserId_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetPlatformUserIdOrNull()Returns a pointer to PlatformUserId_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetPlatformUserIdOrNull() constReturns a pointer to PlatformUserId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetPlatformUserId(const FString & NewValue)Sets the value of PlatformUserId_Optional and also sets PlatformUserId_IsSet to true.
public inline void SetPlatformUserId(FString && NewValue)Sets the value of PlatformUserId_Optional and also sets PlatformUserId_IsSet to true using move semantics.
public inline void ClearPlatformUserId()Clears the value of PlatformUserId_Optional and sets PlatformUserId_IsSet to false.
public inline bool IsPlatformUserIdSet() constChecks whether PlatformUserId_Optional has been set.

Members​

public ERHAPI_Platform Platform_Optional ​

Platform ID.

public bool Platform_IsSet ​

true if Platform_Optional has been set to a value

public FString PlatformUserId_Optional ​

Platform User ID.

public bool PlatformUserId_IsSet ​

true if PlatformUserId_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_Optional, regardless of it having been set.

public inline const ERHAPI_Platform & GetPlatform() const ​

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

public inline const ERHAPI_Platform & GetPlatform(const ERHAPI_Platform & DefaultValue) const ​

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

public inline bool GetPlatform(ERHAPI_Platform & OutValue) const ​

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

public inline ERHAPI_Platform * GetPlatformOrNull() ​

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

public inline const ERHAPI_Platform * GetPlatformOrNull() const ​

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

public inline void SetPlatform(const ERHAPI_Platform & NewValue) ​

Sets the value of Platform_Optional and also sets Platform_IsSet to true.

public inline void SetPlatform(ERHAPI_Platform && NewValue) ​

Sets the value of Platform_Optional and also sets Platform_IsSet to true using move semantics.

public inline void ClearPlatform() ​

Clears the value of Platform_Optional and sets Platform_IsSet to false.

public inline bool IsPlatformSet() const ​

Checks whether Platform_Optional has been set.

public inline FString & GetPlatformUserId() ​

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

public inline const FString & GetPlatformUserId() const ​

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

public inline const FString & GetPlatformUserId(const FString & DefaultValue) const ​

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

public inline bool GetPlatformUserId(FString & OutValue) const ​

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

public inline FString * GetPlatformUserIdOrNull() ​

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

public inline const FString * GetPlatformUserIdOrNull() const ​

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

public inline void SetPlatformUserId(const FString & NewValue) ​

Sets the value of PlatformUserId_Optional and also sets PlatformUserId_IsSet to true.

public inline void SetPlatformUserId(FString && NewValue) ​

Sets the value of PlatformUserId_Optional and also sets PlatformUserId_IsSet to true using move semantics.

public inline void ClearPlatformUserId() ​

Clears the value of PlatformUserId_Optional and sets PlatformUserId_IsSet to false.

public inline bool IsPlatformUserIdSet() const ​

Checks whether PlatformUserId_Optional has been set.