Skip to main content

RHAPI_SessionTeam

Summary​

MembersDescriptions
struct FRHAPI_SessionTeamA team of SessionPlayers in a session.

struct FRHAPI_SessionTeam ​

struct FRHAPI_SessionTeam
  : public FRHAPI_Model

A team of SessionPlayers in a session.

Summary​

MembersDescriptions
public TArray< FRHAPI_SessionPlayer>PlayersPlayers currently on this team.
public int32 MaxSizeMaximum number of players allowed on this team.
public int32 TeamId_OptionalWhich team this is.
public bool TeamId_IsSettrue if TeamId_Optional has been set to a value
public TArray< FString > TicketIds_OptionalMatchmaking tickets that were assigned to this team.
public bool TicketIds_IsSettrue if TicketIds_Optional has been set to a value
public TMap< FString, FString > CustomData_OptionalCustom data about this team.
public bool CustomData_IsSettrue if CustomData_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 TArray< FRHAPI_SessionPlayer> &GetPlayers()Gets the value of Players.
public inline const TArray< FRHAPI_SessionPlayer> &GetPlayers() constGets the value of Players.
public inline void SetPlayers(const TArray< FRHAPI_SessionPlayer > & NewValue)Sets the value of Players.
public inline void SetPlayers(TArray< FRHAPI_SessionPlayer > && NewValue)Sets the value of Players using move semantics.
public inline int32 & GetMaxSize()Gets the value of MaxSize.
public inline const int32 & GetMaxSize() constGets the value of MaxSize.
public inline void SetMaxSize(const int32 & NewValue)Sets the value of MaxSize.
public inline void SetMaxSize(int32 && NewValue)Sets the value of MaxSize using move semantics.
public inline bool IsMaxSizeDefaultValue() constReturns true if MaxSize matches the default value.
public inline void SetMaxSizeToDefault()Sets the value of MaxSize to its default
public inline int32 & GetTeamId()Gets the value of TeamId_Optional, regardless of it having been set.
public inline const int32 & GetTeamId() constGets the value of TeamId_Optional, regardless of it having been set.
public inline const int32 & GetTeamId(const int32 & DefaultValue) constGets the value of TeamId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetTeamId(int32 & OutValue) constFills OutValue with the value of TeamId_Optional and returns true if it has been set, otherwise returns false.
public inline int32 * GetTeamIdOrNull()Returns a pointer to TeamId_Optional, if it has been set, otherwise returns nullptr.
public inline const int32 * GetTeamIdOrNull() constReturns a pointer to TeamId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetTeamId(const int32 & NewValue)Sets the value of TeamId_Optional and also sets TeamId_IsSet to true.
public inline void SetTeamId(int32 && NewValue)Sets the value of TeamId_Optional and also sets TeamId_IsSet to true using move semantics.
public inline void ClearTeamId()Clears the value of TeamId_Optional and sets TeamId_IsSet to false.
public inline bool IsTeamIdSet() constChecks whether TeamId_Optional has been set.
public inline bool IsTeamIdDefaultValue() constReturns true if TeamId_Optional is set and matches the default value.
public inline void SetTeamIdToDefault()Sets the value of TeamId_Optional to its default and also sets TeamId_IsSet to true.
public inline TArray< FString > & GetTicketIds()Gets the value of TicketIds_Optional, regardless of it having been set.
public inline const TArray< FString > & GetTicketIds() constGets the value of TicketIds_Optional, regardless of it having been set.
public inline const TArray< FString > & GetTicketIds(const TArray< FString > & DefaultValue) constGets the value of TicketIds_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetTicketIds(TArray< FString > & OutValue) constFills 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() constReturns a pointer to TicketIds_Optional, if it has been set, otherwise returns nullptr.
public inline void SetTicketIds(const TArray< FString > & NewValue)Sets the value of TicketIds_Optional and also sets TicketIds_IsSet to true.
public inline void SetTicketIds(TArray< FString > && NewValue)Sets the value of TicketIds_Optional and also sets TicketIds_IsSet to true using move semantics.
public inline void ClearTicketIds()Clears the value of TicketIds_Optional and sets TicketIds_IsSet to false.
public inline bool IsTicketIdsSet() constChecks whether TicketIds_Optional has been set.
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() constGets the value of CustomData_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetCustomData(const TMap< FString, FString > & DefaultValue) constGets the value of CustomData_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetCustomData(TMap< FString, FString > & OutValue) constFills 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() constReturns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
public inline void SetCustomData(const TMap< FString, FString > & NewValue)Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.
public inline void SetCustomData(TMap< FString, FString > && NewValue)Sets the value of CustomData_Optional and also sets CustomData_IsSet to true using move semantics.
public inline void ClearCustomData()Clears the value of CustomData_Optional and sets CustomData_IsSet to false.
public inline bool IsCustomDataSet() constChecks whether CustomData_Optional has been set.

Members​

public TArray< FRHAPI_SessionPlayer>Players ​

Players currently on this team.

public int32 MaxSize ​

Maximum number of players allowed on this team.

public int32 TeamId_Optional ​

Which team this is.

public bool TeamId_IsSet ​

true if TeamId_Optional has been set to a value

public TArray< FString > TicketIds_Optional ​

Matchmaking tickets that were assigned to this team.

public bool TicketIds_IsSet ​

true if TicketIds_Optional has been set to a value

public TMap< FString, FString > CustomData_Optional ​

Custom data about this team.

public bool CustomData_IsSet ​

true if CustomData_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 TArray< FRHAPI_SessionPlayer> &GetPlayers() ​

Gets the value of Players.

public inline const TArray< FRHAPI_SessionPlayer> &GetPlayers() const ​

Gets the value of Players.

public inline void SetPlayers(const TArray< FRHAPI_SessionPlayer > & NewValue) ​

Sets the value of Players.

public inline void SetPlayers(TArray< FRHAPI_SessionPlayer > && NewValue) ​

Sets the value of Players using move semantics.

public inline int32 & GetMaxSize() ​

Gets the value of MaxSize.

public inline const int32 & GetMaxSize() const ​

Gets the value of MaxSize.

public inline void SetMaxSize(const int32 & NewValue) ​

Sets the value of MaxSize.

public inline void SetMaxSize(int32 && NewValue) ​

Sets the value of MaxSize using move semantics.

public inline bool IsMaxSizeDefaultValue() const ​

Returns true if MaxSize matches the default value.

public inline void SetMaxSizeToDefault() ​

Sets the value of MaxSize to its default

public inline int32 & GetTeamId() ​

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

public inline const int32 & GetTeamId() const ​

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

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

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

public inline bool GetTeamId(int32 & OutValue) const ​

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

public inline int32 * GetTeamIdOrNull() ​

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

public inline const int32 * GetTeamIdOrNull() const ​

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

public inline void SetTeamId(const int32 & NewValue) ​

Sets the value of TeamId_Optional and also sets TeamId_IsSet to true.

public inline void SetTeamId(int32 && NewValue) ​

Sets the value of TeamId_Optional and also sets TeamId_IsSet to true using move semantics.

public inline void ClearTeamId() ​

Clears the value of TeamId_Optional and sets TeamId_IsSet to false.

public inline bool IsTeamIdSet() const ​

Checks whether TeamId_Optional has been set.

public inline bool IsTeamIdDefaultValue() const ​

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

public inline void SetTeamIdToDefault() ​

Sets the value of TeamId_Optional to its default and also sets TeamId_IsSet to true.

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

Sets the value of TicketIds_Optional and also sets TicketIds_IsSet to true.

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

Sets the value of TicketIds_Optional and also sets TicketIds_IsSet to true using move semantics.

public inline void ClearTicketIds() ​

Clears the value of TicketIds_Optional and sets TicketIds_IsSet to false.

public inline bool IsTicketIdsSet() const ​

Checks whether TicketIds_Optional has been set.

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(const TMap< FString, FString > & NewValue) ​

Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.

public inline void SetCustomData(TMap< FString, FString > && NewValue) ​

Sets the value of CustomData_Optional and also sets CustomData_IsSet to true using move semantics.

public inline void ClearCustomData() ​

Clears the value of CustomData_Optional and sets CustomData_IsSet to false.

public inline bool IsCustomDataSet() const ​

Checks whether CustomData_Optional has been set.