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`](#structFRHAPI__PlatformSessionTemplate_1a234c5994651cf76b82cd5fc10d6789b1)

Platform.

#### `public FString `[`PlatformSessionType`](#structFRHAPI__PlatformSessionTemplate_1a467f663872de483c259ca4e0b398bbc0)

Platform-Specific Identifier for the Platform’s template.

#### `public int32 `[`MaxPlayers_Optional`](#structFRHAPI__PlatformSessionTemplate_1a19ca1aa4d6c345789146cbb82cc4b05a)

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

#### `public bool `[`MaxPlayers_IsSet`](#structFRHAPI__PlatformSessionTemplate_1a820d7ec5127d55985fe8ec28a8507cf9)

true if MaxPlayers_Optional has been set to a value

#### `public TMap< FString, FString > `[`CustomData_Optional`](#structFRHAPI__PlatformSessionTemplate_1a011145a99ccb57b768e35067cded1d1d)

Product-defined custom data.

#### `public bool `[`CustomData_IsSet`](#structFRHAPI__PlatformSessionTemplate_1a466d856fb15205041dfe368181512ec7)

true if CustomData_Optional has been set to a value

#### `public virtual bool `[`FromJson`](#structFRHAPI__PlatformSessionTemplate_1a78cd0b4d539885405306af3001fda3f9)`(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`](#structFRHAPI__PlatformSessionTemplate_1ae18e5802f726493cc53d3b6a941052f3)`(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`](#structFRHAPI__PlatformSessionTemplate_1a1ba25b3925205ce1043ab6405149c654)`()`

Gets the value of PlatformId.

#### `public inline const ERHAPI_PlatformID & `[`GetPlatformId`](#structFRHAPI__PlatformSessionTemplate_1a29a74f1aec1b8bbb0da3b4dc7ff9cfe4)`() const`

Gets the value of PlatformId.

#### `public inline void `[`SetPlatformId`](#structFRHAPI__PlatformSessionTemplate_1ab3bb4c8fa9d9689a2bff93f9a9806d4f)`(ERHAPI_PlatformID NewValue)`

Sets the value of PlatformId.

#### `public inline ERHAPI_Platform & `[`GetPlatform`](#structFRHAPI__PlatformSessionTemplate_1aaa03090feaa90bf86a69a3fb9358a8ad)`()`

Gets the value of Platform.

#### `public inline const ERHAPI_Platform & `[`GetPlatform`](#structFRHAPI__PlatformSessionTemplate_1a3730049b24ff914aa7edce798156269f)`() const`

Gets the value of Platform.

#### `public inline void `[`SetPlatform`](#structFRHAPI__PlatformSessionTemplate_1a0b76e6498381802e9867a4c67b45be85)`(ERHAPI_Platform NewValue)`

Sets the value of Platform.

#### `public inline FString & `[`GetPlatformSessionType`](#structFRHAPI__PlatformSessionTemplate_1a4cbe1d9976dfbba75ebb02c8d71f12dd)`()`

Gets the value of PlatformSessionType.

#### `public inline const FString & `[`GetPlatformSessionType`](#structFRHAPI__PlatformSessionTemplate_1a24a0a7504fdacbe9a8696e65f4445e81)`() const`

Gets the value of PlatformSessionType.

#### `public inline void `[`SetPlatformSessionType`](#structFRHAPI__PlatformSessionTemplate_1a98903f927c175ec2f8d650bb0c9924d5)`(FString NewValue)`

Sets the value of PlatformSessionType.

#### `public inline int32 & `[`GetMaxPlayers`](#structFRHAPI__PlatformSessionTemplate_1adac1a80b307d7cec56c1158adae10710)`()`

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

#### `public inline const int32 & `[`GetMaxPlayers`](#structFRHAPI__PlatformSessionTemplate_1a5e06d329050cf9909daecd0e392aa966)`() const`

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

#### `public inline const int32 & `[`GetMaxPlayers`](#structFRHAPI__PlatformSessionTemplate_1a8225b01e34f6b240d5934f6eab337977)`(const int32 & DefaultValue) const`

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

#### `public inline bool `[`GetMaxPlayers`](#structFRHAPI__PlatformSessionTemplate_1a16185aff7b18ea80da7ac53720287811)`(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`](#structFRHAPI__PlatformSessionTemplate_1adb188930a6a2fd9801e5dec1e68b46b8)`()`

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

#### `public inline const int32 * `[`GetMaxPlayersOrNull`](#structFRHAPI__PlatformSessionTemplate_1ab3ba73e245474b42f2146b1c3e7c1b7b)`() const`

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

#### `public inline void `[`SetMaxPlayers`](#structFRHAPI__PlatformSessionTemplate_1a87f775ac012c4e63d28bf89d2ff604c1)`(int32 NewValue)`

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

#### `public inline void `[`ClearMaxPlayers`](#structFRHAPI__PlatformSessionTemplate_1af2d8b5f464542815bcbbcf41870d0acc)`()`

Clears the value of MaxPlayers_Optional and sets MaxPlayers_IsSet to false.

#### `public inline bool `[`IsMaxPlayersDefaultValue`](#structFRHAPI__PlatformSessionTemplate_1afcc99ba028d9ae88bd51bd821e79081e)`() const`

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

#### `public inline void `[`SetMaxPlayersToDefault`](#structFRHAPI__PlatformSessionTemplate_1a906c779ed24a184bbf330d00f26a6f21)`()`

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

#### `public inline TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__PlatformSessionTemplate_1a968db4e8e03ce9a1ded8a4e2b83fb437)`()`

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

#### `public inline const TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__PlatformSessionTemplate_1afc4954c995a337129d7b92447ee347a7)`() const`

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

#### `public inline const TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__PlatformSessionTemplate_1a5ba8215a625f91e4d052242ad54e0d4b)`(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`](#structFRHAPI__PlatformSessionTemplate_1a245b15b5a658c492364ea19ad5911b56)`(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`](#structFRHAPI__PlatformSessionTemplate_1a695a2c70e2430ff72683f866fa0dd126)`()`

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

#### `public inline const TMap< FString, FString > * `[`GetCustomDataOrNull`](#structFRHAPI__PlatformSessionTemplate_1aa7c5172eaa282ce126e031459a60b1c0)`() const`

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

#### `public inline void `[`SetCustomData`](#structFRHAPI__PlatformSessionTemplate_1a7bbcfbaaf9edbe5d6d9dc50669b33ff9)`(TMap< FString, FString > NewValue)`

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

#### `public inline void `[`ClearCustomData`](#structFRHAPI__PlatformSessionTemplate_1a1bab29f42e2c1c50068349c69c644583)`()`

Clears the value of CustomData_Optional and sets CustomData_IsSet to false.