Skip to content

RHAPI_BrowserResponse

Summary

MembersDescriptions
struct FRHAPI_BrowserResponseA response with a list of browsers, and a cursor to continue iterating through them.

struct FRHAPI_BrowserResponse

struct FRHAPI_BrowserResponse
: public FRHAPI_Model

A response with a list of browsers, and a cursor to continue iterating through them.

Summary

MembersDescriptions
public int32 CursorCursor to continue iterating through browser sessions. 0 means we have returned the last entry.
public TArray< FRHAPI_BrowserSessionInfo>BrowserSessionsList of sessions in the browser.
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 int32 & GetCursor()Gets the value of Cursor.
public inline const int32 & GetCursor() constGets the value of Cursor.
public inline void SetCursor(int32 NewValue)Sets the value of Cursor.
public inline bool IsCursorDefaultValue() constReturns true if Cursor matches the default value.
public inline void SetCursorToDefault()Sets the value of Cursor to its default
public inline TArray< FRHAPI_BrowserSessionInfo> &GetBrowserSessions()Gets the value of BrowserSessions.
public inline const TArray< FRHAPI_BrowserSessionInfo> &GetBrowserSessions() constGets the value of BrowserSessions.
public inline void SetBrowserSessions(TArray< FRHAPI_BrowserSessionInfo > NewValue)Sets the value of BrowserSessions.

Members

public int32 Cursor

Cursor to continue iterating through browser sessions. 0 means we have returned the last entry.

public TArray< FRHAPI_BrowserSessionInfo>BrowserSessions

List of sessions in the browser.

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 int32 & GetCursor()

Gets the value of Cursor.

public inline const int32 & GetCursor() const

Gets the value of Cursor.

public inline void SetCursor(int32 NewValue)

Sets the value of Cursor.

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

public inline TArray< FRHAPI_BrowserSessionInfo> &GetBrowserSessions()

Gets the value of BrowserSessions.

public inline const TArray< FRHAPI_BrowserSessionInfo> &GetBrowserSessions() const

Gets the value of BrowserSessions.

public inline void SetBrowserSessions(TArray< FRHAPI_BrowserSessionInfo > NewValue)

Sets the value of BrowserSessions.