RHAPI_BrowserResponse
Summary
Members | Descriptions |
---|---|
struct FRHAPI_BrowserResponse | A response with a list of browsers, and a cursor to continue iterating through them. |
struct FRHAPI_BrowserResponse
A response with a list of browsers, and a cursor to continue iterating through them.
Summary
Members | Descriptions |
---|---|
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. |
public virtual void WriteJson (TSharedRef< TJsonWriter<>> & Writer) const | Writes 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 () 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. |
Members
public int32
Cursor
Cursor to continue iterating through browser sessions. 0 means we have returned the last entry.
#### `public TArray< `[`FRHAPI_BrowserSessionInfo`](RHAPI_BrowserSessionInfo.md#structFRHAPI__BrowserSessionInfo)` > `[`BrowserSessions`](#structFRHAPI__BrowserResponse_1aafc07faff636c79639a50b2ce433df50)
List of sessions in the browser.
#### `public virtual bool `[`FromJson`](#structFRHAPI__BrowserResponse_1a5a7d148abc6f5aca654cb7f919593b9d)`(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`](#structFRHAPI__BrowserResponse_1a1578a60cc2cd3e1582c740c12637d7de)`(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`](#structFRHAPI__BrowserResponse_1a8ad3e83c0a8c660df736de1159e87f6e)`()`
Gets the value of Cursor.
#### `public inline const int32 & `[`GetCursor`](#structFRHAPI__BrowserResponse_1aa403e7276640e8bbf9f422b0732a7a09)`() const`
Gets the value of Cursor.
#### `public inline void `[`SetCursor`](#structFRHAPI__BrowserResponse_1a0e2449b5afb839c6c91f4d3c2ed250b3)`(int32 NewValue)`
Sets the value of Cursor.
#### `public inline bool `[`IsCursorDefaultValue`](#structFRHAPI__BrowserResponse_1a078a72d3883533671f1c6ad61c482d92)`() const`
Returns true if Cursor matches the default value.
#### `public inline void `[`SetCursorToDefault`](#structFRHAPI__BrowserResponse_1ac4037928781c1aff4d935a96804034a5)`()`
Sets the value of Cursor to its default
#### `public inline TArray< `[`FRHAPI_BrowserSessionInfo`](RHAPI_BrowserSessionInfo.md#structFRHAPI__BrowserSessionInfo)` > & `[`GetBrowserSessions`](#structFRHAPI__BrowserResponse_1ac9e9401ab7e01aae2ec52c8b659397e3)`()`
Gets the value of BrowserSessions.
#### `public inline const TArray< `[`FRHAPI_BrowserSessionInfo`](RHAPI_BrowserSessionInfo.md#structFRHAPI__BrowserSessionInfo)` > & `[`GetBrowserSessions`](#structFRHAPI__BrowserResponse_1a0773c81ab098d690680418a8073a9d01)`() const`
Gets the value of BrowserSessions.
#### `public inline void `[`SetBrowserSessions`](#structFRHAPI__BrowserResponse_1a1569ecc727e6360c7c126f2ab6007a8a)`(TArray< `[`FRHAPI_BrowserSessionInfo`](RHAPI_BrowserSessionInfo.md#structFRHAPI__BrowserSessionInfo)` > NewValue)`
Sets the value of BrowserSessions.