Skip to main content

RHAPI_RegionsResponse

Summary​

MembersDescriptions
struct FRHAPI_RegionsResponseA list of regions and a cursor to continue iterating.

struct FRHAPI_RegionsResponse ​

struct FRHAPI_RegionsResponse
  : public FRHAPI_Model

A list of regions and a cursor to continue iterating.

Summary​

MembersDescriptions
public TArray< FRHAPI_Region>RegionsList of all regions.
public int32 CursorCursor to continue iterating through enabled regions. Non 0 cursor in the response means there are more regions. Pass the returned cursor up on a subsequent call to continue. A 0 cursor in the response means you have reached the end.
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_Region> &GetRegions()Gets the value of Regions.
public inline const TArray< FRHAPI_Region> &GetRegions() constGets the value of Regions.
public inline void SetRegions(const TArray< FRHAPI_Region > & NewValue)Sets the value of Regions.
public inline void SetRegions(TArray< FRHAPI_Region > && NewValue)Sets the value of Regions using move semantics.
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_Region>Regions ​

List of all regions.

public int32 Cursor ​

Cursor to continue iterating through enabled regions. Non 0 cursor in the response means there are more regions. Pass the returned cursor up on a subsequent call to continue. A 0 cursor in the response means you have reached the end.

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_Region> &GetRegions() ​

Gets the value of Regions.

public inline const TArray< FRHAPI_Region> &GetRegions() const ​

Gets the value of Regions.

public inline void SetRegions(const TArray< FRHAPI_Region > & NewValue) ​

Sets the value of Regions.

public inline void SetRegions(TArray< FRHAPI_Region > && NewValue) ​

Sets the value of Regions using move semantics.

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