RHAPI_AdditionalJoinParams
Summary
Members | Descriptions |
---|---|
struct FRHAPI_AdditionalJoinParams | Additional parameters to apply to a matchmaking ticket. |
struct FRHAPI_AdditionalJoinParams
struct FRHAPI_AdditionalJoinParams
: public FRHAPI_Model
Additional parameters to apply to a matchmaking ticket.
Summary
Members | Descriptions |
---|---|
public TMap< FString, float > DoubleArgs_Optional | Additional double arguments to add to the matchmaking ticket. |
public bool DoubleArgs_IsSet | true if DoubleArgs_Optional has been set to a value |
public TMap< FString, FString > StringArgs_Optional | Additional string arguments to add to the matchmaking ticket. |
public bool StringArgs_IsSet | true if StringArgs_Optional has been set to a value |
public TArray< FString > Tags_Optional | Additional tags to add to the matchmaking ticket. |
public bool Tags_IsSet | true if Tags_Optional has been set to a value |
public TMap< FString, FString > Extensions_Optional | Additional extensions to add to the matchmaking ticket. Value is a base64 string representation of the protobuf binary data. The data will be converted back to binary before being put on the ticket. |
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. |
public virtual void WriteJson (TSharedRef< TJsonWriter<>> & Writer) const | Writes the data from this object into the specified JSON Writer stream. |
public inline TMap< FString, float > & GetDoubleArgs () | Gets the value of DoubleArgs_Optional, regardless of it having been set. |
public inline const TMap< FString, float > & GetDoubleArgs () const | Gets the value of DoubleArgs_Optional, regardless of it having been set. |
public inline const TMap< FString, float > & GetDoubleArgs (const TMap< FString, float > & DefaultValue) const | Gets the value of DoubleArgs_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetDoubleArgs (TMap< FString, float > & OutValue) const | Fills OutValue with the value of DoubleArgs_Optional and returns true if it has been set, otherwise returns false. |
public inline TMap< FString, float > * GetDoubleArgsOrNull () | Returns a pointer to DoubleArgs_Optional, if it has been set, otherwise returns nullptr. |
public inline const TMap< FString, float > * GetDoubleArgsOrNull () const | Returns a pointer to DoubleArgs_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetDoubleArgs (TMap< FString, float > NewValue) | Sets the value of DoubleArgs_Optional and also sets DoubleArgs_IsSet to true. |
public inline void ClearDoubleArgs () | Clears the value of DoubleArgs_Optional and sets DoubleArgs_IsSet to false. |
public inline TMap< FString, FString > & GetStringArgs () | Gets the value of StringArgs_Optional, regardless of it having been set. |
public inline const TMap< FString, FString > & GetStringArgs () const | Gets the value of StringArgs_Optional, regardless of it having been set. |
public inline const TMap< FString, FString > & GetStringArgs (const TMap< FString, FString > & DefaultValue) const | Gets the value of StringArgs_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetStringArgs (TMap< FString, FString > & OutValue) const | Fills OutValue with the value of StringArgs_Optional and returns true if it has been set, otherwise returns false. |
public inline TMap< FString, FString > * GetStringArgsOrNull () | Returns a pointer to StringArgs_Optional, if it has been set, otherwise returns nullptr. |
public inline const TMap< FString, FString > * GetStringArgsOrNull () const | Returns a pointer to StringArgs_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetStringArgs (TMap< FString, FString > NewValue) | Sets the value of StringArgs_Optional and also sets StringArgs_IsSet to true. |
public inline void ClearStringArgs () | Clears the value of StringArgs_Optional and sets StringArgs_IsSet to false. |
public inline TArray< FString > & GetTags () | Gets the value of Tags_Optional, regardless of it having been set. |
public inline const TArray< FString > & GetTags () const | Gets the value of Tags_Optional, regardless of it having been set. |
public inline const TArray< FString > & GetTags (const TArray< FString > & DefaultValue) const | Gets the value of Tags_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetTags (TArray< FString > & OutValue) const | Fills OutValue with the value of Tags_Optional and returns true if it has been set, otherwise returns false. |
public inline TArray< FString > * GetTagsOrNull () | Returns a pointer to Tags_Optional, if it has been set, otherwise returns nullptr. |
public inline const TArray< FString > * GetTagsOrNull () const | Returns a pointer to Tags_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetTags (TArray< FString > NewValue) | Sets the value of Tags_Optional and also sets Tags_IsSet to true. |
public inline void ClearTags () | Clears the value of Tags_Optional and sets Tags_IsSet to false. |
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 (TMap< FString, FString > NewValue) | Sets the value of Extensions_Optional and also sets Extensions_IsSet to true. |
public inline void ClearExtensions () | Clears the value of Extensions_Optional and sets Extensions_IsSet to false. |
Members
public TMap< FString, float >
DoubleArgs_Optional
Additional double arguments to add to the matchmaking ticket.
public bool
DoubleArgs_IsSet
true if DoubleArgs_Optional has been set to a value
public TMap< FString, FString >
StringArgs_Optional
Additional string arguments to add to the matchmaking ticket.
public bool
StringArgs_IsSet
true if StringArgs_Optional has been set to a value
public TArray< FString >
Tags_Optional
Additional tags to add to the matchmaking ticket.
public bool
Tags_IsSet
true if Tags_Optional has been set to a value
public TMap< FString, FString >
Extensions_Optional
Additional extensions to add to the matchmaking ticket. Value is a base64 string representation of the protobuf binary data. The data will be converted back to binary before being put on the ticket.
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 TMap< FString, float > &
GetDoubleArgs
()
Gets the value of DoubleArgs_Optional, regardless of it having been set.
public inline const TMap< FString, float > &
GetDoubleArgs
() const
Gets the value of DoubleArgs_Optional, regardless of it having been set.
public inline const TMap< FString, float > &
GetDoubleArgs
(const TMap< FString, float > & DefaultValue) const
Gets the value of DoubleArgs_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool
GetDoubleArgs
(TMap< FString, float > & OutValue) const
Fills OutValue with the value of DoubleArgs_Optional and returns true if it has been set, otherwise returns false.
public inline TMap< FString, float > *
GetDoubleArgsOrNull
()
Returns a pointer to DoubleArgs_Optional, if it has been set, otherwise returns nullptr.
public inline const TMap< FString, float > *
GetDoubleArgsOrNull
() const
Returns a pointer to DoubleArgs_Optional, if it has been set, otherwise returns nullptr.
public inline void
SetDoubleArgs
(TMap< FString, float > NewValue)
Sets the value of DoubleArgs_Optional and also sets DoubleArgs_IsSet to true.
public inline void
ClearDoubleArgs
()
Clears the value of DoubleArgs_Optional and sets DoubleArgs_IsSet to false.
public inline TMap< FString, FString > &
GetStringArgs
()
Gets the value of StringArgs_Optional, regardless of it having been set.
public inline const TMap< FString, FString > &
GetStringArgs
() const
Gets the value of StringArgs_Optional, regardless of it having been set.
public inline const TMap< FString, FString > &
GetStringArgs
(const TMap< FString, FString > & DefaultValue) const
Gets the value of StringArgs_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool
GetStringArgs
(TMap< FString, FString > & OutValue) const
Fills OutValue with the value of StringArgs_Optional and returns true if it has been set, otherwise returns false.
public inline TMap< FString, FString > *
GetStringArgsOrNull
()
Returns a pointer to StringArgs_Optional, if it has been set, otherwise returns nullptr.
public inline const TMap< FString, FString > *
GetStringArgsOrNull
() const
Returns a pointer to StringArgs_Optional, if it has been set, otherwise returns nullptr.
public inline void
SetStringArgs
(TMap< FString, FString > NewValue)
Sets the value of StringArgs_Optional and also sets StringArgs_IsSet to true.
public inline void
ClearStringArgs
()
Clears the value of StringArgs_Optional and sets StringArgs_IsSet to false.
public inline TArray< FString > &
GetTags
()
Gets the value of Tags_Optional, regardless of it having been set.
public inline const TArray< FString > &
GetTags
() const
Gets the value of Tags_Optional, regardless of it having been set.
public inline const TArray< FString > &
GetTags
(const TArray< FString > & DefaultValue) const
Gets the value of Tags_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool
GetTags
(TArray< FString > & OutValue) const
Fills OutValue with the value of Tags_Optional and returns true if it has been set, otherwise returns false.
public inline TArray< FString > *
GetTagsOrNull
()
Returns a pointer to Tags_Optional, if it has been set, otherwise returns nullptr.
public inline const TArray< FString > *
GetTagsOrNull
() const
Returns a pointer to Tags_Optional, if it has been set, otherwise returns nullptr.
public inline void
SetTags
(TArray< FString > NewValue)
Sets the value of Tags_Optional and also sets Tags_IsSet to true.
public inline void
ClearTags
()
Clears the value of Tags_Optional and sets Tags_IsSet to false.
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
(TMap< FString, FString > NewValue)
Sets the value of Extensions_Optional and also sets Extensions_IsSet to true.
public inline void
ClearExtensions
()
Clears the value of Extensions_Optional and sets Extensions_IsSet to false.