Skip to main content

RHAPI_MatchInstance

Summary​

MembersDescriptions
struct FRHAPI_MatchInstance

struct FRHAPI_MatchInstance ​

struct FRHAPI_MatchInstance
  : public FRHAPI_Model

Summary​

MembersDescriptions
public FString InstanceIdInstance ID.
public FGuid HostPlayerUuid_Optional
public bool HostPlayerUuid_IsSettrue if HostPlayerUuid_Optional has been set to a value
public bool HostPlayerUuid_IsNulltrue if HostPlayerUuid_Optional has been explicitly set to null
public FString RegionId_Optional
public bool RegionId_IsSettrue if RegionId_Optional has been set to a value
public bool RegionId_IsNulltrue if RegionId_Optional has been explicitly set to null
public FString InstanceRequestTemplateId_Optional
public bool InstanceRequestTemplateId_IsSettrue if InstanceRequestTemplateId_Optional has been set to a value
public bool InstanceRequestTemplateId_IsNulltrue if InstanceRequestTemplateId_Optional has been explicitly set to null
public FString Map_Optional
public bool Map_IsSettrue if Map_Optional has been set to a value
public bool Map_IsNulltrue if Map_Optional has been explicitly set to null
public FString GameMode_Optional
public bool GameMode_IsSettrue if GameMode_Optional has been set to a value
public bool GameMode_IsNulltrue if GameMode_Optional has been explicitly set to null
public ERHAPI_MatchHostType HostType_Optional
public bool HostType_IsSettrue if HostType_Optional has been set to a value
public bool HostType_IsNulltrue if HostType_Optional has been explicitly set to null
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 FString & GetInstanceId()Gets the value of InstanceId.
public inline const FString & GetInstanceId() constGets the value of InstanceId.
public inline void SetInstanceId(const FString & NewValue)Sets the value of InstanceId.
public inline void SetInstanceId(FString && NewValue)Sets the value of InstanceId using move semantics.
public inline FGuid & GetHostPlayerUuid()Gets the value of HostPlayerUuid_Optional, regardless of it having been set.
public inline const FGuid & GetHostPlayerUuid() constGets the value of HostPlayerUuid_Optional, regardless of it having been set.
public inline const FGuid & GetHostPlayerUuid(const FGuid & DefaultValue) constGets the value of HostPlayerUuid_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetHostPlayerUuid(FGuid & OutValue) constFills OutValue with the value of HostPlayerUuid_Optional and returns true if it has been set, otherwise returns false.
public inline FGuid * GetHostPlayerUuidOrNull()Returns a pointer to HostPlayerUuid_Optional, if it has been set, otherwise returns nullptr.
public inline const FGuid * GetHostPlayerUuidOrNull() constReturns a pointer to HostPlayerUuid_Optional, if it has been set, otherwise returns nullptr.
public inline void SetHostPlayerUuid(const FGuid & NewValue)Sets the value of HostPlayerUuid_Optional and also sets HostPlayerUuid_IsSet to true.
public inline void SetHostPlayerUuid(FGuid && NewValue)Sets the value of HostPlayerUuid_Optional and also sets HostPlayerUuid_IsSet to true using move semantics.
public inline void ClearHostPlayerUuid()Clears the value of HostPlayerUuid_Optional and sets HostPlayerUuid_IsSet to false.
public inline bool IsHostPlayerUuidSet() constChecks whether HostPlayerUuid_Optional has been set.
public inline void SetHostPlayerUuidToNull()Sets the value explicitly to be treated as null.
public inline bool IsHostPlayerUuidNull() constChecks whether HostPlayerUuid_Optional is set to null.
public inline FString & GetRegionId()Gets the value of RegionId_Optional, regardless of it having been set.
public inline const FString & GetRegionId() constGets the value of RegionId_Optional, regardless of it having been set.
public inline const FString & GetRegionId(const FString & DefaultValue) constGets the value of RegionId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetRegionId(FString & OutValue) constFills OutValue with the value of RegionId_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetRegionIdOrNull()Returns a pointer to RegionId_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetRegionIdOrNull() constReturns a pointer to RegionId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetRegionId(const FString & NewValue)Sets the value of RegionId_Optional and also sets RegionId_IsSet to true.
public inline void SetRegionId(FString && NewValue)Sets the value of RegionId_Optional and also sets RegionId_IsSet to true using move semantics.
public inline void ClearRegionId()Clears the value of RegionId_Optional and sets RegionId_IsSet to false.
public inline bool IsRegionIdSet() constChecks whether RegionId_Optional has been set.
public inline void SetRegionIdToNull()Sets the value explicitly to be treated as null.
public inline bool IsRegionIdNull() constChecks whether RegionId_Optional is set to null.
public inline FString & GetInstanceRequestTemplateId()Gets the value of InstanceRequestTemplateId_Optional, regardless of it having been set.
public inline const FString & GetInstanceRequestTemplateId() constGets the value of InstanceRequestTemplateId_Optional, regardless of it having been set.
public inline const FString & GetInstanceRequestTemplateId(const FString & DefaultValue) constGets the value of InstanceRequestTemplateId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetInstanceRequestTemplateId(FString & OutValue) constFills OutValue with the value of InstanceRequestTemplateId_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetInstanceRequestTemplateIdOrNull()Returns a pointer to InstanceRequestTemplateId_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetInstanceRequestTemplateIdOrNull() constReturns a pointer to InstanceRequestTemplateId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetInstanceRequestTemplateId(const FString & NewValue)Sets the value of InstanceRequestTemplateId_Optional and also sets InstanceRequestTemplateId_IsSet to true.
public inline void SetInstanceRequestTemplateId(FString && NewValue)Sets the value of InstanceRequestTemplateId_Optional and also sets InstanceRequestTemplateId_IsSet to true using move semantics.
public inline void ClearInstanceRequestTemplateId()Clears the value of InstanceRequestTemplateId_Optional and sets InstanceRequestTemplateId_IsSet to false.
public inline bool IsInstanceRequestTemplateIdSet() constChecks whether InstanceRequestTemplateId_Optional has been set.
public inline void SetInstanceRequestTemplateIdToNull()Sets the value explicitly to be treated as null.
public inline bool IsInstanceRequestTemplateIdNull() constChecks whether InstanceRequestTemplateId_Optional is set to null.
public inline FString & GetMap()Gets the value of Map_Optional, regardless of it having been set.
public inline const FString & GetMap() constGets the value of Map_Optional, regardless of it having been set.
public inline const FString & GetMap(const FString & DefaultValue) constGets the value of Map_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetMap(FString & OutValue) constFills OutValue with the value of Map_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetMapOrNull()Returns a pointer to Map_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetMapOrNull() constReturns a pointer to Map_Optional, if it has been set, otherwise returns nullptr.
public inline void SetMap(const FString & NewValue)Sets the value of Map_Optional and also sets Map_IsSet to true.
public inline void SetMap(FString && NewValue)Sets the value of Map_Optional and also sets Map_IsSet to true using move semantics.
public inline void ClearMap()Clears the value of Map_Optional and sets Map_IsSet to false.
public inline bool IsMapSet() constChecks whether Map_Optional has been set.
public inline void SetMapToNull()Sets the value explicitly to be treated as null.
public inline bool IsMapNull() constChecks whether Map_Optional is set to null.
public inline FString & GetGameMode()Gets the value of GameMode_Optional, regardless of it having been set.
public inline const FString & GetGameMode() constGets the value of GameMode_Optional, regardless of it having been set.
public inline const FString & GetGameMode(const FString & DefaultValue) constGets the value of GameMode_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetGameMode(FString & OutValue) constFills OutValue with the value of GameMode_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetGameModeOrNull()Returns a pointer to GameMode_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetGameModeOrNull() constReturns a pointer to GameMode_Optional, if it has been set, otherwise returns nullptr.
public inline void SetGameMode(const FString & NewValue)Sets the value of GameMode_Optional and also sets GameMode_IsSet to true.
public inline void SetGameMode(FString && NewValue)Sets the value of GameMode_Optional and also sets GameMode_IsSet to true using move semantics.
public inline void ClearGameMode()Clears the value of GameMode_Optional and sets GameMode_IsSet to false.
public inline bool IsGameModeSet() constChecks whether GameMode_Optional has been set.
public inline void SetGameModeToNull()Sets the value explicitly to be treated as null.
public inline bool IsGameModeNull() constChecks whether GameMode_Optional is set to null.
public inline ERHAPI_MatchHostType & GetHostType()Gets the value of HostType_Optional, regardless of it having been set.
public inline const ERHAPI_MatchHostType & GetHostType() constGets the value of HostType_Optional, regardless of it having been set.
public inline const ERHAPI_MatchHostType & GetHostType(const ERHAPI_MatchHostType & DefaultValue) constGets the value of HostType_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetHostType(ERHAPI_MatchHostType & OutValue) constFills OutValue with the value of HostType_Optional and returns true if it has been set, otherwise returns false.
public inline ERHAPI_MatchHostType * GetHostTypeOrNull()Returns a pointer to HostType_Optional, if it has been set, otherwise returns nullptr.
public inline const ERHAPI_MatchHostType * GetHostTypeOrNull() constReturns a pointer to HostType_Optional, if it has been set, otherwise returns nullptr.
public inline void SetHostType(const ERHAPI_MatchHostType & NewValue)Sets the value of HostType_Optional and also sets HostType_IsSet to true.
public inline void SetHostType(ERHAPI_MatchHostType && NewValue)Sets the value of HostType_Optional and also sets HostType_IsSet to true using move semantics.
public inline void ClearHostType()Clears the value of HostType_Optional and sets HostType_IsSet to false.
public inline bool IsHostTypeSet() constChecks whether HostType_Optional has been set.
public inline void SetHostTypeToNull()Sets the value explicitly to be treated as null.
public inline bool IsHostTypeNull() constChecks whether HostType_Optional is set to null.

Members​

public FString InstanceId ​

Instance ID.

public FGuid HostPlayerUuid_Optional ​

public bool HostPlayerUuid_IsSet ​

true if HostPlayerUuid_Optional has been set to a value

public bool HostPlayerUuid_IsNull ​

true if HostPlayerUuid_Optional has been explicitly set to null

public FString RegionId_Optional ​

public bool RegionId_IsSet ​

true if RegionId_Optional has been set to a value

public bool RegionId_IsNull ​

true if RegionId_Optional has been explicitly set to null

public FString InstanceRequestTemplateId_Optional ​

public bool InstanceRequestTemplateId_IsSet ​

true if InstanceRequestTemplateId_Optional has been set to a value

public bool InstanceRequestTemplateId_IsNull ​

true if InstanceRequestTemplateId_Optional has been explicitly set to null

public FString Map_Optional ​

public bool Map_IsSet ​

true if Map_Optional has been set to a value

public bool Map_IsNull ​

true if Map_Optional has been explicitly set to null

public FString GameMode_Optional ​

public bool GameMode_IsSet ​

true if GameMode_Optional has been set to a value

public bool GameMode_IsNull ​

true if GameMode_Optional has been explicitly set to null

public ERHAPI_MatchHostType HostType_Optional ​

public bool HostType_IsSet ​

true if HostType_Optional has been set to a value

public bool HostType_IsNull ​

true if HostType_Optional has been explicitly set to null

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 FString & GetInstanceId() ​

Gets the value of InstanceId.

public inline const FString & GetInstanceId() const ​

Gets the value of InstanceId.

public inline void SetInstanceId(const FString & NewValue) ​

Sets the value of InstanceId.

public inline void SetInstanceId(FString && NewValue) ​

Sets the value of InstanceId using move semantics.

public inline FGuid & GetHostPlayerUuid() ​

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

public inline const FGuid & GetHostPlayerUuid() const ​

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

public inline const FGuid & GetHostPlayerUuid(const FGuid & DefaultValue) const ​

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

public inline bool GetHostPlayerUuid(FGuid & OutValue) const ​

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

public inline FGuid * GetHostPlayerUuidOrNull() ​

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

public inline const FGuid * GetHostPlayerUuidOrNull() const ​

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

public inline void SetHostPlayerUuid(const FGuid & NewValue) ​

Sets the value of HostPlayerUuid_Optional and also sets HostPlayerUuid_IsSet to true.

public inline void SetHostPlayerUuid(FGuid && NewValue) ​

Sets the value of HostPlayerUuid_Optional and also sets HostPlayerUuid_IsSet to true using move semantics.

public inline void ClearHostPlayerUuid() ​

Clears the value of HostPlayerUuid_Optional and sets HostPlayerUuid_IsSet to false.

public inline bool IsHostPlayerUuidSet() const ​

Checks whether HostPlayerUuid_Optional has been set.

public inline void SetHostPlayerUuidToNull() ​

Sets the value explicitly to be treated as null.

public inline bool IsHostPlayerUuidNull() const ​

Checks whether HostPlayerUuid_Optional is set to null.

public inline FString & GetRegionId() ​

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

public inline const FString & GetRegionId() const ​

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

public inline const FString & GetRegionId(const FString & DefaultValue) const ​

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

public inline bool GetRegionId(FString & OutValue) const ​

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

public inline FString * GetRegionIdOrNull() ​

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

public inline const FString * GetRegionIdOrNull() const ​

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

public inline void SetRegionId(const FString & NewValue) ​

Sets the value of RegionId_Optional and also sets RegionId_IsSet to true.

public inline void SetRegionId(FString && NewValue) ​

Sets the value of RegionId_Optional and also sets RegionId_IsSet to true using move semantics.

public inline void ClearRegionId() ​

Clears the value of RegionId_Optional and sets RegionId_IsSet to false.

public inline bool IsRegionIdSet() const ​

Checks whether RegionId_Optional has been set.

public inline void SetRegionIdToNull() ​

Sets the value explicitly to be treated as null.

public inline bool IsRegionIdNull() const ​

Checks whether RegionId_Optional is set to null.

public inline FString & GetInstanceRequestTemplateId() ​

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

public inline const FString & GetInstanceRequestTemplateId() const ​

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

public inline const FString & GetInstanceRequestTemplateId(const FString & DefaultValue) const ​

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

public inline bool GetInstanceRequestTemplateId(FString & OutValue) const ​

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

public inline FString * GetInstanceRequestTemplateIdOrNull() ​

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

public inline const FString * GetInstanceRequestTemplateIdOrNull() const ​

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

public inline void SetInstanceRequestTemplateId(const FString & NewValue) ​

Sets the value of InstanceRequestTemplateId_Optional and also sets InstanceRequestTemplateId_IsSet to true.

public inline void SetInstanceRequestTemplateId(FString && NewValue) ​

Sets the value of InstanceRequestTemplateId_Optional and also sets InstanceRequestTemplateId_IsSet to true using move semantics.

public inline void ClearInstanceRequestTemplateId() ​

Clears the value of InstanceRequestTemplateId_Optional and sets InstanceRequestTemplateId_IsSet to false.

public inline bool IsInstanceRequestTemplateIdSet() const ​

Checks whether InstanceRequestTemplateId_Optional has been set.

public inline void SetInstanceRequestTemplateIdToNull() ​

Sets the value explicitly to be treated as null.

public inline bool IsInstanceRequestTemplateIdNull() const ​

Checks whether InstanceRequestTemplateId_Optional is set to null.

public inline FString & GetMap() ​

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

public inline const FString & GetMap() const ​

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

public inline const FString & GetMap(const FString & DefaultValue) const ​

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

public inline bool GetMap(FString & OutValue) const ​

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

public inline FString * GetMapOrNull() ​

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

public inline const FString * GetMapOrNull() const ​

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

public inline void SetMap(const FString & NewValue) ​

Sets the value of Map_Optional and also sets Map_IsSet to true.

public inline void SetMap(FString && NewValue) ​

Sets the value of Map_Optional and also sets Map_IsSet to true using move semantics.

public inline void ClearMap() ​

Clears the value of Map_Optional and sets Map_IsSet to false.

public inline bool IsMapSet() const ​

Checks whether Map_Optional has been set.

public inline void SetMapToNull() ​

Sets the value explicitly to be treated as null.

public inline bool IsMapNull() const ​

Checks whether Map_Optional is set to null.

public inline FString & GetGameMode() ​

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

public inline const FString & GetGameMode() const ​

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

public inline const FString & GetGameMode(const FString & DefaultValue) const ​

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

public inline bool GetGameMode(FString & OutValue) const ​

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

public inline FString * GetGameModeOrNull() ​

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

public inline const FString * GetGameModeOrNull() const ​

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

public inline void SetGameMode(const FString & NewValue) ​

Sets the value of GameMode_Optional and also sets GameMode_IsSet to true.

public inline void SetGameMode(FString && NewValue) ​

Sets the value of GameMode_Optional and also sets GameMode_IsSet to true using move semantics.

public inline void ClearGameMode() ​

Clears the value of GameMode_Optional and sets GameMode_IsSet to false.

public inline bool IsGameModeSet() const ​

Checks whether GameMode_Optional has been set.

public inline void SetGameModeToNull() ​

Sets the value explicitly to be treated as null.

public inline bool IsGameModeNull() const ​

Checks whether GameMode_Optional is set to null.

public inline ERHAPI_MatchHostType & GetHostType() ​

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

public inline const ERHAPI_MatchHostType & GetHostType() const ​

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

public inline const ERHAPI_MatchHostType & GetHostType(const ERHAPI_MatchHostType & DefaultValue) const ​

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

public inline bool GetHostType(ERHAPI_MatchHostType & OutValue) const ​

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

public inline ERHAPI_MatchHostType * GetHostTypeOrNull() ​

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

public inline const ERHAPI_MatchHostType * GetHostTypeOrNull() const ​

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

public inline void SetHostType(const ERHAPI_MatchHostType & NewValue) ​

Sets the value of HostType_Optional and also sets HostType_IsSet to true.

public inline void SetHostType(ERHAPI_MatchHostType && NewValue) ​

Sets the value of HostType_Optional and also sets HostType_IsSet to true using move semantics.

public inline void ClearHostType() ​

Clears the value of HostType_Optional and sets HostType_IsSet to false.

public inline bool IsHostTypeSet() const ​

Checks whether HostType_Optional has been set.

public inline void SetHostTypeToNull() ​

Sets the value explicitly to be treated as null.

public inline bool IsHostTypeNull() const ​

Checks whether HostType_Optional is set to null.