Skip to main content

RHAPI_QueueJoinRequest

Summary​

MembersDescriptions
struct FRHAPI_QueueJoinRequestA request body to enter into a matchmaking queue.

struct FRHAPI_QueueJoinRequest ​

struct FRHAPI_QueueJoinRequest
  : public FRHAPI_Model

A request body to enter into a matchmaking queue.

Summary​

MembersDescriptions
public FString QueueIdID of the queue to join.
public FRHAPI_AdditionalJoinParams AdditionalJoinParams_OptionalAdditional fields put on the matchmaking ticket for open match to search with (see https://openmatch.dev/site/docs/reference/api/#searchfields)
public bool AdditionalJoinParams_IsSettrue if AdditionalJoinParams_Optional has been set to a value
public TArray< FString > MapPreferences_OptionalList of map preferences in order from most desired, to least desired.
public bool MapPreferences_IsSettrue if MapPreferences_Optional has been set to a value
public int32 PassedQueueTimeSeconds_OptionalArgument to artifcially add queue time to a ticket. Older tickets are considered for lower quaulity matches. This can be used to get faster matches at the expense of quality, or to restore a session's place in queue after a failure.
public bool PassedQueueTimeSeconds_IsSettrue if PassedQueueTimeSeconds_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 & GetQueueId()Gets the value of QueueId.
public inline const FString & GetQueueId() constGets the value of QueueId.
public inline void SetQueueId(const FString & NewValue)Sets the value of QueueId.
public inline void SetQueueId(FString && NewValue)Sets the value of QueueId using move semantics.
public inline FRHAPI_AdditionalJoinParams&GetAdditionalJoinParams()Gets the value of AdditionalJoinParams_Optional, regardless of it having been set.
public inline const FRHAPI_AdditionalJoinParams&GetAdditionalJoinParams() constGets the value of AdditionalJoinParams_Optional, regardless of it having been set.
public inline const FRHAPI_AdditionalJoinParams&GetAdditionalJoinParams(const FRHAPI_AdditionalJoinParams & DefaultValue) constGets the value of AdditionalJoinParams_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetAdditionalJoinParams(FRHAPI_AdditionalJoinParams & OutValue) constFills 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() constReturns a pointer to AdditionalJoinParams_Optional, if it has been set, otherwise returns nullptr.
public inline void SetAdditionalJoinParams(const FRHAPI_AdditionalJoinParams & NewValue)Sets the value of AdditionalJoinParams_Optional and also sets AdditionalJoinParams_IsSet to true.
public inline void SetAdditionalJoinParams(FRHAPI_AdditionalJoinParams && NewValue)Sets the value of AdditionalJoinParams_Optional and also sets AdditionalJoinParams_IsSet to true using move semantics.
public inline void ClearAdditionalJoinParams()Clears the value of AdditionalJoinParams_Optional and sets AdditionalJoinParams_IsSet to false.
public inline bool IsAdditionalJoinParamsSet() constChecks whether AdditionalJoinParams_Optional has been set.
public inline TArray< FString > & GetMapPreferences()Gets the value of MapPreferences_Optional, regardless of it having been set.
public inline const TArray< FString > & GetMapPreferences() constGets the value of MapPreferences_Optional, regardless of it having been set.
public inline const TArray< FString > & GetMapPreferences(const TArray< FString > & DefaultValue) constGets the value of MapPreferences_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetMapPreferences(TArray< FString > & OutValue) constFills OutValue with the value of MapPreferences_Optional and returns true if it has been set, otherwise returns false.
public inline TArray< FString > * GetMapPreferencesOrNull()Returns a pointer to MapPreferences_Optional, if it has been set, otherwise returns nullptr.
public inline const TArray< FString > * GetMapPreferencesOrNull() constReturns a pointer to MapPreferences_Optional, if it has been set, otherwise returns nullptr.
public inline void SetMapPreferences(const TArray< FString > & NewValue)Sets the value of MapPreferences_Optional and also sets MapPreferences_IsSet to true.
public inline void SetMapPreferences(TArray< FString > && NewValue)Sets the value of MapPreferences_Optional and also sets MapPreferences_IsSet to true using move semantics.
public inline void ClearMapPreferences()Clears the value of MapPreferences_Optional and sets MapPreferences_IsSet to false.
public inline bool IsMapPreferencesSet() constChecks whether MapPreferences_Optional has been set.
public inline int32 & GetPassedQueueTimeSeconds()Gets the value of PassedQueueTimeSeconds_Optional, regardless of it having been set.
public inline const int32 & GetPassedQueueTimeSeconds() constGets the value of PassedQueueTimeSeconds_Optional, regardless of it having been set.
public inline const int32 & GetPassedQueueTimeSeconds(const int32 & DefaultValue) constGets the value of PassedQueueTimeSeconds_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetPassedQueueTimeSeconds(int32 & OutValue) constFills OutValue with the value of PassedQueueTimeSeconds_Optional and returns true if it has been set, otherwise returns false.
public inline int32 * GetPassedQueueTimeSecondsOrNull()Returns a pointer to PassedQueueTimeSeconds_Optional, if it has been set, otherwise returns nullptr.
public inline const int32 * GetPassedQueueTimeSecondsOrNull() constReturns a pointer to PassedQueueTimeSeconds_Optional, if it has been set, otherwise returns nullptr.
public inline void SetPassedQueueTimeSeconds(const int32 & NewValue)Sets the value of PassedQueueTimeSeconds_Optional and also sets PassedQueueTimeSeconds_IsSet to true.
public inline void SetPassedQueueTimeSeconds(int32 && NewValue)Sets the value of PassedQueueTimeSeconds_Optional and also sets PassedQueueTimeSeconds_IsSet to true using move semantics.
public inline void ClearPassedQueueTimeSeconds()Clears the value of PassedQueueTimeSeconds_Optional and sets PassedQueueTimeSeconds_IsSet to false.
public inline bool IsPassedQueueTimeSecondsSet() constChecks whether PassedQueueTimeSeconds_Optional has been set.
public inline bool IsPassedQueueTimeSecondsDefaultValue() constReturns true if PassedQueueTimeSeconds_Optional is set and matches the default value.
public inline void SetPassedQueueTimeSecondsToDefault()Sets the value of PassedQueueTimeSeconds_Optional to its default and also sets PassedQueueTimeSeconds_IsSet to true.

Members​

public FString QueueId ​

ID of the queue to join.

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< FString > MapPreferences_Optional ​

List of map preferences in order from most desired, to least desired.

public bool MapPreferences_IsSet ​

true if MapPreferences_Optional has been set to a value

public int32 PassedQueueTimeSeconds_Optional ​

Argument to artifcially add queue time to a ticket. Older tickets are considered for lower quaulity matches. This can be used to get faster matches at the expense of quality, or to restore a session's place in queue after a failure.

public bool PassedQueueTimeSeconds_IsSet ​

true if PassedQueueTimeSeconds_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 & GetQueueId() ​

Gets the value of QueueId.

public inline const FString & GetQueueId() const ​

Gets the value of QueueId.

public inline void SetQueueId(const FString & NewValue) ​

Sets the value of QueueId.

public inline void SetQueueId(FString && NewValue) ​

Sets the value of QueueId using move semantics.

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(const FRHAPI_AdditionalJoinParams & NewValue) ​

Sets the value of AdditionalJoinParams_Optional and also sets AdditionalJoinParams_IsSet to true.

public inline void SetAdditionalJoinParams(FRHAPI_AdditionalJoinParams && NewValue) ​

Sets the value of AdditionalJoinParams_Optional and also sets AdditionalJoinParams_IsSet to true using move semantics.

public inline void ClearAdditionalJoinParams() ​

Clears the value of AdditionalJoinParams_Optional and sets AdditionalJoinParams_IsSet to false.

public inline bool IsAdditionalJoinParamsSet() const ​

Checks whether AdditionalJoinParams_Optional has been set.

public inline TArray< FString > & GetMapPreferences() ​

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

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

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

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

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

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

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

public inline TArray< FString > * GetMapPreferencesOrNull() ​

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

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

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

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

Sets the value of MapPreferences_Optional and also sets MapPreferences_IsSet to true.

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

Sets the value of MapPreferences_Optional and also sets MapPreferences_IsSet to true using move semantics.

public inline void ClearMapPreferences() ​

Clears the value of MapPreferences_Optional and sets MapPreferences_IsSet to false.

public inline bool IsMapPreferencesSet() const ​

Checks whether MapPreferences_Optional has been set.

public inline int32 & GetPassedQueueTimeSeconds() ​

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

public inline const int32 & GetPassedQueueTimeSeconds() const ​

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

public inline const int32 & GetPassedQueueTimeSeconds(const int32 & DefaultValue) const ​

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

public inline bool GetPassedQueueTimeSeconds(int32 & OutValue) const ​

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

public inline int32 * GetPassedQueueTimeSecondsOrNull() ​

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

public inline const int32 * GetPassedQueueTimeSecondsOrNull() const ​

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

public inline void SetPassedQueueTimeSeconds(const int32 & NewValue) ​

Sets the value of PassedQueueTimeSeconds_Optional and also sets PassedQueueTimeSeconds_IsSet to true.

public inline void SetPassedQueueTimeSeconds(int32 && NewValue) ​

Sets the value of PassedQueueTimeSeconds_Optional and also sets PassedQueueTimeSeconds_IsSet to true using move semantics.

public inline void ClearPassedQueueTimeSeconds() ​

Clears the value of PassedQueueTimeSeconds_Optional and sets PassedQueueTimeSeconds_IsSet to false.

public inline bool IsPassedQueueTimeSecondsSet() const ​

Checks whether PassedQueueTimeSeconds_Optional has been set.

public inline bool IsPassedQueueTimeSecondsDefaultValue() const ​

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

public inline void SetPassedQueueTimeSecondsToDefault() ​

Sets the value of PassedQueueTimeSeconds_Optional to its default and also sets PassedQueueTimeSeconds_IsSet to true.