Skip to main content

RHAPI_BrowserInfo

Summary​

MembersDescriptions
struct FRHAPI_BrowserInfoInformation about the browser resource in a session.

struct FRHAPI_BrowserInfo ​

struct FRHAPI_BrowserInfo
  : public FRHAPI_Model

Information about the browser resource in a session.

Summary​

MembersDescriptions
public TMap< FString, FString > CustomData_OptionalCustom data with the listing of the instance in the Session browser.
public bool CustomData_IsSettrue if CustomData_Optional has been set to a value
public FDateTime CreatedTimestamp_OptionalDatetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.
public bool CreatedTimestamp_IsSettrue if CreatedTimestamp_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) constWrites the data from this object into the specified JSON Writer stream.
public inline TMap< FString, FString > & GetCustomData()Gets the value of CustomData_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetCustomData() constGets the value of CustomData_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetCustomData(const TMap< FString, FString > & DefaultValue) constGets the value of CustomData_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetCustomData(TMap< FString, FString > & OutValue) constFills OutValue with the value of CustomData_Optional and returns true if it has been set, otherwise returns false.
public inline TMap< FString, FString > * GetCustomDataOrNull()Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
public inline const TMap< FString, FString > * GetCustomDataOrNull() constReturns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
public inline void SetCustomData(const TMap< FString, FString > & NewValue)Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.
public inline void SetCustomData(TMap< FString, FString > && NewValue)Sets the value of CustomData_Optional and also sets CustomData_IsSet to true using move semantics.
public inline void ClearCustomData()Clears the value of CustomData_Optional and sets CustomData_IsSet to false.
public inline bool IsCustomDataSet() constChecks whether CustomData_Optional has been set.
public inline FDateTime & GetCreatedTimestamp()Gets the value of CreatedTimestamp_Optional, regardless of it having been set.
public inline const FDateTime & GetCreatedTimestamp() constGets the value of CreatedTimestamp_Optional, regardless of it having been set.
public inline const FDateTime & GetCreatedTimestamp(const FDateTime & DefaultValue) constGets the value of CreatedTimestamp_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetCreatedTimestamp(FDateTime & OutValue) constFills OutValue with the value of CreatedTimestamp_Optional and returns true if it has been set, otherwise returns false.
public inline FDateTime * GetCreatedTimestampOrNull()Returns a pointer to CreatedTimestamp_Optional, if it has been set, otherwise returns nullptr.
public inline const FDateTime * GetCreatedTimestampOrNull() constReturns a pointer to CreatedTimestamp_Optional, if it has been set, otherwise returns nullptr.
public inline void SetCreatedTimestamp(const FDateTime & NewValue)Sets the value of CreatedTimestamp_Optional and also sets CreatedTimestamp_IsSet to true.
public inline void SetCreatedTimestamp(FDateTime && NewValue)Sets the value of CreatedTimestamp_Optional and also sets CreatedTimestamp_IsSet to true using move semantics.
public inline void ClearCreatedTimestamp()Clears the value of CreatedTimestamp_Optional and sets CreatedTimestamp_IsSet to false.
public inline bool IsCreatedTimestampSet() constChecks whether CreatedTimestamp_Optional has been set.

Members​

public TMap< FString, FString > CustomData_Optional ​

Custom data with the listing of the instance in the Session browser.

public bool CustomData_IsSet ​

true if CustomData_Optional has been set to a value

public FDateTime CreatedTimestamp_Optional ​

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.

public bool CreatedTimestamp_IsSet ​

true if CreatedTimestamp_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 TMap< FString, FString > & GetCustomData() ​

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

public inline const TMap< FString, FString > & GetCustomData() const ​

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

public inline const TMap< FString, FString > & GetCustomData(const TMap< FString, FString > & DefaultValue) const ​

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

public inline bool GetCustomData(TMap< FString, FString > & OutValue) const ​

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

public inline TMap< FString, FString > * GetCustomDataOrNull() ​

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

public inline const TMap< FString, FString > * GetCustomDataOrNull() const ​

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

public inline void SetCustomData(const TMap< FString, FString > & NewValue) ​

Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.

public inline void SetCustomData(TMap< FString, FString > && NewValue) ​

Sets the value of CustomData_Optional and also sets CustomData_IsSet to true using move semantics.

public inline void ClearCustomData() ​

Clears the value of CustomData_Optional and sets CustomData_IsSet to false.

public inline bool IsCustomDataSet() const ​

Checks whether CustomData_Optional has been set.

public inline FDateTime & GetCreatedTimestamp() ​

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

public inline const FDateTime & GetCreatedTimestamp() const ​

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

public inline const FDateTime & GetCreatedTimestamp(const FDateTime & DefaultValue) const ​

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

public inline bool GetCreatedTimestamp(FDateTime & OutValue) const ​

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

public inline FDateTime * GetCreatedTimestampOrNull() ​

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

public inline const FDateTime * GetCreatedTimestampOrNull() const ​

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

public inline void SetCreatedTimestamp(const FDateTime & NewValue) ​

Sets the value of CreatedTimestamp_Optional and also sets CreatedTimestamp_IsSet to true.

public inline void SetCreatedTimestamp(FDateTime && NewValue) ​

Sets the value of CreatedTimestamp_Optional and also sets CreatedTimestamp_IsSet to true using move semantics.

public inline void ClearCreatedTimestamp() ​

Clears the value of CreatedTimestamp_Optional and sets CreatedTimestamp_IsSet to false.

public inline bool IsCreatedTimestampSet() const ​

Checks whether CreatedTimestamp_Optional has been set.