Skip to main content

RHAPI_AcknowledgeBackfillRequest

Summary​

MembersDescriptions
struct FRHAPI_AcknowledgeBackfillRequest

struct FRHAPI_AcknowledgeBackfillRequest ​

struct FRHAPI_AcknowledgeBackfillRequest
: public FRHAPI_Model

Summary​

MembersDescriptions
public FString InstanceIdThe instance ID for this backfill request.
public TMap< FString, FString > Extensions_OptionalAdditional extensions to add to the Assignment for the backfill resource associated with the session.
public bool Extensions_IsSettrue if Extensions_Optional has been set to a value
public ERHAPI_TeamOverflowAction OverflowAction_OptionalHow to handle backfills that return too many players for a team.
public bool OverflowAction_IsSettrue if OverflowAction_Optional has been set to a value
public TArray< ERHAPI_BackfillStyle > Styles_OptionalThe styles of backfill to acknowledge. Can provide multiple for backwards compatibility.
public bool Styles_IsSettrue if Styles_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) constWrites 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() constGets the value of InstanceId.
public inline void SetInstanceId(const FString & NewValue)Sets the value of InstanceId.
public inline void SetInstanceId(FString && NewValue)Sets the value of InstanceId using move semantics.
public inline TMap< FString, FString > & GetExtensions()Gets the value of Extensions_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetExtensions() constGets the value of Extensions_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetExtensions(const TMap< FString, FString > & DefaultValue) constGets the value of Extensions_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetExtensions(TMap< FString, FString > & OutValue) constFills OutValue with the value of Extensions_Optional and returns true if it has been set, otherwise returns false.
public inline TMap< FString, FString > * GetExtensionsOrNull()Returns a pointer to Extensions_Optional, if it has been set, otherwise returns nullptr.
public inline const TMap< FString, FString > * GetExtensionsOrNull() constReturns a pointer to Extensions_Optional, if it has been set, otherwise returns nullptr.
public inline void SetExtensions(const TMap< FString, FString > & NewValue)Sets the value of Extensions_Optional and also sets Extensions_IsSet to true.
public inline void SetExtensions(TMap< FString, FString > && NewValue)Sets the value of Extensions_Optional and also sets Extensions_IsSet to true using move semantics.
public inline void ClearExtensions()Clears the value of Extensions_Optional and sets Extensions_IsSet to false.
public inline bool IsExtensionsSet() constChecks whether Extensions_Optional has been set.
public inline ERHAPI_TeamOverflowAction & GetOverflowAction()Gets the value of OverflowAction_Optional, regardless of it having been set.
public inline const ERHAPI_TeamOverflowAction & GetOverflowAction() constGets the value of OverflowAction_Optional, regardless of it having been set.
public inline const ERHAPI_TeamOverflowAction & GetOverflowAction(const ERHAPI_TeamOverflowAction & DefaultValue) constGets the value of OverflowAction_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetOverflowAction(ERHAPI_TeamOverflowAction & OutValue) constFills OutValue with the value of OverflowAction_Optional and returns true if it has been set, otherwise returns false.
public inline ERHAPI_TeamOverflowAction * GetOverflowActionOrNull()Returns a pointer to OverflowAction_Optional, if it has been set, otherwise returns nullptr.
public inline const ERHAPI_TeamOverflowAction * GetOverflowActionOrNull() constReturns a pointer to OverflowAction_Optional, if it has been set, otherwise returns nullptr.
public inline void SetOverflowAction(const ERHAPI_TeamOverflowAction & NewValue)Sets the value of OverflowAction_Optional and also sets OverflowAction_IsSet to true.
public inline void SetOverflowAction(ERHAPI_TeamOverflowAction && NewValue)Sets the value of OverflowAction_Optional and also sets OverflowAction_IsSet to true using move semantics.
public inline void ClearOverflowAction()Clears the value of OverflowAction_Optional and sets OverflowAction_IsSet to false.
public inline bool IsOverflowActionSet() constChecks whether OverflowAction_Optional has been set.
public inline TArray< ERHAPI_BackfillStyle > & GetStyles()Gets the value of Styles_Optional, regardless of it having been set.
public inline const TArray< ERHAPI_BackfillStyle > & GetStyles() constGets the value of Styles_Optional, regardless of it having been set.
public inline const TArray< ERHAPI_BackfillStyle > & GetStyles(const TArray< ERHAPI_BackfillStyle > & DefaultValue) constGets the value of Styles_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetStyles(TArray< ERHAPI_BackfillStyle > & OutValue) constFills OutValue with the value of Styles_Optional and returns true if it has been set, otherwise returns false.
public inline TArray< ERHAPI_BackfillStyle > * GetStylesOrNull()Returns a pointer to Styles_Optional, if it has been set, otherwise returns nullptr.
public inline const TArray< ERHAPI_BackfillStyle > * GetStylesOrNull() constReturns a pointer to Styles_Optional, if it has been set, otherwise returns nullptr.
public inline void SetStyles(const TArray< ERHAPI_BackfillStyle > & NewValue)Sets the value of Styles_Optional and also sets Styles_IsSet to true.
public inline void SetStyles(TArray< ERHAPI_BackfillStyle > && NewValue)Sets the value of Styles_Optional and also sets Styles_IsSet to true using move semantics.
public inline void ClearStyles()Clears the value of Styles_Optional and sets Styles_IsSet to false.
public inline bool IsStylesSet() constChecks whether Styles_Optional has been set.

Members​

public FString InstanceId ​

The instance ID for this backfill request.

public TMap< FString, FString > Extensions_Optional ​

Additional extensions to add to the Assignment for the backfill resource associated with the session.

public bool Extensions_IsSet ​

true if Extensions_Optional has been set to a value

public ERHAPI_TeamOverflowAction OverflowAction_Optional ​

How to handle backfills that return too many players for a team.

public bool OverflowAction_IsSet ​

true if OverflowAction_Optional has been set to a value

public TArray< ERHAPI_BackfillStyle > Styles_Optional ​

The styles of backfill to acknowledge. Can provide multiple for backwards compatibility.

public bool Styles_IsSet ​

true if Styles_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 & GetInstanceId() ​

Gets the value of InstanceId.

public inline const FString & GetInstanceId() const ​

Gets the value of InstanceId.

public inline void SetInstanceId(const FString & NewValue) ​

Sets the value of InstanceId.

public inline void SetInstanceId(FString && NewValue) ​

Sets the value of InstanceId using move semantics.

public inline TMap< FString, FString > & GetExtensions() ​

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

public inline const TMap< FString, FString > & GetExtensions() const ​

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

public inline const TMap< FString, FString > & GetExtensions(const TMap< FString, FString > & DefaultValue) const ​

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

public inline bool GetExtensions(TMap< FString, FString > & OutValue) const ​

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

public inline TMap< FString, FString > * GetExtensionsOrNull() ​

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

public inline const TMap< FString, FString > * GetExtensionsOrNull() const ​

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

public inline void SetExtensions(const TMap< FString, FString > & NewValue) ​

Sets the value of Extensions_Optional and also sets Extensions_IsSet to true.

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

Sets the value of Extensions_Optional and also sets Extensions_IsSet to true using move semantics.

public inline void ClearExtensions() ​

Clears the value of Extensions_Optional and sets Extensions_IsSet to false.

public inline bool IsExtensionsSet() const ​

Checks whether Extensions_Optional has been set.

public inline ERHAPI_TeamOverflowAction & GetOverflowAction() ​

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

public inline const ERHAPI_TeamOverflowAction & GetOverflowAction() const ​

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

public inline const ERHAPI_TeamOverflowAction & GetOverflowAction(const ERHAPI_TeamOverflowAction & DefaultValue) const ​

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

public inline bool GetOverflowAction(ERHAPI_TeamOverflowAction & OutValue) const ​

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

public inline ERHAPI_TeamOverflowAction * GetOverflowActionOrNull() ​

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

public inline const ERHAPI_TeamOverflowAction * GetOverflowActionOrNull() const ​

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

public inline void SetOverflowAction(const ERHAPI_TeamOverflowAction & NewValue) ​

Sets the value of OverflowAction_Optional and also sets OverflowAction_IsSet to true.

public inline void SetOverflowAction(ERHAPI_TeamOverflowAction && NewValue) ​

Sets the value of OverflowAction_Optional and also sets OverflowAction_IsSet to true using move semantics.

public inline void ClearOverflowAction() ​

Clears the value of OverflowAction_Optional and sets OverflowAction_IsSet to false.

public inline bool IsOverflowActionSet() const ​

Checks whether OverflowAction_Optional has been set.

public inline TArray< ERHAPI_BackfillStyle > & GetStyles() ​

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

public inline const TArray< ERHAPI_BackfillStyle > & GetStyles() const ​

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

public inline const TArray< ERHAPI_BackfillStyle > & GetStyles(const TArray< ERHAPI_BackfillStyle > & DefaultValue) const ​

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

public inline bool GetStyles(TArray< ERHAPI_BackfillStyle > & OutValue) const ​

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

public inline TArray< ERHAPI_BackfillStyle > * GetStylesOrNull() ​

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

public inline const TArray< ERHAPI_BackfillStyle > * GetStylesOrNull() const ​

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

public inline void SetStyles(const TArray< ERHAPI_BackfillStyle > & NewValue) ​

Sets the value of Styles_Optional and also sets Styles_IsSet to true.

public inline void SetStyles(TArray< ERHAPI_BackfillStyle > && NewValue) ​

Sets the value of Styles_Optional and also sets Styles_IsSet to true using move semantics.

public inline void ClearStyles() ​

Clears the value of Styles_Optional and sets Styles_IsSet to false.

public inline bool IsStylesSet() const ​

Checks whether Styles_Optional has been set.