RHAPI_BodyBeginNewSession
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_BodyBeginNewSession |
struct FRHAPI_BodyBeginNewSession
struct FRHAPI_BodyBeginNewSession : public FRHAPI_ModelSummary
| Members | Descriptions |
|---|---|
public FString CountryCode | ISO 3166-1 alpha-2 country code for the user |
public FString DeviceId_Optional | Unique Identifier for the device a session is started on. E.g should be the same for multiple users on the same device. |
public bool DeviceId_IsSet | true if DeviceId_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 FString & GetCountryCode() | Gets the value of CountryCode. |
public inline const FString & GetCountryCode() const | Gets the value of CountryCode. |
public inline void SetCountryCode(FString NewValue) | Sets the value of CountryCode. |
public inline FString & GetDeviceId() | Gets the value of DeviceId_Optional, regardless of it having been set. |
public inline const FString & GetDeviceId() const | Gets the value of DeviceId_Optional, regardless of it having been set. |
public inline const FString & GetDeviceId(const FString & DefaultValue) const | Gets the value of DeviceId_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetDeviceId(FString & OutValue) const | Fills OutValue with the value of DeviceId_Optional and returns true if it has been set, otherwise returns false. |
public inline FString * GetDeviceIdOrNull() | Returns a pointer to DeviceId_Optional, if it has been set, otherwise returns nullptr. |
public inline const FString * GetDeviceIdOrNull() const | Returns a pointer to DeviceId_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetDeviceId(FString NewValue) | Sets the value of DeviceId_Optional and also sets DeviceId_IsSet to true. |
public inline void ClearDeviceId() | Clears the value of DeviceId_Optional and sets DeviceId_IsSet to false. |
Members
public FString CountryCode
ISO 3166-1 alpha-2 country code for the user
public FString DeviceId_Optional
Unique Identifier for the device a session is started on. E.g should be the same for multiple users on the same device.
public bool DeviceId_IsSet
true if DeviceId_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
JsonValueData 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
WriterJSON Writer stream to push .
public inline FString & GetCountryCode()
Gets the value of CountryCode.
public inline const FString & GetCountryCode() const
Gets the value of CountryCode.
public inline void SetCountryCode(FString NewValue)
Sets the value of CountryCode.
public inline FString & GetDeviceId()
Gets the value of DeviceId_Optional, regardless of it having been set.
public inline const FString & GetDeviceId() const
Gets the value of DeviceId_Optional, regardless of it having been set.
public inline const FString & GetDeviceId(const FString & DefaultValue) const
Gets the value of DeviceId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetDeviceId(FString & OutValue) const
Fills OutValue with the value of DeviceId_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetDeviceIdOrNull()
Returns a pointer to DeviceId_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetDeviceIdOrNull() const
Returns a pointer to DeviceId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetDeviceId(FString NewValue)
Sets the value of DeviceId_Optional and also sets DeviceId_IsSet to true.
public inline void ClearDeviceId()
Clears the value of DeviceId_Optional and sets DeviceId_IsSet to false.