RHAPI_PlayerSession
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_PlayerSession | Information about the sessions of a specific type that a player is currently a member of, or invited to. |
struct FRHAPI_PlayerSession
struct FRHAPI_PlayerSession : public FRHAPI_ModelInformation about the sessions of a specific type that a player is currently a member of, or invited to.
Summary
| Members | Descriptions |
|---|---|
public FString Type | template type |
public TSet< FString > SessionIds_Optional | Sessions the player is currently a part of for this session type, if any. |
public bool SessionIds_IsSet | true if SessionIds_Optional has been set to a value |
public TMap< FString, FRHAPI_PlayerSessionInvite>PendingInvites_Optional | Pending invites, if any, for the current player in this session type. |
public bool PendingInvites_IsSet | true if PendingInvites_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 FString & GetType() | Gets the value of Type. |
public inline const FString & GetType() const | Gets the value of Type. |
public inline void SetType(FString NewValue) | Sets the value of Type. |
public inline TSet< FString > & GetSessionIds() | Gets the value of SessionIds_Optional, regardless of it having been set. |
public inline const TSet< FString > & GetSessionIds() const | Gets the value of SessionIds_Optional, regardless of it having been set. |
public inline const TSet< FString > & GetSessionIds(const TSet< FString > & DefaultValue) const | Gets the value of SessionIds_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetSessionIds(TSet< FString > & OutValue) const | Fills OutValue with the value of SessionIds_Optional and returns true if it has been set, otherwise returns false. |
public inline TSet< FString > * GetSessionIdsOrNull() | Returns a pointer to SessionIds_Optional, if it has been set, otherwise returns nullptr. |
public inline const TSet< FString > * GetSessionIdsOrNull() const | Returns a pointer to SessionIds_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetSessionIds(TSet< FString > NewValue) | Sets the value of SessionIds_Optional and also sets SessionIds_IsSet to true. |
public inline void ClearSessionIds() | Clears the value of SessionIds_Optional and sets SessionIds_IsSet to false. |
public inline TMap< FString, FRHAPI_PlayerSessionInvite> &GetPendingInvites() | Gets the value of PendingInvites_Optional, regardless of it having been set. |
public inline const TMap< FString, FRHAPI_PlayerSessionInvite> &GetPendingInvites() const | Gets the value of PendingInvites_Optional, regardless of it having been set. |
public inline const TMap< FString, FRHAPI_PlayerSessionInvite> &GetPendingInvites(const TMap< FString, FRHAPI_PlayerSessionInvite > & DefaultValue) const | Gets the value of PendingInvites_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetPendingInvites(TMap< FString, FRHAPI_PlayerSessionInvite > & OutValue) const | Fills OutValue with the value of PendingInvites_Optional and returns true if it has been set, otherwise returns false. |
public inline TMap< FString, FRHAPI_PlayerSessionInvite> *GetPendingInvitesOrNull() | Returns a pointer to PendingInvites_Optional, if it has been set, otherwise returns nullptr. |
public inline const TMap< FString, FRHAPI_PlayerSessionInvite> *GetPendingInvitesOrNull() const | Returns a pointer to PendingInvites_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetPendingInvites(TMap< FString, FRHAPI_PlayerSessionInvite > NewValue) | Sets the value of PendingInvites_Optional and also sets PendingInvites_IsSet to true. |
public inline void ClearPendingInvites() | Clears the value of PendingInvites_Optional and sets PendingInvites_IsSet to false. |
Members
public FString Type
template type
#### `public TSet< FString > `[`SessionIds_Optional`](#structFRHAPI__PlayerSession_1a9c4102590c56db484a6c03297468bdc1)
Sessions the player is currently a part of for this session type, if any.
#### `public bool `[`SessionIds_IsSet`](#structFRHAPI__PlayerSession_1a029af7107f40207074d7006a2d9ce0ce)
true if SessionIds_Optional has been set to a value
#### `public TMap< FString, `[`FRHAPI_PlayerSessionInvite`](RHAPI_PlayerSessionInvite.md#structFRHAPI__PlayerSessionInvite)` > `[`PendingInvites_Optional`](#structFRHAPI__PlayerSession_1a6b9bb557a6e0a39b226c15bd02700ad0)
Pending invites, if any, for the current player in this session type.
#### `public bool `[`PendingInvites_IsSet`](#structFRHAPI__PlayerSession_1aba663c2e6b24e60538396ac8a3de5af2)
true if PendingInvites_Optional has been set to a value
#### `public virtual bool `[`FromJson`](#structFRHAPI__PlayerSession_1a8b06f282829c1099c858758efac216dd)`(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__PlayerSession_1a49a41127e076ba0e320cf7307dc44c6b)`(TSharedRef< TJsonWriter<>> & Writer) const`
Writes the data from this object into the specified JSON Writer stream.
Parameters
WriterJSON Writer stream to push .
#### `public inline FString & `[`GetType`](#structFRHAPI__PlayerSession_1a7ff94c4a2229b98fed3c43e0374cb306)`()`
Gets the value of Type.
#### `public inline const FString & `[`GetType`](#structFRHAPI__PlayerSession_1af43796b74a5b4e504393de65bbc87e08)`() const`
Gets the value of Type.
#### `public inline void `[`SetType`](#structFRHAPI__PlayerSession_1ac6cac54fcd54ff70ad8baab8a2702812)`(FString NewValue)`
Sets the value of Type.
#### `public inline TSet< FString > & `[`GetSessionIds`](#structFRHAPI__PlayerSession_1a3492dac1e3143a75d71904b7fe0270b4)`()`
Gets the value of SessionIds_Optional, regardless of it having been set.
#### `public inline const TSet< FString > & `[`GetSessionIds`](#structFRHAPI__PlayerSession_1af7a7654f4962a561c033213a3aef3014)`() const`
Gets the value of SessionIds_Optional, regardless of it having been set.
#### `public inline const TSet< FString > & `[`GetSessionIds`](#structFRHAPI__PlayerSession_1a506de0cb93d4d38cfa8e0c1298d2a0c8)`(const TSet< FString > & DefaultValue) const`
Gets the value of SessionIds_Optional, if it has been set, otherwise it returns DefaultValue.
#### `public inline bool `[`GetSessionIds`](#structFRHAPI__PlayerSession_1afd9fed983cb7f712f928cefaf942cb83)`(TSet< FString > & OutValue) const`
Fills OutValue with the value of SessionIds_Optional and returns true if it has been set, otherwise returns false.
#### `public inline TSet< FString > * `[`GetSessionIdsOrNull`](#structFRHAPI__PlayerSession_1a2714e18100166776d2ffd8042130c212)`()`
Returns a pointer to SessionIds_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const TSet< FString > * `[`GetSessionIdsOrNull`](#structFRHAPI__PlayerSession_1a29a9311b33aaeef061c148f6b2656e09)`() const`
Returns a pointer to SessionIds_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetSessionIds`](#structFRHAPI__PlayerSession_1ae9ac31312fff18ddc97c4472819b3d32)`(TSet< FString > NewValue)`
Sets the value of SessionIds_Optional and also sets SessionIds_IsSet to true.
#### `public inline void `[`ClearSessionIds`](#structFRHAPI__PlayerSession_1a394fa3d1911935ba6e4a2ce6c46ecac7)`()`
Clears the value of SessionIds_Optional and sets SessionIds_IsSet to false.
#### `public inline TMap< FString, `[`FRHAPI_PlayerSessionInvite`](RHAPI_PlayerSessionInvite.md#structFRHAPI__PlayerSessionInvite)` > & `[`GetPendingInvites`](#structFRHAPI__PlayerSession_1a0883615754858962e6e6b8fce19eac66)`()`
Gets the value of PendingInvites_Optional, regardless of it having been set.
#### `public inline const TMap< FString, `[`FRHAPI_PlayerSessionInvite`](RHAPI_PlayerSessionInvite.md#structFRHAPI__PlayerSessionInvite)` > & `[`GetPendingInvites`](#structFRHAPI__PlayerSession_1a16a9e22d7bbd01a609bcf1bc10a4abf0)`() const`
Gets the value of PendingInvites_Optional, regardless of it having been set.
#### `public inline const TMap< FString, `[`FRHAPI_PlayerSessionInvite`](RHAPI_PlayerSessionInvite.md#structFRHAPI__PlayerSessionInvite)` > & `[`GetPendingInvites`](#structFRHAPI__PlayerSession_1a8d1c57d9d0813cf2d8ae6649be140c0b)`(const TMap< FString, `[`FRHAPI_PlayerSessionInvite`](RHAPI_PlayerSessionInvite.md#structFRHAPI__PlayerSessionInvite)` > & DefaultValue) const`
Gets the value of PendingInvites_Optional, if it has been set, otherwise it returns DefaultValue.
#### `public inline bool `[`GetPendingInvites`](#structFRHAPI__PlayerSession_1a971f0a81aeea3d6f7fc501e0ce11b76e)`(TMap< FString, `[`FRHAPI_PlayerSessionInvite`](RHAPI_PlayerSessionInvite.md#structFRHAPI__PlayerSessionInvite)` > & OutValue) const`
Fills OutValue with the value of PendingInvites_Optional and returns true if it has been set, otherwise returns false.
#### `public inline TMap< FString, `[`FRHAPI_PlayerSessionInvite`](RHAPI_PlayerSessionInvite.md#structFRHAPI__PlayerSessionInvite)` > * `[`GetPendingInvitesOrNull`](#structFRHAPI__PlayerSession_1a2a4ddbcedea8f15335c9c7351ce3c0d8)`()`
Returns a pointer to PendingInvites_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const TMap< FString, `[`FRHAPI_PlayerSessionInvite`](RHAPI_PlayerSessionInvite.md#structFRHAPI__PlayerSessionInvite)` > * `[`GetPendingInvitesOrNull`](#structFRHAPI__PlayerSession_1a906a1eb7cdc4ef0f3af1db441b2b6465)`() const`
Returns a pointer to PendingInvites_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetPendingInvites`](#structFRHAPI__PlayerSession_1ace21c7105d0a173a71bebac0af8e4434)`(TMap< FString, `[`FRHAPI_PlayerSessionInvite`](RHAPI_PlayerSessionInvite.md#structFRHAPI__PlayerSessionInvite)` > NewValue)`
Sets the value of PendingInvites_Optional and also sets PendingInvites_IsSet to true.
#### `public inline void `[`ClearPendingInvites`](#structFRHAPI__PlayerSession_1a00bfb8f183bf0c2da022701f403bc692)`()`
Clears the value of PendingInvites_Optional and sets PendingInvites_IsSet to false.