RHAPI_SessionUpdate

Summary

Members	Descriptions
struct FRHAPI_SessionUpdate	A request body to update information about a session resource.

struct FRHAPI_SessionUpdate

struct FRHAPI_SessionUpdate
  : public FRHAPI_Model

A request body to update information about a session resource.

Summary

Members	Descriptions
public FString RegionId_Optional	Preferred region for the instance and match to take place in.
public bool RegionId_IsSet	true if RegionId_Optional has been set to a value
public TMap< FString, FString > CustomData_Optional	Leader Player or instance defined custom data about this session.
public bool CustomData_IsSet	true if CustomData_Optional has been set to a value
public bool Joinable_Optional	Flag for if players can freely join this session without an invite.
public bool Joinable_IsSet	true if Joinable_Optional has been set to a value
public TArray< FRHAPI_TeamUpdate>Teams_Optional	List of team size updates for this session. The length of the list represents the number of desired teams.
public bool Teams_IsSet	true if Teams_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 & GetRegionId()	Gets the value of RegionId_Optional, regardless of it having been set.
public inline const FString & GetRegionId() const	Gets the value of RegionId_Optional, regardless of it having been set.
public inline const FString & GetRegionId(const FString & DefaultValue) const	Gets the value of RegionId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetRegionId(FString & OutValue) const	Fills OutValue with the value of RegionId_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetRegionIdOrNull()	Returns a pointer to RegionId_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetRegionIdOrNull() const	Returns a pointer to RegionId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetRegionId(const FString & NewValue)	Sets the value of RegionId_Optional and also sets RegionId_IsSet to true.
public inline void SetRegionId(FString && NewValue)	Sets the value of RegionId_Optional and also sets RegionId_IsSet to true using move semantics.
public inline void ClearRegionId()	Clears the value of RegionId_Optional and sets RegionId_IsSet to false.
public inline bool IsRegionIdSet() const	Checks whether RegionId_Optional has been set.
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(const TMap< FString, FString > & NewValue)	Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.
public inline void SetCustomData(TMap< FString, FString > && NewValue)	Sets the value of CustomData_Optional and also sets CustomData_IsSet to true using move semantics.
public inline void ClearCustomData()	Clears the value of CustomData_Optional and sets CustomData_IsSet to false.
public inline bool IsCustomDataSet() const	Checks whether CustomData_Optional has been set.
public inline bool & GetJoinable()	Gets the value of Joinable_Optional, regardless of it having been set.
public inline const bool & GetJoinable() const	Gets the value of Joinable_Optional, regardless of it having been set.
public inline const bool & GetJoinable(const bool & DefaultValue) const	Gets the value of Joinable_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetJoinable(bool & OutValue) const	Fills OutValue with the value of Joinable_Optional and returns true if it has been set, otherwise returns false.
public inline bool * GetJoinableOrNull()	Returns a pointer to Joinable_Optional, if it has been set, otherwise returns nullptr.
public inline const bool * GetJoinableOrNull() const	Returns a pointer to Joinable_Optional, if it has been set, otherwise returns nullptr.
public inline void SetJoinable(const bool & NewValue)	Sets the value of Joinable_Optional and also sets Joinable_IsSet to true.
public inline void SetJoinable(bool && NewValue)	Sets the value of Joinable_Optional and also sets Joinable_IsSet to true using move semantics.
public inline void ClearJoinable()	Clears the value of Joinable_Optional and sets Joinable_IsSet to false.
public inline bool IsJoinableSet() const	Checks whether Joinable_Optional has been set.
public inline bool IsJoinableDefaultValue() const	Returns true if Joinable_Optional is set and matches the default value.
public inline void SetJoinableToDefault()	Sets the value of Joinable_Optional to its default and also sets Joinable_IsSet to true.
public inline TArray< FRHAPI_TeamUpdate> &GetTeams()	Gets the value of Teams_Optional, regardless of it having been set.
public inline const TArray< FRHAPI_TeamUpdate> &GetTeams() const	Gets the value of Teams_Optional, regardless of it having been set.
public inline const TArray< FRHAPI_TeamUpdate> &GetTeams(const TArray< FRHAPI_TeamUpdate > & DefaultValue) const	Gets the value of Teams_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetTeams(TArray< FRHAPI_TeamUpdate > & OutValue) const	Fills OutValue with the value of Teams_Optional and returns true if it has been set, otherwise returns false.
public inline TArray< FRHAPI_TeamUpdate> *GetTeamsOrNull()	Returns a pointer to Teams_Optional, if it has been set, otherwise returns nullptr.
public inline const TArray< FRHAPI_TeamUpdate> *GetTeamsOrNull() const	Returns a pointer to Teams_Optional, if it has been set, otherwise returns nullptr.
public inline void SetTeams(const TArray< FRHAPI_TeamUpdate > & NewValue)	Sets the value of Teams_Optional and also sets Teams_IsSet to true.
public inline void SetTeams(TArray< FRHAPI_TeamUpdate > && NewValue)	Sets the value of Teams_Optional and also sets Teams_IsSet to true using move semantics.
public inline void ClearTeams()	Clears the value of Teams_Optional and sets Teams_IsSet to false.
public inline bool IsTeamsSet() const	Checks whether Teams_Optional has been set.

Members

public FString RegionId_Optional

Preferred region for the instance and match to take place in.

public bool RegionId_IsSet

true if RegionId_Optional has been set to a value

public TMap< FString, FString > CustomData_Optional

Leader Player or instance defined custom data about this session.

public bool CustomData_IsSet

true if CustomData_Optional has been set to a value

public bool Joinable_Optional

Flag for if players can freely join this session without an invite.

public bool Joinable_IsSet

true if Joinable_Optional has been set to a value

public TArray< FRHAPI_TeamUpdate>Teams_Optional

List of team size updates for this session. The length of the list represents the number of desired teams.

public bool Teams_IsSet

true if Teams_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 FString & GetRegionId()

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

public inline const FString & GetRegionId() const

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

public inline const FString & GetRegionId(const FString & DefaultValue) const

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

public inline bool GetRegionId(FString & OutValue) const

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

public inline FString * GetRegionIdOrNull()

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

public inline const FString * GetRegionIdOrNull() const

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

public inline void SetRegionId(const FString & NewValue)

Sets the value of RegionId_Optional and also sets RegionId_IsSet to true.

public inline void SetRegionId(FString && NewValue)

Sets the value of RegionId_Optional and also sets RegionId_IsSet to true using move semantics.

public inline void ClearRegionId()

Clears the value of RegionId_Optional and sets RegionId_IsSet to false.

public inline bool IsRegionIdSet() const

Checks whether RegionId_Optional has been set.

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(const TMap< FString, FString > & NewValue)

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

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

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

public inline void ClearCustomData()

Clears the value of CustomData_Optional and sets CustomData_IsSet to false.

public inline bool IsCustomDataSet() const

Checks whether CustomData_Optional has been set.

public inline bool & GetJoinable()

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

public inline const bool & GetJoinable() const

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

public inline const bool & GetJoinable(const bool & DefaultValue) const

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

public inline bool GetJoinable(bool & OutValue) const

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

public inline bool * GetJoinableOrNull()

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

public inline const bool * GetJoinableOrNull() const

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

public inline void SetJoinable(const bool & NewValue)

Sets the value of Joinable_Optional and also sets Joinable_IsSet to true.

public inline void SetJoinable(bool && NewValue)

Sets the value of Joinable_Optional and also sets Joinable_IsSet to true using move semantics.

public inline void ClearJoinable()

Clears the value of Joinable_Optional and sets Joinable_IsSet to false.

public inline bool IsJoinableSet() const

Checks whether Joinable_Optional has been set.

public inline bool IsJoinableDefaultValue() const

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

public inline void SetJoinableToDefault()

Sets the value of Joinable_Optional to its default and also sets Joinable_IsSet to true.

public inline TArray< FRHAPI_TeamUpdate> &GetTeams()

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

public inline const TArray< FRHAPI_TeamUpdate> &GetTeams() const

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

public inline const TArray< FRHAPI_TeamUpdate> &GetTeams(const TArray< FRHAPI_TeamUpdate > & DefaultValue) const

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

public inline bool GetTeams(TArray< FRHAPI_TeamUpdate > & OutValue) const

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

public inline TArray< FRHAPI_TeamUpdate> *GetTeamsOrNull()

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

public inline const TArray< FRHAPI_TeamUpdate> *GetTeamsOrNull() const

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

public inline void SetTeams(const TArray< FRHAPI_TeamUpdate > & NewValue)

Sets the value of Teams_Optional and also sets Teams_IsSet to true.

public inline void SetTeams(TArray< FRHAPI_TeamUpdate > && NewValue)

Sets the value of Teams_Optional and also sets Teams_IsSet to true using move semantics.

public inline void ClearTeams()

Clears the value of Teams_Optional and sets Teams_IsSet to false.

public inline bool IsTeamsSet() const

Checks whether Teams_Optional has been set.