Skip to main content

RHAPI_PagedPlayersResponse

Summary​

MembersDescriptions
struct FRHAPI_PagedPlayersResponse

struct FRHAPI_PagedPlayersResponse ​

struct FRHAPI_PagedPlayersResponse
  : public FRHAPI_Model

Summary​

MembersDescriptions
public TArray< FRHAPI_SessionTeam>Teams_OptionalList of returned teams and players. Player list in the teams may be incomplete.
public bool Teams_IsSettrue if Teams_Optional has been set to a value
public int32 CursorCursor to continue iterating through players in a session. 0 means we have returned the last entry.
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_SessionTeam> &GetTeams()Gets the value of Teams_Optional, regardless of it having been set.
public inline const TArray< FRHAPI_SessionTeam> &GetTeams() constGets the value of Teams_Optional, regardless of it having been set.
public inline const TArray< FRHAPI_SessionTeam> &GetTeams(const TArray< FRHAPI_SessionTeam > & DefaultValue) constGets the value of Teams_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetTeams(TArray< FRHAPI_SessionTeam > & OutValue) constFills OutValue with the value of Teams_Optional and returns true if it has been set, otherwise returns false.
public inline TArray< FRHAPI_SessionTeam> *GetTeamsOrNull()Returns a pointer to Teams_Optional, if it has been set, otherwise returns nullptr.
public inline const TArray< FRHAPI_SessionTeam> *GetTeamsOrNull() constReturns a pointer to Teams_Optional, if it has been set, otherwise returns nullptr.
public inline void SetTeams(const TArray< FRHAPI_SessionTeam > & NewValue)Sets the value of Teams_Optional and also sets Teams_IsSet to true.
public inline void SetTeams(TArray< FRHAPI_SessionTeam > && NewValue)Sets the value of Teams_Optional and also sets Teams_IsSet to true using move semantics.
public inline void ClearTeams()Clears the value of Teams_Optional and sets Teams_IsSet to false.
public inline bool IsTeamsSet() constChecks whether Teams_Optional has been set.
public inline int32 & GetCursor()Gets the value of Cursor.
public inline const int32 & GetCursor() constGets the value of Cursor.
public inline void SetCursor(const int32 & NewValue)Sets the value of Cursor.
public inline void SetCursor(int32 && NewValue)Sets the value of Cursor using move semantics.
public inline bool IsCursorDefaultValue() constReturns true if Cursor matches the default value.
public inline void SetCursorToDefault()Sets the value of Cursor to its default

Members​

public TArray< FRHAPI_SessionTeam>Teams_Optional ​

List of returned teams and players. Player list in the teams may be incomplete.

public bool Teams_IsSet ​

true if Teams_Optional has been set to a value

public int32 Cursor ​

Cursor to continue iterating through players in a session. 0 means we have returned the last entry.

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_SessionTeam> &GetTeams() ​

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

public inline const TArray< FRHAPI_SessionTeam> &GetTeams() const ​

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

public inline const TArray< FRHAPI_SessionTeam> &GetTeams(const TArray< FRHAPI_SessionTeam > & DefaultValue) const ​

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

public inline bool GetTeams(TArray< FRHAPI_SessionTeam > & OutValue) const ​

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

public inline TArray< FRHAPI_SessionTeam> *GetTeamsOrNull() ​

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

public inline const TArray< FRHAPI_SessionTeam> *GetTeamsOrNull() const ​

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

public inline void SetTeams(const TArray< FRHAPI_SessionTeam > & NewValue) ​

Sets the value of Teams_Optional and also sets Teams_IsSet to true.

public inline void SetTeams(TArray< FRHAPI_SessionTeam > && NewValue) ​

Sets the value of Teams_Optional and also sets Teams_IsSet to true using move semantics.

public inline void ClearTeams() ​

Clears the value of Teams_Optional and sets Teams_IsSet to false.

public inline bool IsTeamsSet() const ​

Checks whether Teams_Optional has been set.

public inline int32 & GetCursor() ​

Gets the value of Cursor.

public inline const int32 & GetCursor() const ​

Gets the value of Cursor.

public inline void SetCursor(const int32 & NewValue) ​

Sets the value of Cursor.

public inline void SetCursor(int32 && NewValue) ​

Sets the value of Cursor using move semantics.

public inline bool IsCursorDefaultValue() const ​

Returns true if Cursor matches the default value.

public inline void SetCursorToDefault() ​

Sets the value of Cursor to its default