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_Model

Information 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 TSet< FString > ReservedSessions_Optional	Sessions that the player has a reserved place in, but has not yet been invited.
public bool ReservedSessions_IsSet	true if ReservedSessions_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(const FString & NewValue)	Sets the value of Type.
public inline void SetType(FString && NewValue)	Sets the value of Type using move semantics.
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(const TSet< FString > & NewValue)	Sets the value of SessionIds_Optional and also sets SessionIds_IsSet to true.
public inline void SetSessionIds(TSet< FString > && NewValue)	Sets the value of SessionIds_Optional and also sets SessionIds_IsSet to true using move semantics.
public inline void ClearSessionIds()	Clears the value of SessionIds_Optional and sets SessionIds_IsSet to false.
public inline bool IsSessionIdsSet() const	Checks whether SessionIds_Optional has been set.
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(const TMap< FString, FRHAPI_PlayerSessionInvite > & NewValue)	Sets the value of PendingInvites_Optional and also sets PendingInvites_IsSet to true.
public inline void SetPendingInvites(TMap< FString, FRHAPI_PlayerSessionInvite > && NewValue)	Sets the value of PendingInvites_Optional and also sets PendingInvites_IsSet to true using move semantics.
public inline void ClearPendingInvites()	Clears the value of PendingInvites_Optional and sets PendingInvites_IsSet to false.
public inline bool IsPendingInvitesSet() const	Checks whether PendingInvites_Optional has been set.
public inline TSet< FString > & GetReservedSessions()	Gets the value of ReservedSessions_Optional, regardless of it having been set.
public inline const TSet< FString > & GetReservedSessions() const	Gets the value of ReservedSessions_Optional, regardless of it having been set.
public inline const TSet< FString > & GetReservedSessions(const TSet< FString > & DefaultValue) const	Gets the value of ReservedSessions_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetReservedSessions(TSet< FString > & OutValue) const	Fills OutValue with the value of ReservedSessions_Optional and returns true if it has been set, otherwise returns false.
public inline TSet< FString > * GetReservedSessionsOrNull()	Returns a pointer to ReservedSessions_Optional, if it has been set, otherwise returns nullptr.
public inline const TSet< FString > * GetReservedSessionsOrNull() const	Returns a pointer to ReservedSessions_Optional, if it has been set, otherwise returns nullptr.
public inline void SetReservedSessions(const TSet< FString > & NewValue)	Sets the value of ReservedSessions_Optional and also sets ReservedSessions_IsSet to true.
public inline void SetReservedSessions(TSet< FString > && NewValue)	Sets the value of ReservedSessions_Optional and also sets ReservedSessions_IsSet to true using move semantics.
public inline void ClearReservedSessions()	Clears the value of ReservedSessions_Optional and sets ReservedSessions_IsSet to false.
public inline bool IsReservedSessionsSet() const	Checks whether ReservedSessions_Optional has been set.

Members

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 TSet< FString > ReservedSessions_Optional

Sessions that the player has a reserved place in, but has not yet been invited.

public bool ReservedSessions_IsSet

true if ReservedSessions_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 FString & GetType()

Gets the value of Type.

public inline const FString & GetType() const

Gets the value of Type.

public inline void SetType(const FString & NewValue)

Sets the value of Type.

public inline void SetType(FString && NewValue)

Sets the value of Type using move semantics.

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(const TSet< FString > & NewValue)

Sets the value of SessionIds_Optional and also sets SessionIds_IsSet to true.

public inline void SetSessionIds(TSet< FString > && NewValue)

Sets the value of SessionIds_Optional and also sets SessionIds_IsSet to true using move semantics.

public inline void ClearSessionIds()

Clears the value of SessionIds_Optional and sets SessionIds_IsSet to false.

public inline bool IsSessionIdsSet() const

Checks whether SessionIds_Optional has been set.

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(const TMap< FString, FRHAPI_PlayerSessionInvite > & NewValue)

Sets the value of PendingInvites_Optional and also sets PendingInvites_IsSet to true.

public inline void SetPendingInvites(TMap< FString, FRHAPI_PlayerSessionInvite > && NewValue)

Sets the value of PendingInvites_Optional and also sets PendingInvites_IsSet to true using move semantics.

public inline void ClearPendingInvites()

Clears the value of PendingInvites_Optional and sets PendingInvites_IsSet to false.

public inline bool IsPendingInvitesSet() const

Checks whether PendingInvites_Optional has been set.

public inline TSet< FString > & GetReservedSessions()

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

public inline const TSet< FString > & GetReservedSessions() const

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

public inline const TSet< FString > & GetReservedSessions(const TSet< FString > & DefaultValue) const

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

public inline bool GetReservedSessions(TSet< FString > & OutValue) const

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

public inline TSet< FString > * GetReservedSessionsOrNull()

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

public inline const TSet< FString > * GetReservedSessionsOrNull() const

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

public inline void SetReservedSessions(const TSet< FString > & NewValue)

Sets the value of ReservedSessions_Optional and also sets ReservedSessions_IsSet to true.

public inline void SetReservedSessions(TSet< FString > && NewValue)

Sets the value of ReservedSessions_Optional and also sets ReservedSessions_IsSet to true using move semantics.

public inline void ClearReservedSessions()

Clears the value of ReservedSessions_Optional and sets ReservedSessions_IsSet to false.

public inline bool IsReservedSessionsSet() const

Checks whether ReservedSessions_Optional has been set.