Skip to content
RallyHere Docs
GitHub

RHAPI_DiscoveryResponse

Summary

MembersDescriptions
struct FRHAPI_DiscoveryResponseContains information that aids the client in communicating with the connection managers.

struct FRHAPI_DiscoveryResponse

struct FRHAPI_DiscoveryResponse
  : public FRHAPI_Model

Contains information that aids the client in communicating with the connection managers.

Summary

MembersDescriptions
public TArray< FString > AddressesThe list of addresses for the connection managers.
public FString ServerStatus_OptionalThe status of the connection managers.
public bool ServerStatus_IsSettrue if ServerStatus_Optional has been set to a value
public FString CommandLineArgs_OptionalThe command line arguments used to be used by the client.
public bool CommandLineArgs_IsSettrue if CommandLineArgs_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 TArray< FString > & GetAddresses()Gets the value of Addresses.
public inline const TArray< FString > & GetAddresses() constGets the value of Addresses.
public inline void SetAddresses(TArray< FString > NewValue)Sets the value of Addresses.
public inline FString & GetServerStatus()Gets the value of ServerStatus_Optional, regardless of it having been set.
public inline const FString & GetServerStatus() constGets the value of ServerStatus_Optional, regardless of it having been set.
public inline const FString & GetServerStatus(const FString & DefaultValue) constGets the value of ServerStatus_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetServerStatus(FString & OutValue) constFills OutValue with the value of ServerStatus_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetServerStatusOrNull()Returns a pointer to ServerStatus_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetServerStatusOrNull() constReturns a pointer to ServerStatus_Optional, if it has been set, otherwise returns nullptr.
public inline void SetServerStatus(FString NewValue)Sets the value of ServerStatus_Optional and also sets ServerStatus_IsSet to true.
public inline void ClearServerStatus()Clears the value of ServerStatus_Optional and sets ServerStatus_IsSet to false.
public inline bool IsServerStatusDefaultValue() constReturns true if ServerStatus_Optional is set and matches the default value.
public inline void SetServerStatusToDefault()Sets the value of ServerStatus_Optional to its default and also sets ServerStatus_IsSet to true.
public inline FString & GetCommandLineArgs()Gets the value of CommandLineArgs_Optional, regardless of it having been set.
public inline const FString & GetCommandLineArgs() constGets the value of CommandLineArgs_Optional, regardless of it having been set.
public inline const FString & GetCommandLineArgs(const FString & DefaultValue) constGets the value of CommandLineArgs_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetCommandLineArgs(FString & OutValue) constFills OutValue with the value of CommandLineArgs_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetCommandLineArgsOrNull()Returns a pointer to CommandLineArgs_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetCommandLineArgsOrNull() constReturns a pointer to CommandLineArgs_Optional, if it has been set, otherwise returns nullptr.
public inline void SetCommandLineArgs(FString NewValue)Sets the value of CommandLineArgs_Optional and also sets CommandLineArgs_IsSet to true.
public inline void ClearCommandLineArgs()Clears the value of CommandLineArgs_Optional and sets CommandLineArgs_IsSet to false.
public inline bool IsCommandLineArgsDefaultValue() constReturns true if CommandLineArgs_Optional is set and matches the default value.
public inline void SetCommandLineArgsToDefault()Sets the value of CommandLineArgs_Optional to its default and also sets CommandLineArgs_IsSet to true.

Members

public TArray< FString > Addresses

The list of addresses for the connection managers.

public FString ServerStatus_Optional

The status of the connection managers.

public bool ServerStatus_IsSet

true if ServerStatus_Optional has been set to a value

public FString CommandLineArgs_Optional

The command line arguments used to be used by the client.

public bool CommandLineArgs_IsSet

true if CommandLineArgs_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< FString > & GetAddresses()

Gets the value of Addresses.

public inline const TArray< FString > & GetAddresses() const

Gets the value of Addresses.

public inline void SetAddresses(TArray< FString > NewValue)

Sets the value of Addresses.

public inline FString & GetServerStatus()

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

public inline const FString & GetServerStatus() const

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

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

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

public inline bool GetServerStatus(FString & OutValue) const

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

public inline FString * GetServerStatusOrNull()

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

public inline const FString * GetServerStatusOrNull() const

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

public inline void SetServerStatus(FString NewValue)

Sets the value of ServerStatus_Optional and also sets ServerStatus_IsSet to true.

public inline void ClearServerStatus()

Clears the value of ServerStatus_Optional and sets ServerStatus_IsSet to false.

public inline bool IsServerStatusDefaultValue() const

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

public inline void SetServerStatusToDefault()

Sets the value of ServerStatus_Optional to its default and also sets ServerStatus_IsSet to true.

public inline FString & GetCommandLineArgs()

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

public inline const FString & GetCommandLineArgs() const

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

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

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

public inline bool GetCommandLineArgs(FString & OutValue) const

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

public inline FString * GetCommandLineArgsOrNull()

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

public inline const FString * GetCommandLineArgsOrNull() const

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

public inline void SetCommandLineArgs(FString NewValue)

Sets the value of CommandLineArgs_Optional and also sets CommandLineArgs_IsSet to true.

public inline void ClearCommandLineArgs()

Clears the value of CommandLineArgs_Optional and sets CommandLineArgs_IsSet to false.

public inline bool IsCommandLineArgsDefaultValue() const

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

public inline void SetCommandLineArgsToDefault()

Sets the value of CommandLineArgs_Optional to its default and also sets CommandLineArgs_IsSet to true.