RHAPI_PlatformSession

Summary

Members	Descriptions
struct FRHAPI_PlatformSession	A platform session resource in a RallyHere session.

struct FRHAPI_PlatformSession

struct FRHAPI_PlatformSession
  : public FRHAPI_Model

A platform session resource in a RallyHere session.

Summary

Members	Descriptions
public ERHAPI_Platform Platform	Platform that this session is for.
public FString PlatformSessionType	Platform-Specific Identifier for the Platform’s template.
public FString PlatformSessionIdBase64	Platform session’s unique identifier.
public TArray< FRHAPI_PlatformSessionPlayer>Players	DEPRECATED. PlatformSessions no longer keep tracking of players. Players in the platform session.
public TMap< FString, FString > CustomData_Optional	Product defined custom data fields about the platform session.
public bool CustomData_IsSet	true if CustomData_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 & GetPlatformSessionType()	Gets the value of PlatformSessionType.
public inline const FString & GetPlatformSessionType() const	Gets the value of PlatformSessionType.
public inline void SetPlatformSessionType(FString NewValue)	Sets the value of PlatformSessionType.
public inline FString & GetPlatformSessionIdBase64()	Gets the value of PlatformSessionIdBase64.
public inline const FString & GetPlatformSessionIdBase64() const	Gets the value of PlatformSessionIdBase64.
public inline void SetPlatformSessionIdBase64(FString NewValue)	Sets the value of PlatformSessionIdBase64.
public inline TArray< FRHAPI_PlatformSessionPlayer> &GetPlayers()	Gets the value of Players.
public inline const TArray< FRHAPI_PlatformSessionPlayer> &GetPlayers() const	Gets the value of Players.
public inline void SetPlayers(TArray< FRHAPI_PlatformSessionPlayer > NewValue)	Sets the value of Players.
public inline TMap< FString, FString > & GetCustomData()	Gets the value of CustomData_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetCustomData() const	Gets the value of CustomData_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetCustomData(const TMap< FString, FString > & DefaultValue) const	Gets the value of CustomData_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetCustomData(TMap< FString, FString > & OutValue) const	Fills OutValue with the value of CustomData_Optional and returns true if it has been set, otherwise returns false.
public inline TMap< FString, FString > * GetCustomDataOrNull()	Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
public inline const TMap< FString, FString > * GetCustomDataOrNull() const	Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
public inline void SetCustomData(TMap< FString, FString > NewValue)	Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.
public inline void ClearCustomData()	Clears the value of CustomData_Optional and sets CustomData_IsSet to false.

Members

public ERHAPI_Platform Platform

Platform that this session is for.

public FString PlatformSessionType

Platform-Specific Identifier for the Platform’s template.

public FString PlatformSessionIdBase64

Platform session’s unique identifier.

public TArray< FRHAPI_PlatformSessionPlayer>Players

DEPRECATED. PlatformSessions no longer keep tracking of players. Players in the platform session.

public TMap< FString, FString > CustomData_Optional

Product defined custom data fields about the platform session.

public bool CustomData_IsSet

true if CustomData_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 & GetPlatformSessionType()

Gets the value of PlatformSessionType.

public inline const FString & GetPlatformSessionType() const

Gets the value of PlatformSessionType.

public inline void SetPlatformSessionType(FString NewValue)

Sets the value of PlatformSessionType.

public inline FString & GetPlatformSessionIdBase64()

Gets the value of PlatformSessionIdBase64.

public inline const FString & GetPlatformSessionIdBase64() const

Gets the value of PlatformSessionIdBase64.

public inline void SetPlatformSessionIdBase64(FString NewValue)

Sets the value of PlatformSessionIdBase64.

public inline TArray< FRHAPI_PlatformSessionPlayer> &GetPlayers()

Gets the value of Players.

public inline const TArray< FRHAPI_PlatformSessionPlayer> &GetPlayers() const

Gets the value of Players.

public inline void SetPlayers(TArray< FRHAPI_PlatformSessionPlayer > NewValue)

Sets the value of Players.

public inline TMap< FString, FString > & GetCustomData()

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

public inline const TMap< FString, FString > & GetCustomData() const

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

public inline const TMap< FString, FString > & GetCustomData(const TMap< FString, FString > & DefaultValue) const

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

public inline bool GetCustomData(TMap< FString, FString > & OutValue) const

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

public inline TMap< FString, FString > * GetCustomDataOrNull()

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

public inline const TMap< FString, FString > * GetCustomDataOrNull() const

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

public inline void SetCustomData(TMap< FString, FString > NewValue)

Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.

public inline void ClearCustomData()

Clears the value of CustomData_Optional and sets CustomData_IsSet to false.