Skip to main content

RHAPI_BackfillInfo

Summary​

MembersDescriptions
struct FRHAPI_BackfillInfoInfo about the open-match backfill object in a session.

struct FRHAPI_BackfillInfo ​

struct FRHAPI_BackfillInfo
  : public FRHAPI_Model

Info about the open-match backfill object in a session.

Summary​

MembersDescriptions
public FString BackfillIdUnique ID for the backfill object.
public TMap< FString, FString > Extensions_OptionalOptional additional extensions used when acknowledging backfill requests.
public bool Extensions_IsSettrue if Extensions_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 & GetBackfillId()Gets the value of BackfillId.
public inline const FString & GetBackfillId() constGets the value of BackfillId.
public inline void SetBackfillId(const FString & NewValue)Sets the value of BackfillId.
public inline void SetBackfillId(FString && NewValue)Sets the value of BackfillId 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.

Members​

public FString BackfillId ​

Unique ID for the backfill object.

public TMap< FString, FString > Extensions_Optional ​

Optional additional extensions used when acknowledging backfill requests.

public bool Extensions_IsSet ​

true if Extensions_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 & GetBackfillId() ​

Gets the value of BackfillId.

public inline const FString & GetBackfillId() const ​

Gets the value of BackfillId.

public inline void SetBackfillId(const FString & NewValue) ​

Sets the value of BackfillId.

public inline void SetBackfillId(FString && NewValue) ​

Sets the value of BackfillId 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.