RHAPI_MatchmakingInfo

Summary

Members	Descriptions
struct FRHAPI_MatchmakingInfo	Info about the matchmaking status in a session.

struct FRHAPI_MatchmakingInfo

struct FRHAPI_MatchmakingInfo
  : public FRHAPI_Model

Info about the matchmaking status in a session.

Summary

Members	Descriptions
public FString TicketId	Unique ID for this attempt at matchmaking.
public TMap< FString, FString > CustomData_Optional	session-defined custom data
public bool CustomData_IsSet	true if CustomData_Optional has been set to a value
public FString QueueId_Optional	Unique ID for the joined queue.
public bool QueueId_IsSet	true if QueueId_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 & GetTicketId()	Gets the value of TicketId.
public inline const FString & GetTicketId() const	Gets the value of TicketId.
public inline void SetTicketId(const FString & NewValue)	Sets the value of TicketId.
public inline void SetTicketId(FString && NewValue)	Sets the value of TicketId 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 FString & GetQueueId()	Gets the value of QueueId_Optional, regardless of it having been set.
public inline const FString & GetQueueId() const	Gets the value of QueueId_Optional, regardless of it having been set.
public inline const FString & GetQueueId(const FString & DefaultValue) const	Gets the value of QueueId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetQueueId(FString & OutValue) const	Fills OutValue with the value of QueueId_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetQueueIdOrNull()	Returns a pointer to QueueId_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetQueueIdOrNull() const	Returns a pointer to QueueId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetQueueId(const FString & NewValue)	Sets the value of QueueId_Optional and also sets QueueId_IsSet to true.
public inline void SetQueueId(FString && NewValue)	Sets the value of QueueId_Optional and also sets QueueId_IsSet to true using move semantics.
public inline void ClearQueueId()	Clears the value of QueueId_Optional and sets QueueId_IsSet to false.
public inline bool IsQueueIdSet() const	Checks whether QueueId_Optional has been set.

Members

public FString TicketId

Unique ID for this attempt at matchmaking.

public TMap< FString, FString > CustomData_Optional

session-defined custom data

public bool CustomData_IsSet

true if CustomData_Optional has been set to a value

public FString QueueId_Optional

Unique ID for the joined queue.

public bool QueueId_IsSet

true if QueueId_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 & GetTicketId()

Gets the value of TicketId.

public inline const FString & GetTicketId() const

Gets the value of TicketId.

public inline void SetTicketId(const FString & NewValue)

Sets the value of TicketId.

public inline void SetTicketId(FString && NewValue)

Sets the value of TicketId 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 FString & GetQueueId()

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

public inline const FString & GetQueueId() const

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

public inline const FString & GetQueueId(const FString & DefaultValue) const

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

public inline bool GetQueueId(FString & OutValue) const

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

public inline FString * GetQueueIdOrNull()

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

public inline const FString * GetQueueIdOrNull() const

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

public inline void SetQueueId(const FString & NewValue)

Sets the value of QueueId_Optional and also sets QueueId_IsSet to true.

public inline void SetQueueId(FString && NewValue)

Sets the value of QueueId_Optional and also sets QueueId_IsSet to true using move semantics.

public inline void ClearQueueId()

Clears the value of QueueId_Optional and sets QueueId_IsSet to false.

public inline bool IsQueueIdSet() const

Checks whether QueueId_Optional has been set.