RHAPI_UpdateBackfillRequest
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_UpdateBackfillRequest |
struct FRHAPI_UpdateBackfillRequest
struct FRHAPI_UpdateBackfillRequest : public FRHAPI_ModelSummary
| Members | Descriptions |
|---|---|
public FString InstanceId | The instance ID for this backfill request. |
public FRHAPI_AdditionalJoinParams AdditionalJoinParams_Optional | Additional fields put on the matchmaking ticket for open match to search with (see https://openmatch.dev/site/docs/reference/api/#searchfields) |
public bool AdditionalJoinParams_IsSet | true if AdditionalJoinParams_Optional has been set to a value |
public TArray< FRHAPI_BackfillTeam>Teams_Optional | The teams and number of players that need to be backfilled. Leaving this out (or supplying an empty list) is treated as no players are currently required. |
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 & GetInstanceId() | Gets the value of InstanceId. |
public inline const FString & GetInstanceId() const | Gets the value of InstanceId. |
public inline void SetInstanceId(FString NewValue) | Sets the value of InstanceId. |
public inline FRHAPI_AdditionalJoinParams&GetAdditionalJoinParams() | Gets the value of AdditionalJoinParams_Optional, regardless of it having been set. |
public inline const FRHAPI_AdditionalJoinParams&GetAdditionalJoinParams() const | Gets the value of AdditionalJoinParams_Optional, regardless of it having been set. |
public inline const FRHAPI_AdditionalJoinParams&GetAdditionalJoinParams(const FRHAPI_AdditionalJoinParams & DefaultValue) const | Gets the value of AdditionalJoinParams_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetAdditionalJoinParams(FRHAPI_AdditionalJoinParams & OutValue) const | Fills OutValue with the value of AdditionalJoinParams_Optional and returns true if it has been set, otherwise returns false. |
public inline FRHAPI_AdditionalJoinParams*GetAdditionalJoinParamsOrNull() | Returns a pointer to AdditionalJoinParams_Optional, if it has been set, otherwise returns nullptr. |
public inline const FRHAPI_AdditionalJoinParams*GetAdditionalJoinParamsOrNull() const | Returns a pointer to AdditionalJoinParams_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetAdditionalJoinParams(FRHAPI_AdditionalJoinParams NewValue) | Sets the value of AdditionalJoinParams_Optional and also sets AdditionalJoinParams_IsSet to true. |
public inline void ClearAdditionalJoinParams() | Clears the value of AdditionalJoinParams_Optional and sets AdditionalJoinParams_IsSet to false. |
public inline TArray< FRHAPI_BackfillTeam> &GetTeams() | Gets the value of Teams_Optional, regardless of it having been set. |
public inline const TArray< FRHAPI_BackfillTeam> &GetTeams() const | Gets the value of Teams_Optional, regardless of it having been set. |
public inline const TArray< FRHAPI_BackfillTeam> &GetTeams(const TArray< FRHAPI_BackfillTeam > & DefaultValue) const | Gets the value of Teams_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetTeams(TArray< FRHAPI_BackfillTeam > & 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_BackfillTeam> *GetTeamsOrNull() | Returns a pointer to Teams_Optional, if it has been set, otherwise returns nullptr. |
public inline const TArray< FRHAPI_BackfillTeam> *GetTeamsOrNull() const | Returns a pointer to Teams_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetTeams(TArray< FRHAPI_BackfillTeam > NewValue) | Sets the value of Teams_Optional and also sets Teams_IsSet to true. |
public inline void ClearTeams() | Clears the value of Teams_Optional and sets Teams_IsSet to false. |
Members
public FString InstanceId
The instance ID for this backfill request.
public FRHAPI_AdditionalJoinParams AdditionalJoinParams_Optional
Additional fields put on the matchmaking ticket for open match to search with (see https://openmatch.dev/site/docs/reference/api/#searchfields)
public bool AdditionalJoinParams_IsSet
true if AdditionalJoinParams_Optional has been set to a value
public TArray< FRHAPI_BackfillTeam>Teams_Optional
The teams and number of players that need to be backfilled. Leaving this out (or supplying an empty list) is treated as no players are currently required.
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
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 & GetInstanceId()
Gets the value of InstanceId.
public inline const FString & GetInstanceId() const
Gets the value of InstanceId.
public inline void SetInstanceId(FString NewValue)
Sets the value of InstanceId.
public inline FRHAPI_AdditionalJoinParams&GetAdditionalJoinParams()
Gets the value of AdditionalJoinParams_Optional, regardless of it having been set.
public inline const FRHAPI_AdditionalJoinParams&GetAdditionalJoinParams() const
Gets the value of AdditionalJoinParams_Optional, regardless of it having been set.
public inline const FRHAPI_AdditionalJoinParams&GetAdditionalJoinParams(const FRHAPI_AdditionalJoinParams & DefaultValue) const
Gets the value of AdditionalJoinParams_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetAdditionalJoinParams(FRHAPI_AdditionalJoinParams & OutValue) const
Fills OutValue with the value of AdditionalJoinParams_Optional and returns true if it has been set, otherwise returns false.
public inline FRHAPI_AdditionalJoinParams*GetAdditionalJoinParamsOrNull()
Returns a pointer to AdditionalJoinParams_Optional, if it has been set, otherwise returns nullptr.
public inline const FRHAPI_AdditionalJoinParams*GetAdditionalJoinParamsOrNull() const
Returns a pointer to AdditionalJoinParams_Optional, if it has been set, otherwise returns nullptr.
public inline void SetAdditionalJoinParams(FRHAPI_AdditionalJoinParams NewValue)
Sets the value of AdditionalJoinParams_Optional and also sets AdditionalJoinParams_IsSet to true.
public inline void ClearAdditionalJoinParams()
Clears the value of AdditionalJoinParams_Optional and sets AdditionalJoinParams_IsSet to false.
public inline TArray< FRHAPI_BackfillTeam> &GetTeams()
Gets the value of Teams_Optional, regardless of it having been set.
public inline const TArray< FRHAPI_BackfillTeam> &GetTeams() const
Gets the value of Teams_Optional, regardless of it having been set.
public inline const TArray< FRHAPI_BackfillTeam> &GetTeams(const TArray< FRHAPI_BackfillTeam > & DefaultValue) const
Gets the value of Teams_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetTeams(TArray< FRHAPI_BackfillTeam > & 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_BackfillTeam> *GetTeamsOrNull()
Returns a pointer to Teams_Optional, if it has been set, otherwise returns nullptr.
public inline const TArray< FRHAPI_BackfillTeam> *GetTeamsOrNull() const
Returns a pointer to Teams_Optional, if it has been set, otherwise returns nullptr.
public inline void SetTeams(TArray< FRHAPI_BackfillTeam > NewValue)
Sets the value of Teams_Optional and also sets Teams_IsSet to true.
public inline void ClearTeams()
Clears the value of Teams_Optional and sets Teams_IsSet to false.