Skip to main content

RHAPI_RallyHereEvent

Summary​

MembersDescriptions
struct FRHAPI_RallyHereEvent

struct FRHAPI_RallyHereEvent ​

struct FRHAPI_RallyHereEvent
: public FRHAPI_Model

Summary​

MembersDescriptions
public FGuid EventUuidUnique Event ID for this instance of the event.
public FString EventNameType of event to process this as.
public FDateTime EventTimestampTime the event was triggered.
public FRHAPI_JsonObject EventParamsEvent specific parameters.
public TMap< FString, FString > CustomData_OptionalEvent custom data.
public bool CustomData_IsSettrue if CustomData_Optional has been set to a value
public FString UserId_Optional
public bool UserId_IsSettrue if UserId_Optional has been set to a value
public bool UserId_IsNulltrue if UserId_Optional has been explicitly set to null
public FString SessionId_Optional
public bool SessionId_IsSettrue if SessionId_Optional has been set to a value
public bool SessionId_IsNulltrue if SessionId_Optional has been explicitly set to null
public FString CorrelationId_Optional
public bool CorrelationId_IsSettrue if CorrelationId_Optional has been set to a value
public bool CorrelationId_IsNulltrue if CorrelationId_Optional has been explicitly set to null
public FString ClientIp_Optional
public bool ClientIp_IsSettrue if ClientIp_Optional has been set to a value
public bool ClientIp_IsNulltrue if ClientIp_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 FGuid & GetEventUuid()Gets the value of EventUuid.
public inline const FGuid & GetEventUuid() constGets the value of EventUuid.
public inline void SetEventUuid(const FGuid & NewValue)Sets the value of EventUuid.
public inline void SetEventUuid(FGuid && NewValue)Sets the value of EventUuid using move semantics.
public inline FString & GetEventName()Gets the value of EventName.
public inline const FString & GetEventName() constGets the value of EventName.
public inline void SetEventName(const FString & NewValue)Sets the value of EventName.
public inline void SetEventName(FString && NewValue)Sets the value of EventName using move semantics.
public inline FDateTime & GetEventTimestamp()Gets the value of EventTimestamp.
public inline const FDateTime & GetEventTimestamp() constGets the value of EventTimestamp.
public inline void SetEventTimestamp(const FDateTime & NewValue)Sets the value of EventTimestamp.
public inline void SetEventTimestamp(FDateTime && NewValue)Sets the value of EventTimestamp using move semantics.
public inline FRHAPI_JsonObject&GetEventParams()Gets the value of EventParams.
public inline const FRHAPI_JsonObject&GetEventParams() constGets the value of EventParams.
public inline void SetEventParams(const FRHAPI_JsonObject & NewValue)Sets the value of EventParams.
public inline void SetEventParams(FRHAPI_JsonObject && NewValue)Sets the value of EventParams using move semantics.
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 FString & GetUserId()Gets the value of UserId_Optional, regardless of it having been set.
public inline const FString & GetUserId() constGets the value of UserId_Optional, regardless of it having been set.
public inline const FString & GetUserId(const FString & DefaultValue) constGets the value of UserId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetUserId(FString & OutValue) constFills OutValue with the value of UserId_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetUserIdOrNull()Returns a pointer to UserId_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetUserIdOrNull() constReturns a pointer to UserId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetUserId(const FString & NewValue)Sets the value of UserId_Optional and also sets UserId_IsSet to true.
public inline void SetUserId(FString && NewValue)Sets the value of UserId_Optional and also sets UserId_IsSet to true using move semantics.
public inline void ClearUserId()Clears the value of UserId_Optional and sets UserId_IsSet to false.
public inline bool IsUserIdSet() constChecks whether UserId_Optional has been set.
public inline void SetUserIdToNull()Sets the value explicitly to be treated as null.
public inline bool IsUserIdNull() constChecks whether UserId_Optional is set to null.
public inline FString & GetSessionId()Gets the value of SessionId_Optional, regardless of it having been set.
public inline const FString & GetSessionId() constGets the value of SessionId_Optional, regardless of it having been set.
public inline const FString & GetSessionId(const FString & DefaultValue) constGets the value of SessionId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetSessionId(FString & OutValue) constFills OutValue with the value of SessionId_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetSessionIdOrNull()Returns a pointer to SessionId_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetSessionIdOrNull() constReturns a pointer to SessionId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetSessionId(const FString & NewValue)Sets the value of SessionId_Optional and also sets SessionId_IsSet to true.
public inline void SetSessionId(FString && NewValue)Sets the value of SessionId_Optional and also sets SessionId_IsSet to true using move semantics.
public inline void ClearSessionId()Clears the value of SessionId_Optional and sets SessionId_IsSet to false.
public inline bool IsSessionIdSet() constChecks whether SessionId_Optional has been set.
public inline void SetSessionIdToNull()Sets the value explicitly to be treated as null.
public inline bool IsSessionIdNull() constChecks whether SessionId_Optional is set to null.
public inline FString & GetCorrelationId()Gets the value of CorrelationId_Optional, regardless of it having been set.
public inline const FString & GetCorrelationId() constGets the value of CorrelationId_Optional, regardless of it having been set.
public inline const FString & GetCorrelationId(const FString & DefaultValue) constGets the value of CorrelationId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetCorrelationId(FString & OutValue) constFills OutValue with the value of CorrelationId_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetCorrelationIdOrNull()Returns a pointer to CorrelationId_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetCorrelationIdOrNull() constReturns a pointer to CorrelationId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetCorrelationId(const FString & NewValue)Sets the value of CorrelationId_Optional and also sets CorrelationId_IsSet to true.
public inline void SetCorrelationId(FString && NewValue)Sets the value of CorrelationId_Optional and also sets CorrelationId_IsSet to true using move semantics.
public inline void ClearCorrelationId()Clears the value of CorrelationId_Optional and sets CorrelationId_IsSet to false.
public inline bool IsCorrelationIdSet() constChecks whether CorrelationId_Optional has been set.
public inline void SetCorrelationIdToNull()Sets the value explicitly to be treated as null.
public inline bool IsCorrelationIdNull() constChecks whether CorrelationId_Optional is set to null.
public inline FString & GetClientIp()Gets the value of ClientIp_Optional, regardless of it having been set.
public inline const FString & GetClientIp() constGets the value of ClientIp_Optional, regardless of it having been set.
public inline const FString & GetClientIp(const FString & DefaultValue) constGets the value of ClientIp_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetClientIp(FString & OutValue) constFills OutValue with the value of ClientIp_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetClientIpOrNull()Returns a pointer to ClientIp_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetClientIpOrNull() constReturns a pointer to ClientIp_Optional, if it has been set, otherwise returns nullptr.
public inline void SetClientIp(const FString & NewValue)Sets the value of ClientIp_Optional and also sets ClientIp_IsSet to true.
public inline void SetClientIp(FString && NewValue)Sets the value of ClientIp_Optional and also sets ClientIp_IsSet to true using move semantics.
public inline void ClearClientIp()Clears the value of ClientIp_Optional and sets ClientIp_IsSet to false.
public inline bool IsClientIpSet() constChecks whether ClientIp_Optional has been set.
public inline void SetClientIpToNull()Sets the value explicitly to be treated as null.
public inline bool IsClientIpNull() constChecks whether ClientIp_Optional is set to null.

Members​

public FGuid EventUuid ​

Unique Event ID for this instance of the event.

public FString EventName ​

Type of event to process this as.

public FDateTime EventTimestamp ​

Time the event was triggered.

public FRHAPI_JsonObject EventParams ​

Event specific parameters.

public TMap< FString, FString > CustomData_Optional ​

Event custom data.

public bool CustomData_IsSet ​

true if CustomData_Optional has been set to a value

public FString UserId_Optional ​

public bool UserId_IsSet ​

true if UserId_Optional has been set to a value

public bool UserId_IsNull ​

true if UserId_Optional has been explicitly set to null

public FString SessionId_Optional ​

public bool SessionId_IsSet ​

true if SessionId_Optional has been set to a value

public bool SessionId_IsNull ​

true if SessionId_Optional has been explicitly set to null

public FString CorrelationId_Optional ​

public bool CorrelationId_IsSet ​

true if CorrelationId_Optional has been set to a value

public bool CorrelationId_IsNull ​

true if CorrelationId_Optional has been explicitly set to null

public FString ClientIp_Optional ​

public bool ClientIp_IsSet ​

true if ClientIp_Optional has been set to a value

public bool ClientIp_IsNull ​

true if ClientIp_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 FGuid & GetEventUuid() ​

Gets the value of EventUuid.

public inline const FGuid & GetEventUuid() const ​

Gets the value of EventUuid.

public inline void SetEventUuid(const FGuid & NewValue) ​

Sets the value of EventUuid.

public inline void SetEventUuid(FGuid && NewValue) ​

Sets the value of EventUuid using move semantics.

public inline FString & GetEventName() ​

Gets the value of EventName.

public inline const FString & GetEventName() const ​

Gets the value of EventName.

public inline void SetEventName(const FString & NewValue) ​

Sets the value of EventName.

public inline void SetEventName(FString && NewValue) ​

Sets the value of EventName using move semantics.

public inline FDateTime & GetEventTimestamp() ​

Gets the value of EventTimestamp.

public inline const FDateTime & GetEventTimestamp() const ​

Gets the value of EventTimestamp.

public inline void SetEventTimestamp(const FDateTime & NewValue) ​

Sets the value of EventTimestamp.

public inline void SetEventTimestamp(FDateTime && NewValue) ​

Sets the value of EventTimestamp using move semantics.

public inline FRHAPI_JsonObject&GetEventParams() ​

Gets the value of EventParams.

public inline const FRHAPI_JsonObject&GetEventParams() const ​

Gets the value of EventParams.

public inline void SetEventParams(const FRHAPI_JsonObject & NewValue) ​

Sets the value of EventParams.

public inline void SetEventParams(FRHAPI_JsonObject && NewValue) ​

Sets the value of EventParams using move semantics.

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

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

public inline const FString & GetUserId() const ​

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

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

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

public inline bool GetUserId(FString & OutValue) const ​

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

public inline FString * GetUserIdOrNull() ​

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

public inline const FString * GetUserIdOrNull() const ​

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

public inline void SetUserId(const FString & NewValue) ​

Sets the value of UserId_Optional and also sets UserId_IsSet to true.

public inline void SetUserId(FString && NewValue) ​

Sets the value of UserId_Optional and also sets UserId_IsSet to true using move semantics.

public inline void ClearUserId() ​

Clears the value of UserId_Optional and sets UserId_IsSet to false.

public inline bool IsUserIdSet() const ​

Checks whether UserId_Optional has been set.

public inline void SetUserIdToNull() ​

Sets the value explicitly to be treated as null.

public inline bool IsUserIdNull() const ​

Checks whether UserId_Optional is set to null.

public inline FString & GetSessionId() ​

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

public inline const FString & GetSessionId() const ​

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

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

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

public inline bool GetSessionId(FString & OutValue) const ​

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

public inline FString * GetSessionIdOrNull() ​

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

public inline const FString * GetSessionIdOrNull() const ​

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

public inline void SetSessionId(const FString & NewValue) ​

Sets the value of SessionId_Optional and also sets SessionId_IsSet to true.

public inline void SetSessionId(FString && NewValue) ​

Sets the value of SessionId_Optional and also sets SessionId_IsSet to true using move semantics.

public inline void ClearSessionId() ​

Clears the value of SessionId_Optional and sets SessionId_IsSet to false.

public inline bool IsSessionIdSet() const ​

Checks whether SessionId_Optional has been set.

public inline void SetSessionIdToNull() ​

Sets the value explicitly to be treated as null.

public inline bool IsSessionIdNull() const ​

Checks whether SessionId_Optional is set to null.

public inline FString & GetCorrelationId() ​

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

public inline const FString & GetCorrelationId() const ​

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

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

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

public inline bool GetCorrelationId(FString & OutValue) const ​

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

public inline FString * GetCorrelationIdOrNull() ​

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

public inline const FString * GetCorrelationIdOrNull() const ​

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

public inline void SetCorrelationId(const FString & NewValue) ​

Sets the value of CorrelationId_Optional and also sets CorrelationId_IsSet to true.

public inline void SetCorrelationId(FString && NewValue) ​

Sets the value of CorrelationId_Optional and also sets CorrelationId_IsSet to true using move semantics.

public inline void ClearCorrelationId() ​

Clears the value of CorrelationId_Optional and sets CorrelationId_IsSet to false.

public inline bool IsCorrelationIdSet() const ​

Checks whether CorrelationId_Optional has been set.

public inline void SetCorrelationIdToNull() ​

Sets the value explicitly to be treated as null.

public inline bool IsCorrelationIdNull() const ​

Checks whether CorrelationId_Optional is set to null.

public inline FString & GetClientIp() ​

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

public inline const FString & GetClientIp() const ​

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

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

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

public inline bool GetClientIp(FString & OutValue) const ​

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

public inline FString * GetClientIpOrNull() ​

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

public inline const FString * GetClientIpOrNull() const ​

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

public inline void SetClientIp(const FString & NewValue) ​

Sets the value of ClientIp_Optional and also sets ClientIp_IsSet to true.

public inline void SetClientIp(FString && NewValue) ​

Sets the value of ClientIp_Optional and also sets ClientIp_IsSet to true using move semantics.

public inline void ClearClientIp() ​

Clears the value of ClientIp_Optional and sets ClientIp_IsSet to false.

public inline bool IsClientIpSet() const ​

Checks whether ClientIp_Optional has been set.

public inline void SetClientIpToNull() ​

Sets the value explicitly to be treated as null.

public inline bool IsClientIpNull() const ​

Checks whether ClientIp_Optional is set to null.