Skip to main content

RHAPI_PortalUserInfo

Summary​

MembersDescriptions
struct FRHAPI_PortalUserInfoPortal user info.

struct FRHAPI_PortalUserInfo ​

struct FRHAPI_PortalUserInfo
: public FRHAPI_Model

Portal user info.

Summary​

MembersDescriptions
public ERHAPI_Platform PlatformPlatform for the user.
public ERHAPI_DependenciesSchemasPortal PortalIdPortal ID. DEPRECATED use platform instead.
public FString PortalUserIdPlatform User ID.
public FString DisplayNameDisplay name.
public ERHAPI_DeviceType DeviceType_OptionalPlatform-verified device type of the login.
public bool DeviceType_IsSettrue if DeviceType_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(const ERHAPI_Platform & NewValue)Sets the value of Platform.
public inline void SetPlatform(ERHAPI_Platform && NewValue)Sets the value of Platform using move semantics.
public inline ERHAPI_DependenciesSchemasPortal & GetPortalId()Gets the value of PortalId.
public inline const ERHAPI_DependenciesSchemasPortal & GetPortalId() constGets the value of PortalId.
public inline void SetPortalId(const ERHAPI_DependenciesSchemasPortal & NewValue)Sets the value of PortalId.
public inline void SetPortalId(ERHAPI_DependenciesSchemasPortal && NewValue)Sets the value of PortalId using move semantics.
public inline FString & GetPortalUserId()Gets the value of PortalUserId.
public inline const FString & GetPortalUserId() constGets the value of PortalUserId.
public inline void SetPortalUserId(const FString & NewValue)Sets the value of PortalUserId.
public inline void SetPortalUserId(FString && NewValue)Sets the value of PortalUserId using move semantics.
public inline FString & GetDisplayName()Gets the value of DisplayName.
public inline const FString & GetDisplayName() constGets the value of DisplayName.
public inline void SetDisplayName(const FString & NewValue)Sets the value of DisplayName.
public inline void SetDisplayName(FString && NewValue)Sets the value of DisplayName using move semantics.
public inline ERHAPI_DeviceType & GetDeviceType()Gets the value of DeviceType_Optional, regardless of it having been set.
public inline const ERHAPI_DeviceType & GetDeviceType() constGets the value of DeviceType_Optional, regardless of it having been set.
public inline const ERHAPI_DeviceType & GetDeviceType(const ERHAPI_DeviceType & DefaultValue) constGets the value of DeviceType_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetDeviceType(ERHAPI_DeviceType & OutValue) constFills OutValue with the value of DeviceType_Optional and returns true if it has been set, otherwise returns false.
public inline ERHAPI_DeviceType * GetDeviceTypeOrNull()Returns a pointer to DeviceType_Optional, if it has been set, otherwise returns nullptr.
public inline const ERHAPI_DeviceType * GetDeviceTypeOrNull() constReturns a pointer to DeviceType_Optional, if it has been set, otherwise returns nullptr.
public inline void SetDeviceType(const ERHAPI_DeviceType & NewValue)Sets the value of DeviceType_Optional and also sets DeviceType_IsSet to true.
public inline void SetDeviceType(ERHAPI_DeviceType && NewValue)Sets the value of DeviceType_Optional and also sets DeviceType_IsSet to true using move semantics.
public inline void ClearDeviceType()Clears the value of DeviceType_Optional and sets DeviceType_IsSet to false.
public inline bool IsDeviceTypeSet() constChecks whether DeviceType_Optional has been set.

Members​

public ERHAPI_Platform Platform ​

Platform for the user.

public ERHAPI_DependenciesSchemasPortal PortalId ​

Portal ID. DEPRECATED use platform instead.

public FString PortalUserId ​

Platform User ID.

public FString DisplayName ​

Display name.

public ERHAPI_DeviceType DeviceType_Optional ​

Platform-verified device type of the login.

public bool DeviceType_IsSet ​

true if DeviceType_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(const ERHAPI_Platform & NewValue) ​

Sets the value of Platform.

public inline void SetPlatform(ERHAPI_Platform && NewValue) ​

Sets the value of Platform using move semantics.

public inline ERHAPI_DependenciesSchemasPortal & GetPortalId() ​

Gets the value of PortalId.

public inline const ERHAPI_DependenciesSchemasPortal & GetPortalId() const ​

Gets the value of PortalId.

public inline void SetPortalId(const ERHAPI_DependenciesSchemasPortal & NewValue) ​

Sets the value of PortalId.

public inline void SetPortalId(ERHAPI_DependenciesSchemasPortal && NewValue) ​

Sets the value of PortalId using move semantics.

public inline FString & GetPortalUserId() ​

Gets the value of PortalUserId.

public inline const FString & GetPortalUserId() const ​

Gets the value of PortalUserId.

public inline void SetPortalUserId(const FString & NewValue) ​

Sets the value of PortalUserId.

public inline void SetPortalUserId(FString && NewValue) ​

Sets the value of PortalUserId using move semantics.

public inline FString & GetDisplayName() ​

Gets the value of DisplayName.

public inline const FString & GetDisplayName() const ​

Gets the value of DisplayName.

public inline void SetDisplayName(const FString & NewValue) ​

Sets the value of DisplayName.

public inline void SetDisplayName(FString && NewValue) ​

Sets the value of DisplayName using move semantics.

public inline ERHAPI_DeviceType & GetDeviceType() ​

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

public inline const ERHAPI_DeviceType & GetDeviceType() const ​

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

public inline const ERHAPI_DeviceType & GetDeviceType(const ERHAPI_DeviceType & DefaultValue) const ​

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

public inline bool GetDeviceType(ERHAPI_DeviceType & OutValue) const ​

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

public inline ERHAPI_DeviceType * GetDeviceTypeOrNull() ​

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

public inline const ERHAPI_DeviceType * GetDeviceTypeOrNull() const ​

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

public inline void SetDeviceType(const ERHAPI_DeviceType & NewValue) ​

Sets the value of DeviceType_Optional and also sets DeviceType_IsSet to true.

public inline void SetDeviceType(ERHAPI_DeviceType && NewValue) ​

Sets the value of DeviceType_Optional and also sets DeviceType_IsSet to true using move semantics.

public inline void ClearDeviceType() ​

Clears the value of DeviceType_Optional and sets DeviceType_IsSet to false.

public inline bool IsDeviceTypeSet() const ​

Checks whether DeviceType_Optional has been set.