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`](RHAPI_AdditionalJoinParams.md#structFRHAPI__AdditionalJoinParams)` `[`AdditionalJoinParams_Optional`](#structFRHAPI__UpdateBackfillRequest_1a8733cb6e88822464ff00906f4343479b)
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`](#structFRHAPI__UpdateBackfillRequest_1a5297552fe2ee8c2eb9f52dd6a8d4b747)
true if AdditionalJoinParams_Optional has been set to a value
#### `public TArray< `[`FRHAPI_BackfillTeam`](RHAPI_BackfillTeam.md#structFRHAPI__BackfillTeam)` > `[`Teams_Optional`](#structFRHAPI__UpdateBackfillRequest_1a0bcca01fbb64b7eb5cc8c6348f9b5a39)
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`](#structFRHAPI__UpdateBackfillRequest_1a868168ce21f43fa6d23f1cedf2780215)
true if Teams_Optional has been set to a value
#### `public virtual bool `[`FromJson`](#structFRHAPI__UpdateBackfillRequest_1a5191c300b1e574072a34e6de65a25d0f)`(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`](#structFRHAPI__UpdateBackfillRequest_1ab5e7560a8a7b9102cae06b58d9aae50e)`(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`](#structFRHAPI__UpdateBackfillRequest_1a61f1f26aa48faa039a779543c7f630b8)`()`
Gets the value of InstanceId.
#### `public inline const FString & `[`GetInstanceId`](#structFRHAPI__UpdateBackfillRequest_1a3dbfdbe0ef551031df2c74a323d13d2d)`() const`
Gets the value of InstanceId.
#### `public inline void `[`SetInstanceId`](#structFRHAPI__UpdateBackfillRequest_1adce72461de6ef153361376d5ab41b201)`(FString NewValue)`
Sets the value of InstanceId.
#### `public inline `[`FRHAPI_AdditionalJoinParams`](RHAPI_AdditionalJoinParams.md#structFRHAPI__AdditionalJoinParams)` & `[`GetAdditionalJoinParams`](#structFRHAPI__UpdateBackfillRequest_1a5d539b1d5ccc559f654522982d88c25f)`()`
Gets the value of AdditionalJoinParams_Optional, regardless of it having been set.
#### `public inline const `[`FRHAPI_AdditionalJoinParams`](RHAPI_AdditionalJoinParams.md#structFRHAPI__AdditionalJoinParams)` & `[`GetAdditionalJoinParams`](#structFRHAPI__UpdateBackfillRequest_1a5578394f77774e81b5023a342a37b91d)`() const`
Gets the value of AdditionalJoinParams_Optional, regardless of it having been set.
#### `public inline const `[`FRHAPI_AdditionalJoinParams`](RHAPI_AdditionalJoinParams.md#structFRHAPI__AdditionalJoinParams)` & `[`GetAdditionalJoinParams`](#structFRHAPI__UpdateBackfillRequest_1ace366e8a91bcb62dca94a5df74166a19)`(const `[`FRHAPI_AdditionalJoinParams`](RHAPI_AdditionalJoinParams.md#structFRHAPI__AdditionalJoinParams)` & DefaultValue) const`
Gets the value of AdditionalJoinParams_Optional, if it has been set, otherwise it returns DefaultValue.
#### `public inline bool `[`GetAdditionalJoinParams`](#structFRHAPI__UpdateBackfillRequest_1a54d99e91ca2522129b6f447ae9e85384)`(`[`FRHAPI_AdditionalJoinParams`](RHAPI_AdditionalJoinParams.md#structFRHAPI__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`](RHAPI_AdditionalJoinParams.md#structFRHAPI__AdditionalJoinParams)` * `[`GetAdditionalJoinParamsOrNull`](#structFRHAPI__UpdateBackfillRequest_1af432acd32e0f20a862ce4606aead702a)`()`
Returns a pointer to AdditionalJoinParams_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const `[`FRHAPI_AdditionalJoinParams`](RHAPI_AdditionalJoinParams.md#structFRHAPI__AdditionalJoinParams)` * `[`GetAdditionalJoinParamsOrNull`](#structFRHAPI__UpdateBackfillRequest_1a8b5829488df46a8981057f8a09ac9499)`() const`
Returns a pointer to AdditionalJoinParams_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetAdditionalJoinParams`](#structFRHAPI__UpdateBackfillRequest_1acbb75739dd4240b7ee8ab45e1f5c0583)`(`[`FRHAPI_AdditionalJoinParams`](RHAPI_AdditionalJoinParams.md#structFRHAPI__AdditionalJoinParams)` NewValue)`
Sets the value of AdditionalJoinParams_Optional and also sets AdditionalJoinParams_IsSet to true.
#### `public inline void `[`ClearAdditionalJoinParams`](#structFRHAPI__UpdateBackfillRequest_1ada5b36edf78e65ce6bf9b9fe73d3aa6e)`()`
Clears the value of AdditionalJoinParams_Optional and sets AdditionalJoinParams_IsSet to false.
#### `public inline TArray< `[`FRHAPI_BackfillTeam`](RHAPI_BackfillTeam.md#structFRHAPI__BackfillTeam)` > & `[`GetTeams`](#structFRHAPI__UpdateBackfillRequest_1a4589d12bdf628f45cfdf7eade6923997)`()`
Gets the value of Teams_Optional, regardless of it having been set.
#### `public inline const TArray< `[`FRHAPI_BackfillTeam`](RHAPI_BackfillTeam.md#structFRHAPI__BackfillTeam)` > & `[`GetTeams`](#structFRHAPI__UpdateBackfillRequest_1aa69a5a74491f38db3ab36f254c9aff51)`() const`
Gets the value of Teams_Optional, regardless of it having been set.
#### `public inline const TArray< `[`FRHAPI_BackfillTeam`](RHAPI_BackfillTeam.md#structFRHAPI__BackfillTeam)` > & `[`GetTeams`](#structFRHAPI__UpdateBackfillRequest_1a484a09bc3e911b07534bb25c68aa3765)`(const TArray< `[`FRHAPI_BackfillTeam`](RHAPI_BackfillTeam.md#structFRHAPI__BackfillTeam)` > & DefaultValue) const`
Gets the value of Teams_Optional, if it has been set, otherwise it returns DefaultValue.
#### `public inline bool `[`GetTeams`](#structFRHAPI__UpdateBackfillRequest_1af5c4a2cb761f4c69f676cf3b1ab9335a)`(TArray< `[`FRHAPI_BackfillTeam`](RHAPI_BackfillTeam.md#structFRHAPI__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`](RHAPI_BackfillTeam.md#structFRHAPI__BackfillTeam)` > * `[`GetTeamsOrNull`](#structFRHAPI__UpdateBackfillRequest_1aad97c0f2bcb921a65988b16156cab602)`()`
Returns a pointer to Teams_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const TArray< `[`FRHAPI_BackfillTeam`](RHAPI_BackfillTeam.md#structFRHAPI__BackfillTeam)` > * `[`GetTeamsOrNull`](#structFRHAPI__UpdateBackfillRequest_1a940797bad04cf8e2ac8f891f03acb14a)`() const`
Returns a pointer to Teams_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetTeams`](#structFRHAPI__UpdateBackfillRequest_1a40bcc5fb707434bb7e1f0d0dadcbf70e)`(TArray< `[`FRHAPI_BackfillTeam`](RHAPI_BackfillTeam.md#structFRHAPI__BackfillTeam)` > NewValue)`
Sets the value of Teams_Optional and also sets Teams_IsSet to true.
#### `public inline void `[`ClearTeams`](#structFRHAPI__UpdateBackfillRequest_1ab456151a06c9adfe1258778fbadaf412)`()`
Clears the value of Teams_Optional and sets Teams_IsSet to false.