RHAPI_PlayerIterateResponse

Summary

Members	Descriptions
struct FRHAPI_PlayerIterateResponse	Response from the player iteration API.

struct FRHAPI_PlayerIterateResponse

struct FRHAPI_PlayerIterateResponse
  : public FRHAPI_Model

Response from the player iteration API.

Summary

Members	Descriptions
public TArray< FRHAPI_PlayerResponse>Players_Optional	List of players. An empty list means iteration is complete.
public bool Players_IsSet	true if Players_Optional has been set to a value
public FString Cursor_Optional	Cursor to continue iteration.
public bool Cursor_IsSet	true if Cursor_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_PlayerResponse> &GetPlayers()	Gets the value of Players_Optional, regardless of it having been set.
public inline const TArray< FRHAPI_PlayerResponse> &GetPlayers() const	Gets the value of Players_Optional, regardless of it having been set.
public inline const TArray< FRHAPI_PlayerResponse> &GetPlayers(const TArray< FRHAPI_PlayerResponse > & DefaultValue) const	Gets the value of Players_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetPlayers(TArray< FRHAPI_PlayerResponse > & OutValue) const	Fills OutValue with the value of Players_Optional and returns true if it has been set, otherwise returns false.
public inline TArray< FRHAPI_PlayerResponse> *GetPlayersOrNull()	Returns a pointer to Players_Optional, if it has been set, otherwise returns nullptr.
public inline const TArray< FRHAPI_PlayerResponse> *GetPlayersOrNull() const	Returns a pointer to Players_Optional, if it has been set, otherwise returns nullptr.
public inline void SetPlayers(TArray< FRHAPI_PlayerResponse > NewValue)	Sets the value of Players_Optional and also sets Players_IsSet to true.
public inline void ClearPlayers()	Clears the value of Players_Optional and sets Players_IsSet to false.
public inline FString & GetCursor()	Gets the value of Cursor_Optional, regardless of it having been set.
public inline const FString & GetCursor() const	Gets the value of Cursor_Optional, regardless of it having been set.
public inline const FString & GetCursor(const FString & DefaultValue) const	Gets the value of Cursor_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetCursor(FString & OutValue) const	Fills OutValue with the value of Cursor_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetCursorOrNull()	Returns a pointer to Cursor_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetCursorOrNull() const	Returns a pointer to Cursor_Optional, if it has been set, otherwise returns nullptr.
public inline void SetCursor(FString NewValue)	Sets the value of Cursor_Optional and also sets Cursor_IsSet to true.
public inline void ClearCursor()	Clears the value of Cursor_Optional and sets Cursor_IsSet to false.
public inline bool IsCursorDefaultValue() const	Returns true if Cursor_Optional is set and matches the default value.
public inline void SetCursorToDefault()	Sets the value of Cursor_Optional to its default and also sets Cursor_IsSet to true.

Members

public TArray< FRHAPI_PlayerResponse>Players_Optional

List of players. An empty list means iteration is complete.

public bool Players_IsSet

true if Players_Optional has been set to a value

public FString Cursor_Optional

Cursor to continue iteration.

public bool Cursor_IsSet

true if Cursor_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_PlayerResponse> &GetPlayers()

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

public inline const TArray< FRHAPI_PlayerResponse> &GetPlayers() const

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

public inline const TArray< FRHAPI_PlayerResponse> &GetPlayers(const TArray< FRHAPI_PlayerResponse > & DefaultValue) const

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

public inline bool GetPlayers(TArray< FRHAPI_PlayerResponse > & OutValue) const

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

public inline TArray< FRHAPI_PlayerResponse> *GetPlayersOrNull()

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

public inline const TArray< FRHAPI_PlayerResponse> *GetPlayersOrNull() const

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

public inline void SetPlayers(TArray< FRHAPI_PlayerResponse > NewValue)

Sets the value of Players_Optional and also sets Players_IsSet to true.

public inline void ClearPlayers()

Clears the value of Players_Optional and sets Players_IsSet to false.

public inline FString & GetCursor()

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

public inline const FString & GetCursor() const

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

public inline const FString & GetCursor(const FString & DefaultValue) const

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

public inline bool GetCursor(FString & OutValue) const

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

public inline FString * GetCursorOrNull()

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

public inline const FString * GetCursorOrNull() const

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

public inline void SetCursor(FString NewValue)

Sets the value of Cursor_Optional and also sets Cursor_IsSet to true.

public inline void ClearCursor()

Clears the value of Cursor_Optional and sets Cursor_IsSet to false.

public inline bool IsCursorDefaultValue() const

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

public inline void SetCursorToDefault()

Sets the value of Cursor_Optional to its default and also sets Cursor_IsSet to true.