RHAPI_MatchMakingSessionRequest
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_MatchMakingSessionRequest | A request body for a new matchmade session to be created. |
struct FRHAPI_MatchMakingSessionRequest
struct FRHAPI_MatchMakingSessionRequest
: public FRHAPI_ModelA request body for a new matchmade session to be created.
Summary
| Members | Descriptions |
|---|---|
public TArray< FRHAPI_SessionTeam>Teams | List of teams that are to be invited to session. |
public TMap< FString, FString > SessionTickets | List of sessions and tickets the match was made with. Used to verify this match should still be created. |
public FGuid InstanceLaunchTemplateId_Optional | Which launch template should be used to request an instance. |
public bool InstanceLaunchTemplateId_IsSet | true if InstanceLaunchTemplateId_Optional has been set to a value |
public FGuid InstanceRequestTemplateId_Optional | Which launch template should be used to request an instance. |
public bool InstanceRequestTemplateId_IsSet | true if InstanceRequestTemplateId_Optional has been set to a value |
public FString RegionId | Region to start the instance in. |
public FString MatchId | Unique ID for this generated match. |
public TMap< FString, FString > CustomData_Optional | Custom data about the match. |
public bool CustomData_IsSet | true if CustomData_Optional has been set to a value |
public FGuid HostPlayerUuid_Optional | Player UUID of the host, if the host type is player. |
public bool HostPlayerUuid_IsSet | true if HostPlayerUuid_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 TArray< FRHAPI_SessionTeam> &GetTeams() | Gets the value of Teams. |
public inline const TArray< FRHAPI_SessionTeam> &GetTeams() const | Gets the value of Teams. |
public inline void SetTeams(TArray< FRHAPI_SessionTeam > NewValue) | Sets the value of Teams. |
public inline TMap< FString, FString > & GetSessionTickets() | Gets the value of SessionTickets. |
public inline const TMap< FString, FString > & GetSessionTickets() const | Gets the value of SessionTickets. |
public inline void SetSessionTickets(TMap< FString, FString > NewValue) | Sets the value of SessionTickets. |
public inline FGuid & GetInstanceLaunchTemplateId() | Gets the value of InstanceLaunchTemplateId_Optional, regardless of it having been set. |
public inline const FGuid & GetInstanceLaunchTemplateId() const | Gets the value of InstanceLaunchTemplateId_Optional, regardless of it having been set. |
public inline const FGuid & GetInstanceLaunchTemplateId(const FGuid & DefaultValue) const | Gets the value of InstanceLaunchTemplateId_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetInstanceLaunchTemplateId(FGuid & OutValue) const | Fills OutValue with the value of InstanceLaunchTemplateId_Optional and returns true if it has been set, otherwise returns false. |
public inline FGuid * GetInstanceLaunchTemplateIdOrNull() | Returns a pointer to InstanceLaunchTemplateId_Optional, if it has been set, otherwise returns nullptr. |
public inline const FGuid * GetInstanceLaunchTemplateIdOrNull() const | Returns a pointer to InstanceLaunchTemplateId_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetInstanceLaunchTemplateId(FGuid NewValue) | Sets the value of InstanceLaunchTemplateId_Optional and also sets InstanceLaunchTemplateId_IsSet to true. |
public inline void ClearInstanceLaunchTemplateId() | Clears the value of InstanceLaunchTemplateId_Optional and sets InstanceLaunchTemplateId_IsSet to false. |
public inline FGuid & GetInstanceRequestTemplateId() | Gets the value of InstanceRequestTemplateId_Optional, regardless of it having been set. |
public inline const FGuid & GetInstanceRequestTemplateId() const | Gets the value of InstanceRequestTemplateId_Optional, regardless of it having been set. |
public inline const FGuid & GetInstanceRequestTemplateId(const FGuid & DefaultValue) const | Gets the value of InstanceRequestTemplateId_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetInstanceRequestTemplateId(FGuid & OutValue) const | Fills OutValue with the value of InstanceRequestTemplateId_Optional and returns true if it has been set, otherwise returns false. |
public inline FGuid * GetInstanceRequestTemplateIdOrNull() | Returns a pointer to InstanceRequestTemplateId_Optional, if it has been set, otherwise returns nullptr. |
public inline const FGuid * GetInstanceRequestTemplateIdOrNull() const | Returns a pointer to InstanceRequestTemplateId_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetInstanceRequestTemplateId(FGuid NewValue) | Sets the value of InstanceRequestTemplateId_Optional and also sets InstanceRequestTemplateId_IsSet to true. |
public inline void ClearInstanceRequestTemplateId() | Clears the value of InstanceRequestTemplateId_Optional and sets InstanceRequestTemplateId_IsSet to false. |
public inline FString & GetRegionId() | Gets the value of RegionId. |
public inline const FString & GetRegionId() const | Gets the value of RegionId. |
public inline void SetRegionId(FString NewValue) | Sets the value of RegionId. |
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 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 FGuid & GetHostPlayerUuid() | Gets the value of HostPlayerUuid_Optional, regardless of it having been set. |
public inline const FGuid & GetHostPlayerUuid() const | Gets the value of HostPlayerUuid_Optional, regardless of it having been set. |
public inline const FGuid & GetHostPlayerUuid(const FGuid & DefaultValue) const | Gets the value of HostPlayerUuid_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetHostPlayerUuid(FGuid & OutValue) const | Fills OutValue with the value of HostPlayerUuid_Optional and returns true if it has been set, otherwise returns false. |
public inline FGuid * GetHostPlayerUuidOrNull() | Returns a pointer to HostPlayerUuid_Optional, if it has been set, otherwise returns nullptr. |
public inline const FGuid * GetHostPlayerUuidOrNull() const | Returns a pointer to HostPlayerUuid_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetHostPlayerUuid(FGuid NewValue) | Sets the value of HostPlayerUuid_Optional and also sets HostPlayerUuid_IsSet to true. |
public inline void ClearHostPlayerUuid() | Clears the value of HostPlayerUuid_Optional and sets HostPlayerUuid_IsSet to false. |
Members
public TArray< FRHAPI_SessionTeam>Teams
List of teams that are to be invited to session.
public TMap< FString, FString > SessionTickets
List of sessions and tickets the match was made with. Used to verify this match should still be created.
public FGuid InstanceLaunchTemplateId_Optional
Which launch template should be used to request an instance.
public bool InstanceLaunchTemplateId_IsSet
true if InstanceLaunchTemplateId_Optional has been set to a value
public FGuid InstanceRequestTemplateId_Optional
Which launch template should be used to request an instance.
public bool InstanceRequestTemplateId_IsSet
true if InstanceRequestTemplateId_Optional has been set to a value
public FString RegionId
Region to start the instance in.
public FString MatchId
Unique ID for this generated match.
public TMap< FString, FString > CustomData_Optional
Custom data about the match.
public bool CustomData_IsSet
true if CustomData_Optional has been set to a value
public FGuid HostPlayerUuid_Optional
Player UUID of the host, if the host type is player.
public bool HostPlayerUuid_IsSet
true if HostPlayerUuid_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
JsonValueData 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
WriterJSON Writer stream to push .
public inline TArray< FRHAPI_SessionTeam> &GetTeams()
Gets the value of Teams.
public inline const TArray< FRHAPI_SessionTeam> &GetTeams() const
Gets the value of Teams.
public inline void SetTeams(TArray< FRHAPI_SessionTeam > NewValue)
Sets the value of Teams.
public inline TMap< FString, FString > & GetSessionTickets()
Gets the value of SessionTickets.
public inline const TMap< FString, FString > & GetSessionTickets() const
Gets the value of SessionTickets.
public inline void SetSessionTickets(TMap< FString, FString > NewValue)
Sets the value of SessionTickets.
public inline FGuid & GetInstanceLaunchTemplateId()
Gets the value of InstanceLaunchTemplateId_Optional, regardless of it having been set.
public inline const FGuid & GetInstanceLaunchTemplateId() const
Gets the value of InstanceLaunchTemplateId_Optional, regardless of it having been set.
public inline const FGuid & GetInstanceLaunchTemplateId(const FGuid & DefaultValue) const
Gets the value of InstanceLaunchTemplateId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetInstanceLaunchTemplateId(FGuid & OutValue) const
Fills OutValue with the value of InstanceLaunchTemplateId_Optional and returns true if it has been set, otherwise returns false.
public inline FGuid * GetInstanceLaunchTemplateIdOrNull()
Returns a pointer to InstanceLaunchTemplateId_Optional, if it has been set, otherwise returns nullptr.
public inline const FGuid * GetInstanceLaunchTemplateIdOrNull() const
Returns a pointer to InstanceLaunchTemplateId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetInstanceLaunchTemplateId(FGuid NewValue)
Sets the value of InstanceLaunchTemplateId_Optional and also sets InstanceLaunchTemplateId_IsSet to true.
public inline void ClearInstanceLaunchTemplateId()
Clears the value of InstanceLaunchTemplateId_Optional and sets InstanceLaunchTemplateId_IsSet to false.
public inline FGuid & GetInstanceRequestTemplateId()
Gets the value of InstanceRequestTemplateId_Optional, regardless of it having been set.
public inline const FGuid & GetInstanceRequestTemplateId() const
Gets the value of InstanceRequestTemplateId_Optional, regardless of it having been set.
public inline const FGuid & GetInstanceRequestTemplateId(const FGuid & DefaultValue) const
Gets the value of InstanceRequestTemplateId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetInstanceRequestTemplateId(FGuid & OutValue) const
Fills OutValue with the value of InstanceRequestTemplateId_Optional and returns true if it has been set, otherwise returns false.
public inline FGuid * GetInstanceRequestTemplateIdOrNull()
Returns a pointer to InstanceRequestTemplateId_Optional, if it has been set, otherwise returns nullptr.
public inline const FGuid * GetInstanceRequestTemplateIdOrNull() const
Returns a pointer to InstanceRequestTemplateId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetInstanceRequestTemplateId(FGuid NewValue)
Sets the value of InstanceRequestTemplateId_Optional and also sets InstanceRequestTemplateId_IsSet to true.
public inline void ClearInstanceRequestTemplateId()
Clears the value of InstanceRequestTemplateId_Optional and sets InstanceRequestTemplateId_IsSet to false.
public inline FString & GetRegionId()
Gets the value of RegionId.
public inline const FString & GetRegionId() const
Gets the value of RegionId.
public inline void SetRegionId(FString NewValue)
Sets the value of RegionId.
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 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 FGuid & GetHostPlayerUuid()
Gets the value of HostPlayerUuid_Optional, regardless of it having been set.
public inline const FGuid & GetHostPlayerUuid() const
Gets the value of HostPlayerUuid_Optional, regardless of it having been set.
public inline const FGuid & GetHostPlayerUuid(const FGuid & DefaultValue) const
Gets the value of HostPlayerUuid_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetHostPlayerUuid(FGuid & OutValue) const
Fills OutValue with the value of HostPlayerUuid_Optional and returns true if it has been set, otherwise returns false.
public inline FGuid * GetHostPlayerUuidOrNull()
Returns a pointer to HostPlayerUuid_Optional, if it has been set, otherwise returns nullptr.
public inline const FGuid * GetHostPlayerUuidOrNull() const
Returns a pointer to HostPlayerUuid_Optional, if it has been set, otherwise returns nullptr.
public inline void SetHostPlayerUuid(FGuid NewValue)
Sets the value of HostPlayerUuid_Optional and also sets HostPlayerUuid_IsSet to true.
public inline void ClearHostPlayerUuid()
Clears the value of HostPlayerUuid_Optional and sets HostPlayerUuid_IsSet to false.