RHAPI_RallyHereEvent
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_RallyHereEvent |
struct FRHAPI_RallyHereEvent
struct FRHAPI_RallyHereEvent : public FRHAPI_ModelSummary
| Members | Descriptions |
|---|---|
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 FString SessionId_Optional | |
public bool SessionId_IsSet | true if SessionId_Optional has been set to a value |
public FString CorrelationId_Optional | |
public bool CorrelationId_IsSet | true if CorrelationId_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) const | Writes 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() const | Gets the value of EventUuid. |
public inline void SetEventUuid(FGuid NewValue) | Sets the value of EventUuid. |
public inline FString & GetEventName() | Gets the value of EventName. |
public inline const FString & GetEventName() const | Gets the value of EventName. |
public inline void SetEventName(FString NewValue) | Sets the value of EventName. |
public inline FDateTime & GetEventTimestamp() | Gets the value of EventTimestamp. |
public inline const FDateTime & GetEventTimestamp() const | Gets the value of EventTimestamp. |
public inline void SetEventTimestamp(FDateTime NewValue) | Sets the value of EventTimestamp. |
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(FRHAPI_JsonObject NewValue) | Sets the value of EventParams. |
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(TMap< FString, FString > NewValue) | Sets the value of CustomData_Optional and also sets CustomData_IsSet to true. |
public inline void ClearCustomData() | Clears the value of CustomData_Optional and sets CustomData_IsSet to false. |
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(FString NewValue) | Sets the value of UserId_Optional and also sets UserId_IsSet to true. |
public inline void ClearUserId() | Clears the value of UserId_Optional and sets UserId_IsSet to false. |
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(FString NewValue) | Sets the value of SessionId_Optional and also sets SessionId_IsSet to true. |
public inline void ClearSessionId() | Clears the value of SessionId_Optional and sets SessionId_IsSet to false. |
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(FString NewValue) | Sets the value of CorrelationId_Optional and also sets CorrelationId_IsSet to true. |
public inline void ClearCorrelationId() | Clears the value of CorrelationId_Optional and sets CorrelationId_IsSet to false. |
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 FString SessionId_Optional
public bool SessionId_IsSet
true if SessionId_Optional has been set to a value
public FString CorrelationId_Optional
public bool CorrelationId_IsSet
true if CorrelationId_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
JsonValueData 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
WriterJSON 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(FGuid NewValue)
Sets the value of EventUuid.
public inline FString & GetEventName()
Gets the value of EventName.
public inline const FString & GetEventName() const
Gets the value of EventName.
public inline void SetEventName(FString NewValue)
Sets the value of EventName.
public inline FDateTime & GetEventTimestamp()
Gets the value of EventTimestamp.
public inline const FDateTime & GetEventTimestamp() const
Gets the value of EventTimestamp.
public inline void SetEventTimestamp(FDateTime NewValue)
Sets the value of EventTimestamp.
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(FRHAPI_JsonObject NewValue)
Sets the value of EventParams.
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(TMap< FString, FString > NewValue)
Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.
public inline void ClearCustomData()
Clears the value of CustomData_Optional and sets CustomData_IsSet to false.
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(FString NewValue)
Sets the value of UserId_Optional and also sets UserId_IsSet to true.
public inline void ClearUserId()
Clears the value of UserId_Optional and sets UserId_IsSet to false.
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(FString NewValue)
Sets the value of SessionId_Optional and also sets SessionId_IsSet to true.
public inline void ClearSessionId()
Clears the value of SessionId_Optional and sets SessionId_IsSet to false.
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(FString NewValue)
Sets the value of CorrelationId_Optional and also sets CorrelationId_IsSet to true.
public inline void ClearCorrelationId()
Clears the value of CorrelationId_Optional and sets CorrelationId_IsSet to false.