RHAPI_MatchInfo
Summary
Members | Descriptions |
---|---|
struct FRHAPI_MatchInfo | Information about a match. |
struct FRHAPI_MatchInfo
struct FRHAPI_MatchInfo
: public FRHAPI_Model
Information about a match.
Summary
Members | Descriptions |
---|---|
public FString MatchId | 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 | instance-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 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 & GetMatchId () | Gets the value of MatchId. |
public inline const FString & GetMatchId () const | Gets the value of MatchId. |
public inline void SetMatchId (FString NewValue) | Sets the value of MatchId. |
public inline FDateTime & GetCreated () | Gets the value of Created. |
public inline const FDateTime & GetCreated () const | Gets the value of Created. |
public inline void SetCreated (FDateTime NewValue) | Sets the value of Created. |
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 (TMap< FString, FString > NewValue) | Sets the value of CustomData_Optional and also sets CustomData_IsSet to true. |
public inline void ClearCustomData () | Clears the value of CustomData_Optional and sets CustomData_IsSet to false. |
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 (TArray< FString > NewValue) | Sets the value of TicketIds_Optional and also sets TicketIds_IsSet to true. |
public inline void ClearTicketIds () | Clears the value of TicketIds_Optional and sets TicketIds_IsSet to false. |
Members
public FString
MatchId
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
instance-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 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 &
GetMatchId
()
Gets the value of MatchId.
public inline const FString &
GetMatchId
() const
Gets the value of MatchId.
public inline void
SetMatchId
(FString NewValue)
Sets the value of MatchId.
public inline FDateTime &
GetCreated
()
Gets the value of Created.
public inline const FDateTime &
GetCreated
() const
Gets the value of Created.
public inline void
SetCreated
(FDateTime NewValue)
Sets the value of Created.
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
(TMap< FString, FString > NewValue)
Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.
public inline void
ClearCustomData
()
Clears the value of CustomData_Optional and sets CustomData_IsSet to false.
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
(TArray< FString > NewValue)
Sets the value of TicketIds_Optional and also sets TicketIds_IsSet to true.
public inline void
ClearTicketIds
()
Clears the value of TicketIds_Optional and sets TicketIds_IsSet to false.