Skip to main content

RHAPI_MatchmakingResults

Summary​

MembersDescriptions
struct FRHAPI_MatchmakingResults

struct FRHAPI_MatchmakingResults ​

struct FRHAPI_MatchmakingResults
: public FRHAPI_Model

Summary​

MembersDescriptions
public FString MatchMakingIdUnique ID.
public FDateTime CreatedDatetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.
public TMap< FString, FString > CustomData_OptionalMMF defined custom data.
public bool CustomData_IsSettrue if CustomData_Optional has been set to a value
public TArray< FString > TicketIds_OptionalList of tickets that were assigned to this match if created by matchmaking.
public bool TicketIds_IsSettrue if TicketIds_Optional has been set to a value
public TArray< FRHAPI_TicketData>TicketData_OptionalList of all the ticket data that was used when generating this match.
public bool TicketData_IsSettrue if TicketData_Optional has been set to a value
public bool TicketsAssigned_OptionalWhether or not the tickets from these results have been assigned.
public bool TicketsAssigned_IsSettrue if TicketsAssigned_Optional has been set to a value
public FRHAPI_MatchMakingProfileV2 Profile_OptionalThe profile used to create this match.
public bool Profile_IsSettrue if Profile_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 & GetMatchMakingId()Gets the value of MatchMakingId.
public inline const FString & GetMatchMakingId() constGets the value of MatchMakingId.
public inline void SetMatchMakingId(const FString & NewValue)Sets the value of MatchMakingId.
public inline void SetMatchMakingId(FString && NewValue)Sets the value of MatchMakingId using move semantics.
public inline FDateTime & GetCreated()Gets the value of Created.
public inline const FDateTime & GetCreated() constGets the value of Created.
public inline void SetCreated(const FDateTime & NewValue)Sets the value of Created.
public inline void SetCreated(FDateTime && NewValue)Sets the value of Created using move semantics.
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() constGets the value of CustomData_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetCustomData(const TMap< FString, FString > & DefaultValue) constGets the value of CustomData_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetCustomData(TMap< FString, FString > & OutValue) constFills 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() constReturns 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() constChecks whether CustomData_Optional has been set.
public inline TArray< FString > & GetTicketIds()Gets the value of TicketIds_Optional, regardless of it having been set.
public inline const TArray< FString > & GetTicketIds() constGets the value of TicketIds_Optional, regardless of it having been set.
public inline const TArray< FString > & GetTicketIds(const TArray< FString > & DefaultValue) constGets the value of TicketIds_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetTicketIds(TArray< FString > & OutValue) constFills OutValue with the value of TicketIds_Optional and returns true if it has been set, otherwise returns false.
public inline TArray< FString > * GetTicketIdsOrNull()Returns a pointer to TicketIds_Optional, if it has been set, otherwise returns nullptr.
public inline const TArray< FString > * GetTicketIdsOrNull() constReturns a pointer to TicketIds_Optional, if it has been set, otherwise returns nullptr.
public inline void SetTicketIds(const TArray< FString > & NewValue)Sets the value of TicketIds_Optional and also sets TicketIds_IsSet to true.
public inline void SetTicketIds(TArray< FString > && NewValue)Sets the value of TicketIds_Optional and also sets TicketIds_IsSet to true using move semantics.
public inline void ClearTicketIds()Clears the value of TicketIds_Optional and sets TicketIds_IsSet to false.
public inline bool IsTicketIdsSet() constChecks whether TicketIds_Optional has been set.
public inline TArray< FRHAPI_TicketData> &GetTicketData()Gets the value of TicketData_Optional, regardless of it having been set.
public inline const TArray< FRHAPI_TicketData> &GetTicketData() constGets the value of TicketData_Optional, regardless of it having been set.
public inline const TArray< FRHAPI_TicketData> &GetTicketData(const TArray< FRHAPI_TicketData > & DefaultValue) constGets the value of TicketData_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetTicketData(TArray< FRHAPI_TicketData > & OutValue) constFills OutValue with the value of TicketData_Optional and returns true if it has been set, otherwise returns false.
public inline TArray< FRHAPI_TicketData> *GetTicketDataOrNull()Returns a pointer to TicketData_Optional, if it has been set, otherwise returns nullptr.
public inline const TArray< FRHAPI_TicketData> *GetTicketDataOrNull() constReturns a pointer to TicketData_Optional, if it has been set, otherwise returns nullptr.
public inline void SetTicketData(const TArray< FRHAPI_TicketData > & NewValue)Sets the value of TicketData_Optional and also sets TicketData_IsSet to true.
public inline void SetTicketData(TArray< FRHAPI_TicketData > && NewValue)Sets the value of TicketData_Optional and also sets TicketData_IsSet to true using move semantics.
public inline void ClearTicketData()Clears the value of TicketData_Optional and sets TicketData_IsSet to false.
public inline bool IsTicketDataSet() constChecks whether TicketData_Optional has been set.
public inline bool & GetTicketsAssigned()Gets the value of TicketsAssigned_Optional, regardless of it having been set.
public inline const bool & GetTicketsAssigned() constGets the value of TicketsAssigned_Optional, regardless of it having been set.
public inline const bool & GetTicketsAssigned(const bool & DefaultValue) constGets the value of TicketsAssigned_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetTicketsAssigned(bool & OutValue) constFills OutValue with the value of TicketsAssigned_Optional and returns true if it has been set, otherwise returns false.
public inline bool * GetTicketsAssignedOrNull()Returns a pointer to TicketsAssigned_Optional, if it has been set, otherwise returns nullptr.
public inline const bool * GetTicketsAssignedOrNull() constReturns a pointer to TicketsAssigned_Optional, if it has been set, otherwise returns nullptr.
public inline void SetTicketsAssigned(const bool & NewValue)Sets the value of TicketsAssigned_Optional and also sets TicketsAssigned_IsSet to true.
public inline void SetTicketsAssigned(bool && NewValue)Sets the value of TicketsAssigned_Optional and also sets TicketsAssigned_IsSet to true using move semantics.
public inline void ClearTicketsAssigned()Clears the value of TicketsAssigned_Optional and sets TicketsAssigned_IsSet to false.
public inline bool IsTicketsAssignedSet() constChecks whether TicketsAssigned_Optional has been set.
public inline bool IsTicketsAssignedDefaultValue() constReturns true if TicketsAssigned_Optional is set and matches the default value.
public inline void SetTicketsAssignedToDefault()Sets the value of TicketsAssigned_Optional to its default and also sets TicketsAssigned_IsSet to true.
public inline FRHAPI_MatchMakingProfileV2&GetProfile()Gets the value of Profile_Optional, regardless of it having been set.
public inline const FRHAPI_MatchMakingProfileV2&GetProfile() constGets the value of Profile_Optional, regardless of it having been set.
public inline const FRHAPI_MatchMakingProfileV2&GetProfile(const FRHAPI_MatchMakingProfileV2 & DefaultValue) constGets the value of Profile_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetProfile(FRHAPI_MatchMakingProfileV2 & OutValue) constFills OutValue with the value of Profile_Optional and returns true if it has been set, otherwise returns false.
public inline FRHAPI_MatchMakingProfileV2*GetProfileOrNull()Returns a pointer to Profile_Optional, if it has been set, otherwise returns nullptr.
public inline const FRHAPI_MatchMakingProfileV2*GetProfileOrNull() constReturns a pointer to Profile_Optional, if it has been set, otherwise returns nullptr.
public inline void SetProfile(const FRHAPI_MatchMakingProfileV2 & NewValue)Sets the value of Profile_Optional and also sets Profile_IsSet to true.
public inline void SetProfile(FRHAPI_MatchMakingProfileV2 && NewValue)Sets the value of Profile_Optional and also sets Profile_IsSet to true using move semantics.
public inline void ClearProfile()Clears the value of Profile_Optional and sets Profile_IsSet to false.
public inline bool IsProfileSet() constChecks whether Profile_Optional has been set.

Members​

public FString MatchMakingId ​

Unique ID.

public FDateTime Created ​

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.

public TMap< FString, FString > CustomData_Optional ​

MMF defined custom data.

public bool CustomData_IsSet ​

true if CustomData_Optional has been set to a value

public TArray< FString > TicketIds_Optional ​

List of tickets that were assigned to this match if created by matchmaking.

public bool TicketIds_IsSet ​

true if TicketIds_Optional has been set to a value

public TArray< FRHAPI_TicketData>TicketData_Optional ​

List of all the ticket data that was used when generating this match.

public bool TicketData_IsSet ​

true if TicketData_Optional has been set to a value

public bool TicketsAssigned_Optional ​

Whether or not the tickets from these results have been assigned.

public bool TicketsAssigned_IsSet ​

true if TicketsAssigned_Optional has been set to a value

public FRHAPI_MatchMakingProfileV2 Profile_Optional ​

The profile used to create this match.

public bool Profile_IsSet ​

true if Profile_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 & GetMatchMakingId() ​

Gets the value of MatchMakingId.

public inline const FString & GetMatchMakingId() const ​

Gets the value of MatchMakingId.

public inline void SetMatchMakingId(const FString & NewValue) ​

Sets the value of MatchMakingId.

public inline void SetMatchMakingId(FString && NewValue) ​

Sets the value of MatchMakingId using move semantics.

public inline FDateTime & GetCreated() ​

Gets the value of Created.

public inline const FDateTime & GetCreated() const ​

Gets the value of Created.

public inline void SetCreated(const FDateTime & NewValue) ​

Sets the value of Created.

public inline void SetCreated(FDateTime && NewValue) ​

Sets the value of Created using move semantics.

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 TArray< FString > & GetTicketIds() ​

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

public inline const TArray< FString > & GetTicketIds() const ​

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

public inline const TArray< FString > & GetTicketIds(const TArray< FString > & DefaultValue) const ​

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

public inline bool GetTicketIds(TArray< FString > & OutValue) const ​

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

public inline TArray< FString > * GetTicketIdsOrNull() ​

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

public inline const TArray< FString > * GetTicketIdsOrNull() const ​

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

public inline void SetTicketIds(const TArray< FString > & NewValue) ​

Sets the value of TicketIds_Optional and also sets TicketIds_IsSet to true.

public inline void SetTicketIds(TArray< FString > && NewValue) ​

Sets the value of TicketIds_Optional and also sets TicketIds_IsSet to true using move semantics.

public inline void ClearTicketIds() ​

Clears the value of TicketIds_Optional and sets TicketIds_IsSet to false.

public inline bool IsTicketIdsSet() const ​

Checks whether TicketIds_Optional has been set.

public inline TArray< FRHAPI_TicketData> &GetTicketData() ​

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

public inline const TArray< FRHAPI_TicketData> &GetTicketData() const ​

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

public inline const TArray< FRHAPI_TicketData> &GetTicketData(const TArray< FRHAPI_TicketData > & DefaultValue) const ​

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

public inline bool GetTicketData(TArray< FRHAPI_TicketData > & OutValue) const ​

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

public inline TArray< FRHAPI_TicketData> *GetTicketDataOrNull() ​

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

public inline const TArray< FRHAPI_TicketData> *GetTicketDataOrNull() const ​

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

public inline void SetTicketData(const TArray< FRHAPI_TicketData > & NewValue) ​

Sets the value of TicketData_Optional and also sets TicketData_IsSet to true.

public inline void SetTicketData(TArray< FRHAPI_TicketData > && NewValue) ​

Sets the value of TicketData_Optional and also sets TicketData_IsSet to true using move semantics.

public inline void ClearTicketData() ​

Clears the value of TicketData_Optional and sets TicketData_IsSet to false.

public inline bool IsTicketDataSet() const ​

Checks whether TicketData_Optional has been set.

public inline bool & GetTicketsAssigned() ​

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

public inline const bool & GetTicketsAssigned() const ​

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

public inline const bool & GetTicketsAssigned(const bool & DefaultValue) const ​

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

public inline bool GetTicketsAssigned(bool & OutValue) const ​

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

public inline bool * GetTicketsAssignedOrNull() ​

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

public inline const bool * GetTicketsAssignedOrNull() const ​

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

public inline void SetTicketsAssigned(const bool & NewValue) ​

Sets the value of TicketsAssigned_Optional and also sets TicketsAssigned_IsSet to true.

public inline void SetTicketsAssigned(bool && NewValue) ​

Sets the value of TicketsAssigned_Optional and also sets TicketsAssigned_IsSet to true using move semantics.

public inline void ClearTicketsAssigned() ​

Clears the value of TicketsAssigned_Optional and sets TicketsAssigned_IsSet to false.

public inline bool IsTicketsAssignedSet() const ​

Checks whether TicketsAssigned_Optional has been set.

public inline bool IsTicketsAssignedDefaultValue() const ​

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

public inline void SetTicketsAssignedToDefault() ​

Sets the value of TicketsAssigned_Optional to its default and also sets TicketsAssigned_IsSet to true.

public inline FRHAPI_MatchMakingProfileV2&GetProfile() ​

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

public inline const FRHAPI_MatchMakingProfileV2&GetProfile() const ​

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

public inline const FRHAPI_MatchMakingProfileV2&GetProfile(const FRHAPI_MatchMakingProfileV2 & DefaultValue) const ​

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

public inline bool GetProfile(FRHAPI_MatchMakingProfileV2 & OutValue) const ​

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

public inline FRHAPI_MatchMakingProfileV2*GetProfileOrNull() ​

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

public inline const FRHAPI_MatchMakingProfileV2*GetProfileOrNull() const ​

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

public inline void SetProfile(const FRHAPI_MatchMakingProfileV2 & NewValue) ​

Sets the value of Profile_Optional and also sets Profile_IsSet to true.

public inline void SetProfile(FRHAPI_MatchMakingProfileV2 && NewValue) ​

Sets the value of Profile_Optional and also sets Profile_IsSet to true using move semantics.

public inline void ClearProfile() ​

Clears the value of Profile_Optional and sets Profile_IsSet to false.

public inline bool IsProfileSet() const ​

Checks whether Profile_Optional has been set.