RHAPI_PlayerSessions
Summary
Members | Descriptions |
---|---|
struct FRHAPI_PlayerSessions | Information about all sessions that a player is currently a member of, or invited to. |
struct FRHAPI_PlayerSessions
Information about all sessions that a player is currently a member of, or invited to.
Summary
Members | Descriptions |
---|---|
public TMap< FString, FRHAPI_PlayerSession > Sessions_Optional | Session associated with this player, and any pending invites. |
public bool Sessions_IsSet | true if Sessions_Optional has been set to a value |
public FDateTime LastUpdatedTimestamp_Optional | Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone. |
public bool LastUpdatedTimestamp_IsSet | true if LastUpdatedTimestamp_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 TMap< FString, FRHAPI_PlayerSession > & GetSessions () | Gets the value of Sessions_Optional, regardless of it having been set. |
public inline const TMap< FString, FRHAPI_PlayerSession > & GetSessions () const | Gets the value of Sessions_Optional, regardless of it having been set. |
public inline const TMap< FString, FRHAPI_PlayerSession > & GetSessions (const TMap< FString, FRHAPI_PlayerSession > & DefaultValue) const | Gets the value of Sessions_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetSessions (TMap< FString, FRHAPI_PlayerSession > & OutValue) const | Fills OutValue with the value of Sessions_Optional and returns true if it has been set, otherwise returns false. |
public inline TMap< FString, FRHAPI_PlayerSession > * GetSessionsOrNull () | Returns a pointer to Sessions_Optional, if it has been set, otherwise returns nullptr. |
public inline const TMap< FString, FRHAPI_PlayerSession > * GetSessionsOrNull () const | Returns a pointer to Sessions_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetSessions (TMap< FString, FRHAPI_PlayerSession > NewValue) | Sets the value of Sessions_Optional and also sets Sessions_IsSet to true. |
public inline void ClearSessions () | Clears the value of Sessions_Optional and sets Sessions_IsSet to false. |
public inline FDateTime & GetLastUpdatedTimestamp () | Gets the value of LastUpdatedTimestamp_Optional, regardless of it having been set. |
public inline const FDateTime & GetLastUpdatedTimestamp () const | Gets the value of LastUpdatedTimestamp_Optional, regardless of it having been set. |
public inline const FDateTime & GetLastUpdatedTimestamp (const FDateTime & DefaultValue) const | Gets the value of LastUpdatedTimestamp_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetLastUpdatedTimestamp (FDateTime & OutValue) const | Fills OutValue with the value of LastUpdatedTimestamp_Optional and returns true if it has been set, otherwise returns false. |
public inline FDateTime * GetLastUpdatedTimestampOrNull () | Returns a pointer to LastUpdatedTimestamp_Optional, if it has been set, otherwise returns nullptr. |
public inline const FDateTime * GetLastUpdatedTimestampOrNull () const | Returns a pointer to LastUpdatedTimestamp_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetLastUpdatedTimestamp (FDateTime NewValue) | Sets the value of LastUpdatedTimestamp_Optional and also sets LastUpdatedTimestamp_IsSet to true. |
public inline void ClearLastUpdatedTimestamp () | Clears the value of LastUpdatedTimestamp_Optional and sets LastUpdatedTimestamp_IsSet to false. |
Members
public TMap< FString,
FRHAPI_PlayerSession
>
Sessions_Optional
Session associated with this player, and any pending invites.
public bool
Sessions_IsSet
true if Sessions_Optional has been set to a value
public FDateTime
LastUpdatedTimestamp_Optional
Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.
public bool
LastUpdatedTimestamp_IsSet
true if LastUpdatedTimestamp_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
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 TMap< FString,
FRHAPI_PlayerSession
> &
GetSessions
()
Gets the value of Sessions_Optional, regardless of it having been set.
public inline const TMap< FString,
FRHAPI_PlayerSession
> &
GetSessions
() const
Gets the value of Sessions_Optional, regardless of it having been set.
public inline const TMap< FString,
FRHAPI_PlayerSession
> &
GetSessions
(const TMap< FString,
FRHAPI_PlayerSession
> & DefaultValue) const
Gets the value of Sessions_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool
GetSessions
(TMap< FString,
FRHAPI_PlayerSession
> & OutValue) const
Fills OutValue with the value of Sessions_Optional and returns true if it has been set, otherwise returns false.
public inline TMap< FString,
FRHAPI_PlayerSession
> *
GetSessionsOrNull
()
Returns a pointer to Sessions_Optional, if it has been set, otherwise returns nullptr.
public inline const TMap< FString,
FRHAPI_PlayerSession
> *
GetSessionsOrNull
() const
Returns a pointer to Sessions_Optional, if it has been set, otherwise returns nullptr.
public inline void
SetSessions
(TMap< FString,
FRHAPI_PlayerSession
> NewValue)
Sets the value of Sessions_Optional and also sets Sessions_IsSet to true.
public inline void
ClearSessions
()
Clears the value of Sessions_Optional and sets Sessions_IsSet to false.
public inline FDateTime &
GetLastUpdatedTimestamp
()
Gets the value of LastUpdatedTimestamp_Optional, regardless of it having been set.
public inline const FDateTime &
GetLastUpdatedTimestamp
() const
Gets the value of LastUpdatedTimestamp_Optional, regardless of it having been set.
public inline const FDateTime &
GetLastUpdatedTimestamp
(const FDateTime & DefaultValue) const
Gets the value of LastUpdatedTimestamp_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool
GetLastUpdatedTimestamp
(FDateTime & OutValue) const
Fills OutValue with the value of LastUpdatedTimestamp_Optional and returns true if it has been set, otherwise returns false.
public inline FDateTime *
GetLastUpdatedTimestampOrNull
()
Returns a pointer to LastUpdatedTimestamp_Optional, if it has been set, otherwise returns nullptr.
public inline const FDateTime *
GetLastUpdatedTimestampOrNull
() const
Returns a pointer to LastUpdatedTimestamp_Optional, if it has been set, otherwise returns nullptr.
public inline void
SetLastUpdatedTimestamp
(FDateTime NewValue)
Sets the value of LastUpdatedTimestamp_Optional and also sets LastUpdatedTimestamp_IsSet to true.
public inline void
ClearLastUpdatedTimestamp
()
Clears the value of LastUpdatedTimestamp_Optional and sets LastUpdatedTimestamp_IsSet to false.