RHAPI_SessionEventCreateRequest

Summary

Members	Descriptions
struct FRHAPI_SessionEventCreateRequest	A request body to create an event about a session.

struct FRHAPI_SessionEventCreateRequest

struct FRHAPI_SessionEventCreateRequest
  : public FRHAPI_Model

A request body to create an event about a session.

Summary

Members	Descriptions
public FString EventCode	Code that identifies this type of event. See CommonEventCode for common examples.
public FString Description_Optional	Description metadata about the event.
public bool Description_IsSet	true if Description_Optional has been set to a value
public TMap< FString, FString > CustomData_Optional	custom data about this event
public bool CustomData_IsSet	true if CustomData_Optional has been set to a value
public FDateTime Timestamp	Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.
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 FString & GetEventCode()	Gets the value of EventCode.
public inline const FString & GetEventCode() const	Gets the value of EventCode.
public inline void SetEventCode(FString NewValue)	Sets the value of EventCode.
public inline FString & GetDescription()	Gets the value of Description_Optional, regardless of it having been set.
public inline const FString & GetDescription() const	Gets the value of Description_Optional, regardless of it having been set.
public inline const FString & GetDescription(const FString & DefaultValue) const	Gets the value of Description_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetDescription(FString & OutValue) const	Fills OutValue with the value of Description_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetDescriptionOrNull()	Returns a pointer to Description_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetDescriptionOrNull() const	Returns a pointer to Description_Optional, if it has been set, otherwise returns nullptr.
public inline void SetDescription(FString NewValue)	Sets the value of Description_Optional and also sets Description_IsSet to true.
public inline void ClearDescription()	Clears the value of Description_Optional and sets Description_IsSet to false.
public inline bool IsDescriptionDefaultValue() const	Returns true if Description_Optional is set and matches the default value.
public inline void SetDescriptionToDefault()	Sets the value of Description_Optional to its default and also sets Description_IsSet to true.
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 FDateTime & GetTimestamp()	Gets the value of Timestamp.
public inline const FDateTime & GetTimestamp() const	Gets the value of Timestamp.
public inline void SetTimestamp(FDateTime NewValue)	Sets the value of Timestamp.

Members

public FString EventCode

Code that identifies this type of event. See CommonEventCode for common examples.

public FString Description_Optional

Description metadata about the event.

public bool Description_IsSet

true if Description_Optional has been set to a value

public TMap< FString, FString > CustomData_Optional

custom data about this event

public bool CustomData_IsSet

true if CustomData_Optional has been set to a value

public FDateTime Timestamp

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.

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 & GetEventCode()

Gets the value of EventCode.

public inline const FString & GetEventCode() const

Gets the value of EventCode.

public inline void SetEventCode(FString NewValue)

Sets the value of EventCode.

public inline FString & GetDescription()

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

public inline const FString & GetDescription() const

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

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

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

public inline bool GetDescription(FString & OutValue) const

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

public inline FString * GetDescriptionOrNull()

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

public inline const FString * GetDescriptionOrNull() const

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

public inline void SetDescription(FString NewValue)

Sets the value of Description_Optional and also sets Description_IsSet to true.

public inline void ClearDescription()

Clears the value of Description_Optional and sets Description_IsSet to false.

public inline bool IsDescriptionDefaultValue() const

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

public inline void SetDescriptionToDefault()

Sets the value of Description_Optional to its default and also sets Description_IsSet to true.

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 FDateTime & GetTimestamp()

Gets the value of Timestamp.

public inline const FDateTime & GetTimestamp() const

Gets the value of Timestamp.

public inline void SetTimestamp(FDateTime NewValue)

Sets the value of Timestamp.