Skip to content
RallyHere Docs
GitHub

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_Optional
public bool AdditionalJoinParams_IsSettrue if AdditionalJoinParams_Optional has been set to a value
public TArray< FString > MapPreferencesList of map preferences in order from most desired, to least desired.
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(FString NewValue)Sets the value of QueueId.
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(FRHAPI_AdditionalJoinParams NewValue)Sets the value of AdditionalJoinParams_Optional and also sets AdditionalJoinParams_IsSet to true.
public inline void ClearAdditionalJoinParams()Clears the value of AdditionalJoinParams_Optional and sets AdditionalJoinParams_IsSet to false.
public inline TArray< FString > & GetMapPreferences()Gets the value of MapPreferences.
public inline const TArray< FString > & GetMapPreferences() constGets the value of MapPreferences.
public inline void SetMapPreferences(TArray< FString > NewValue)Sets the value of MapPreferences.

Members

public FString QueueId

ID of the queue to join.

public FRHAPI_AdditionalJoinParams AdditionalJoinParams_Optional

public bool AdditionalJoinParams_IsSet

true if AdditionalJoinParams_Optional has been set to a value

public TArray< FString > MapPreferences

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

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(FString NewValue)

Sets the value of QueueId.

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

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

public inline void ClearAdditionalJoinParams()

Clears the value of AdditionalJoinParams_Optional and sets AdditionalJoinParams_IsSet to false.

public inline TArray< FString > & GetMapPreferences()

Gets the value of MapPreferences.

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

Gets the value of MapPreferences.

public inline void SetMapPreferences(TArray< FString > NewValue)

Sets the value of MapPreferences.