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`](#structFRHAPI__RallyHereEvent_1a656a296942ca42e695f76903e85c4595)
Type of event to process this as.
#### `public FDateTime `[`EventTimestamp`](#structFRHAPI__RallyHereEvent_1a21d884d4685260a84308c9b9f19bf30f)
Time the event was triggered.
#### `public `[`FRHAPI_JsonObject`](undefined.md#structFRHAPI__JsonObject)` `[`EventParams`](#structFRHAPI__RallyHereEvent_1af3ed29c3eaa7aede666ede0907ea05d4)
Event specific parameters.
#### `public TMap< FString, FString > `[`CustomData_Optional`](#structFRHAPI__RallyHereEvent_1ae04c02282e0fe088075b3ec7726c0174)
Event custom data.
#### `public bool `[`CustomData_IsSet`](#structFRHAPI__RallyHereEvent_1a75c2cf8558bf9cb079cda2338ff78ec8)
true if CustomData_Optional has been set to a value
#### `public FString `[`UserId_Optional`](#structFRHAPI__RallyHereEvent_1adf25f2d9ce1ff401d1e4a295fcfa9926)
#### `public bool `[`UserId_IsSet`](#structFRHAPI__RallyHereEvent_1adb88b950d0f6e108ebfc5b457dba79d4)
true if UserId_Optional has been set to a value
#### `public FString `[`SessionId_Optional`](#structFRHAPI__RallyHereEvent_1a3fbc2d2ff96628339eef3b7bc09f06ab)
#### `public bool `[`SessionId_IsSet`](#structFRHAPI__RallyHereEvent_1a9e4c120b0e2e38bf8c2bb90f496d448a)
true if SessionId_Optional has been set to a value
#### `public FString `[`CorrelationId_Optional`](#structFRHAPI__RallyHereEvent_1aa6fc132726228aa208b2cf3758dbcce3)
#### `public bool `[`CorrelationId_IsSet`](#structFRHAPI__RallyHereEvent_1adbc7c013cc9349f1695bc00ecc4eeea4)
true if CorrelationId_Optional has been set to a value
#### `public virtual bool `[`FromJson`](#structFRHAPI__RallyHereEvent_1a274e63cdf9ce91a751d12e9d5b0072d1)`(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`](#structFRHAPI__RallyHereEvent_1a78aca75728bbab8942e70e3320d26f66)`(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`](#structFRHAPI__RallyHereEvent_1a5aed540af10d37a0ca89ffbb27772a6a)`()`
Gets the value of EventUuid.
#### `public inline const FGuid & `[`GetEventUuid`](#structFRHAPI__RallyHereEvent_1ae1ddab7e54e8cf26e0e6e933b099cf43)`() const`
Gets the value of EventUuid.
#### `public inline void `[`SetEventUuid`](#structFRHAPI__RallyHereEvent_1a1ea00c36166d4c1408ce50e56360126f)`(FGuid NewValue)`
Sets the value of EventUuid.
#### `public inline FString & `[`GetEventName`](#structFRHAPI__RallyHereEvent_1a8c0b6b106b52c8226290baecc2116bec)`()`
Gets the value of EventName.
#### `public inline const FString & `[`GetEventName`](#structFRHAPI__RallyHereEvent_1a6cbf1d4eae5f048fd0f5b0ef22071038)`() const`
Gets the value of EventName.
#### `public inline void `[`SetEventName`](#structFRHAPI__RallyHereEvent_1a9e8c56e17ec3cc31ad3631304f49d044)`(FString NewValue)`
Sets the value of EventName.
#### `public inline FDateTime & `[`GetEventTimestamp`](#structFRHAPI__RallyHereEvent_1a9ab03712935c73f7d5f36c60429680d7)`()`
Gets the value of EventTimestamp.
#### `public inline const FDateTime & `[`GetEventTimestamp`](#structFRHAPI__RallyHereEvent_1a5d65f5360e0bc88c4ea2374bee40d3e8)`() const`
Gets the value of EventTimestamp.
#### `public inline void `[`SetEventTimestamp`](#structFRHAPI__RallyHereEvent_1ad478284f0400f058a9d0400fac9ff822)`(FDateTime NewValue)`
Sets the value of EventTimestamp.
#### `public inline `[`FRHAPI_JsonObject`](undefined.md#structFRHAPI__JsonObject)` & `[`GetEventParams`](#structFRHAPI__RallyHereEvent_1a95c443fd41efaa6c87b03cdd0e000da8)`()`
Gets the value of EventParams.
#### `public inline const `[`FRHAPI_JsonObject`](undefined.md#structFRHAPI__JsonObject)` & `[`GetEventParams`](#structFRHAPI__RallyHereEvent_1a1e48980f6b66c8557163abd78c2d3b99)`() const`
Gets the value of EventParams.
#### `public inline void `[`SetEventParams`](#structFRHAPI__RallyHereEvent_1a1bb32203a0708dbe8d7d52b94e2c5299)`(`[`FRHAPI_JsonObject`](undefined.md#structFRHAPI__JsonObject)` NewValue)`
Sets the value of EventParams.
#### `public inline TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__RallyHereEvent_1a2a3c3cf7de240af041d8f1ba45d94e06)`()`
Gets the value of CustomData_Optional, regardless of it having been set.
#### `public inline const TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__RallyHereEvent_1a5f3b955cc1fb5cf52abaee4c9b6c4464)`() const`
Gets the value of CustomData_Optional, regardless of it having been set.
#### `public inline const TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__RallyHereEvent_1a1bee5d71f945eef8cd33e173ba874183)`(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`](#structFRHAPI__RallyHereEvent_1a198a15f8de8b6425e1e1da62e29034b4)`(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`](#structFRHAPI__RallyHereEvent_1af38ea07540ec10ccb1900a2a08b77bf5)`()`
Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const TMap< FString, FString > * `[`GetCustomDataOrNull`](#structFRHAPI__RallyHereEvent_1ac370b544c9034ecb2bb43da39e79825f)`() const`
Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetCustomData`](#structFRHAPI__RallyHereEvent_1a2622be87a9cb04b359faa4c96eb79c8a)`(TMap< FString, FString > NewValue)`
Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.
#### `public inline void `[`ClearCustomData`](#structFRHAPI__RallyHereEvent_1a25599661d7605c4bc5f94814ecdf0702)`()`
Clears the value of CustomData_Optional and sets CustomData_IsSet to false.
#### `public inline FString & `[`GetUserId`](#structFRHAPI__RallyHereEvent_1adb44239472afd8b2a8039441094c05c1)`()`
Gets the value of UserId_Optional, regardless of it having been set.
#### `public inline const FString & `[`GetUserId`](#structFRHAPI__RallyHereEvent_1a1a27346dff8fd0948ebf422c50997026)`() const`
Gets the value of UserId_Optional, regardless of it having been set.
#### `public inline const FString & `[`GetUserId`](#structFRHAPI__RallyHereEvent_1a853454a8a4704e5de57d0a9e2da8c7ad)`(const FString & DefaultValue) const`
Gets the value of UserId_Optional, if it has been set, otherwise it returns DefaultValue.
#### `public inline bool `[`GetUserId`](#structFRHAPI__RallyHereEvent_1ac8218ee92acb2ca4d242f0f9caabd76b)`(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`](#structFRHAPI__RallyHereEvent_1afca2d0c7cc5d5e62c470d965be876374)`()`
Returns a pointer to UserId_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const FString * `[`GetUserIdOrNull`](#structFRHAPI__RallyHereEvent_1a2cd6824c9639c46b50d68fdfc5442394)`() const`
Returns a pointer to UserId_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetUserId`](#structFRHAPI__RallyHereEvent_1a7d659c68681b8b4f358f2ad11de6c46a)`(FString NewValue)`
Sets the value of UserId_Optional and also sets UserId_IsSet to true.
#### `public inline void `[`ClearUserId`](#structFRHAPI__RallyHereEvent_1ab495ffdc4fcda047ecbd42e18bcfe97b)`()`
Clears the value of UserId_Optional and sets UserId_IsSet to false.
#### `public inline FString & `[`GetSessionId`](#structFRHAPI__RallyHereEvent_1a203ffee4e765ade4f9a527bec51de331)`()`
Gets the value of SessionId_Optional, regardless of it having been set.
#### `public inline const FString & `[`GetSessionId`](#structFRHAPI__RallyHereEvent_1a1166b7897b1c281177efded34e2d1b78)`() const`
Gets the value of SessionId_Optional, regardless of it having been set.
#### `public inline const FString & `[`GetSessionId`](#structFRHAPI__RallyHereEvent_1aac2ff071abc4ac7bc0ee7ece61fdcba4)`(const FString & DefaultValue) const`
Gets the value of SessionId_Optional, if it has been set, otherwise it returns DefaultValue.
#### `public inline bool `[`GetSessionId`](#structFRHAPI__RallyHereEvent_1a4dde5360e236ab34956e90fed1e7cd17)`(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`](#structFRHAPI__RallyHereEvent_1aeb2d94dc72c8112eb514c3ae53e7f3eb)`()`
Returns a pointer to SessionId_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const FString * `[`GetSessionIdOrNull`](#structFRHAPI__RallyHereEvent_1ac3623f6e68b7dccc5034c90190601817)`() const`
Returns a pointer to SessionId_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetSessionId`](#structFRHAPI__RallyHereEvent_1af4385cbbec8dcee8e004b590ebdfdc5e)`(FString NewValue)`
Sets the value of SessionId_Optional and also sets SessionId_IsSet to true.
#### `public inline void `[`ClearSessionId`](#structFRHAPI__RallyHereEvent_1a2fad37a84ed8eb2cbaac71c605d07e0d)`()`
Clears the value of SessionId_Optional and sets SessionId_IsSet to false.
#### `public inline FString & `[`GetCorrelationId`](#structFRHAPI__RallyHereEvent_1ad3f3f6286d2b7e66942cccac82eab104)`()`
Gets the value of CorrelationId_Optional, regardless of it having been set.
#### `public inline const FString & `[`GetCorrelationId`](#structFRHAPI__RallyHereEvent_1ad9ebd7493ac5b15a6f4a9da7f540b5f5)`() const`
Gets the value of CorrelationId_Optional, regardless of it having been set.
#### `public inline const FString & `[`GetCorrelationId`](#structFRHAPI__RallyHereEvent_1ad4cd64dc3c86723e95621a5ea120c2f2)`(const FString & DefaultValue) const`
Gets the value of CorrelationId_Optional, if it has been set, otherwise it returns DefaultValue.
#### `public inline bool `[`GetCorrelationId`](#structFRHAPI__RallyHereEvent_1ad678bb41eb6c48f528014ec9a06cb11c)`(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`](#structFRHAPI__RallyHereEvent_1a9f50bdfdc544f13ee69c23e6867a75c4)`()`
Returns a pointer to CorrelationId_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const FString * `[`GetCorrelationIdOrNull`](#structFRHAPI__RallyHereEvent_1a28074f6106163ac7a791091fde1c270f)`() const`
Returns a pointer to CorrelationId_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetCorrelationId`](#structFRHAPI__RallyHereEvent_1a5494f9ff1e4cd6b341d55663c201009d)`(FString NewValue)`
Sets the value of CorrelationId_Optional and also sets CorrelationId_IsSet to true.
#### `public inline void `[`ClearCorrelationId`](#structFRHAPI__RallyHereEvent_1a68b08b6136ad6f5fd85300d15478de1a)`()`
Clears the value of CorrelationId_Optional and sets CorrelationId_IsSet to false.