RHAPI_PlatformSessionTemplate

Summary

Members	Descriptions
struct FRHAPI_PlatformSessionTemplate	Template used to create new platform sessions for a specific type of platform. Configurable in the developer portal.

struct FRHAPI_PlatformSessionTemplate

struct FRHAPI_PlatformSessionTemplate
  : public FRHAPI_Model

Template used to create new platform sessions for a specific type of platform. Configurable in the developer portal.

Summary

Members	Descriptions
public ERHAPI_PlatformID PlatformId	DEPRECATED. ID for the platform type for this template. Use ‘platform’ instead.
public ERHAPI_Platform Platform	Platform.
public FString PlatformSessionType	Platform-Specific Identifier for the Platform’s template.
public int32 MaxPlayers_Optional	The maximum number of players that can be a part of this platform session.
public bool MaxPlayers_IsSet	true if MaxPlayers_Optional has been set to a value
public TMap< FString, FString > CustomData_Optional	Product-defined custom data.
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_PlatformID & GetPlatformId()	Gets the value of PlatformId.
public inline const ERHAPI_PlatformID & GetPlatformId() const	Gets the value of PlatformId.
public inline void SetPlatformId(ERHAPI_PlatformID NewValue)	Sets the value of PlatformId.
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 int32 & GetMaxPlayers()	Gets the value of MaxPlayers_Optional, regardless of it having been set.
public inline const int32 & GetMaxPlayers() const	Gets the value of MaxPlayers_Optional, regardless of it having been set.
public inline const int32 & GetMaxPlayers(const int32 & DefaultValue) const	Gets the value of MaxPlayers_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetMaxPlayers(int32 & OutValue) const	Fills OutValue with the value of MaxPlayers_Optional and returns true if it has been set, otherwise returns false.
public inline int32 * GetMaxPlayersOrNull()	Returns a pointer to MaxPlayers_Optional, if it has been set, otherwise returns nullptr.
public inline const int32 * GetMaxPlayersOrNull() const	Returns a pointer to MaxPlayers_Optional, if it has been set, otherwise returns nullptr.
public inline void SetMaxPlayers(int32 NewValue)	Sets the value of MaxPlayers_Optional and also sets MaxPlayers_IsSet to true.
public inline void ClearMaxPlayers()	Clears the value of MaxPlayers_Optional and sets MaxPlayers_IsSet to false.
public inline bool IsMaxPlayersDefaultValue() const	Returns true if MaxPlayers_Optional is set and matches the default value.
public inline void SetMaxPlayersToDefault()	Sets the value of MaxPlayers_Optional to its default and also sets MaxPlayers_IsSet to true.
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_PlatformID PlatformId

DEPRECATED. ID for the platform type for this template. Use ‘platform’ instead.

public ERHAPI_Platform Platform

Platform.

public FString PlatformSessionType

Platform-Specific Identifier for the Platform’s template.

public int32 MaxPlayers_Optional

The maximum number of players that can be a part of this platform session.

public bool MaxPlayers_IsSet

true if MaxPlayers_Optional has been set to a value

public TMap< FString, FString > CustomData_Optional

Product-defined custom data.

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_PlatformID & GetPlatformId()

Gets the value of PlatformId.

public inline const ERHAPI_PlatformID & GetPlatformId() const

Gets the value of PlatformId.

public inline void SetPlatformId(ERHAPI_PlatformID NewValue)

Sets the value of PlatformId.

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 int32 & GetMaxPlayers()

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

public inline const int32 & GetMaxPlayers() const

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

public inline const int32 & GetMaxPlayers(const int32 & DefaultValue) const

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

public inline bool GetMaxPlayers(int32 & OutValue) const

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

public inline int32 * GetMaxPlayersOrNull()

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

public inline const int32 * GetMaxPlayersOrNull() const

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

public inline void SetMaxPlayers(int32 NewValue)

Sets the value of MaxPlayers_Optional and also sets MaxPlayers_IsSet to true.

public inline void ClearMaxPlayers()

Clears the value of MaxPlayers_Optional and sets MaxPlayers_IsSet to false.

public inline bool IsMaxPlayersDefaultValue() const

Returns true if MaxPlayers_Optional is set and matches the default value.

public inline void SetMaxPlayersToDefault()

Sets the value of MaxPlayers_Optional to its default and also sets MaxPlayers_IsSet to true.

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.