RHAPI_PlayerSessions
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
struct FRHAPI_PlayerSessions
: public FRHAPI_Model
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`](#structFRHAPI__PlayerSessions_1a65be3a391fe50890ec37f01d3ac18e0d)
true if Sessions_Optional has been set to a value
#### `public FDateTime `[`LastUpdatedTimestamp_Optional`](#structFRHAPI__PlayerSessions_1a1421f6c78dbccd3f16e0d373eb93a8c0)
Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.
#### `public bool `[`LastUpdatedTimestamp_IsSet`](#structFRHAPI__PlayerSessions_1acb79f047f9fe82dffe5290d34aa4a750)
true if LastUpdatedTimestamp_Optional has been set to a value
#### `public virtual bool `[`FromJson`](#structFRHAPI__PlayerSessions_1a1cbd1f3f619a56d77b46507a8038e523)`(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`](#structFRHAPI__PlayerSessions_1a05d62fde50431853d32a40cf9a32ac0a)`(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`](RHAPI_PlayerSession.md#structFRHAPI__PlayerSession)` > & `[`GetSessions`](#structFRHAPI__PlayerSessions_1aa6986ffaa36620a5719a17f589d79f4b)`()`
Gets the value of Sessions_Optional, regardless of it having been set.
#### `public inline const TMap< FString, `[`FRHAPI_PlayerSession`](RHAPI_PlayerSession.md#structFRHAPI__PlayerSession)` > & `[`GetSessions`](#structFRHAPI__PlayerSessions_1a10dd3287bdd0c41e99f7ced2b7dc7507)`() const`
Gets the value of Sessions_Optional, regardless of it having been set.
#### `public inline const TMap< FString, `[`FRHAPI_PlayerSession`](RHAPI_PlayerSession.md#structFRHAPI__PlayerSession)` > & `[`GetSessions`](#structFRHAPI__PlayerSessions_1a208cd475cdba50f450d9f233ca3d919c)`(const TMap< FString, `[`FRHAPI_PlayerSession`](RHAPI_PlayerSession.md#structFRHAPI__PlayerSession)` > & DefaultValue) const`
Gets the value of Sessions_Optional, if it has been set, otherwise it returns DefaultValue.
#### `public inline bool `[`GetSessions`](#structFRHAPI__PlayerSessions_1ac3bd1f379b91636f171e1fa994082069)`(TMap< FString, `[`FRHAPI_PlayerSession`](RHAPI_PlayerSession.md#structFRHAPI__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`](RHAPI_PlayerSession.md#structFRHAPI__PlayerSession)` > * `[`GetSessionsOrNull`](#structFRHAPI__PlayerSessions_1adfb154252949cd0d9a80807702554686)`()`
Returns a pointer to Sessions_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const TMap< FString, `[`FRHAPI_PlayerSession`](RHAPI_PlayerSession.md#structFRHAPI__PlayerSession)` > * `[`GetSessionsOrNull`](#structFRHAPI__PlayerSessions_1a186fdf0aa80993ab97e5e51d2e1e1a0d)`() const`
Returns a pointer to Sessions_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetSessions`](#structFRHAPI__PlayerSessions_1ae3d490fea8b14a2b3d05310743ea6f09)`(TMap< FString, `[`FRHAPI_PlayerSession`](RHAPI_PlayerSession.md#structFRHAPI__PlayerSession)` > NewValue)`
Sets the value of Sessions_Optional and also sets Sessions_IsSet to true.
#### `public inline void `[`ClearSessions`](#structFRHAPI__PlayerSessions_1a11f4d310ceb782cf2b7912bb7d853910)`()`
Clears the value of Sessions_Optional and sets Sessions_IsSet to false.
#### `public inline FDateTime & `[`GetLastUpdatedTimestamp`](#structFRHAPI__PlayerSessions_1a721f38d6641e78b9930b400bf9112ee3)`()`
Gets the value of LastUpdatedTimestamp_Optional, regardless of it having been set.
#### `public inline const FDateTime & `[`GetLastUpdatedTimestamp`](#structFRHAPI__PlayerSessions_1a3cd547cd72593da70e58358cce255a72)`() const`
Gets the value of LastUpdatedTimestamp_Optional, regardless of it having been set.
#### `public inline const FDateTime & `[`GetLastUpdatedTimestamp`](#structFRHAPI__PlayerSessions_1a261728fd87870f4f529146642b413fe7)`(const FDateTime & DefaultValue) const`
Gets the value of LastUpdatedTimestamp_Optional, if it has been set, otherwise it returns DefaultValue.
#### `public inline bool `[`GetLastUpdatedTimestamp`](#structFRHAPI__PlayerSessions_1af64484360e07e3dbf4c4477b33ac6523)`(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`](#structFRHAPI__PlayerSessions_1a33739c3ea2556fdb10a6183583fe3971)`()`
Returns a pointer to LastUpdatedTimestamp_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const FDateTime * `[`GetLastUpdatedTimestampOrNull`](#structFRHAPI__PlayerSessions_1a2560de427b581886661de0c0d9a393bb)`() const`
Returns a pointer to LastUpdatedTimestamp_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetLastUpdatedTimestamp`](#structFRHAPI__PlayerSessions_1a890896cdf1ba717ef7c12b11f7a540ba)`(FDateTime NewValue)`
Sets the value of LastUpdatedTimestamp_Optional and also sets LastUpdatedTimestamp_IsSet to true.
#### `public inline void `[`ClearLastUpdatedTimestamp`](#structFRHAPI__PlayerSessions_1a158685391d310a57b456883520d177d0)`()`
Clears the value of LastUpdatedTimestamp_Optional and sets LastUpdatedTimestamp_IsSet to false.