RHAPI_SessionPlayer

Summary

Members	Descriptions
struct FRHAPI_SessionPlayer	A player resource in a session.

struct FRHAPI_SessionPlayer

struct FRHAPI_SessionPlayer
  : public FRHAPI_Model

A player resource in a session.

Summary

Members	Descriptions
public int32 PlayerId_Optional	Legacy id for this player.
public bool PlayerId_IsSet	true if PlayerId_Optional has been set to a value
public FGuid PlayerUuid	UUID for this player.
public ERHAPI_SessionPlayerStatus Status	Status of the player in the session.
public FGuid InvitingPlayerUuid_Optional	If the player is only a pending invite, this is the player that requested the invite.
public bool InvitingPlayerUuid_IsSet	true if InvitingPlayerUuid_Optional has been set to a value
public TMap< FString, FString > CustomData_Optional	player-defined custom data
public bool CustomData_IsSet	true if CustomData_Optional has been set to a value
public FString Version_Optional	Product Client Version number. Used for compatibility checking with other players and instances.
public bool Version_IsSet	true if Version_Optional has been set to a value
public FRHAPI_ClientSettings ClientSettings_Optional
public bool ClientSettings_IsSet	true if ClientSettings_Optional has been set to a value
public FRHAPI_CrossplayPreferences CrossplayPreferences_Optional
public bool CrossplayPreferences_IsSet	true if CrossplayPreferences_Optional has been set to a value
public FDateTime Invited_Optional	Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.
public bool Invited_IsSet	true if Invited_Optional has been set to a value
public FDateTime Joined_Optional	Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.
public bool Joined_IsSet	true if Joined_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 int32 & GetPlayerId()	Gets the value of PlayerId_Optional, regardless of it having been set.
public inline const int32 & GetPlayerId() const	Gets the value of PlayerId_Optional, regardless of it having been set.
public inline const int32 & GetPlayerId(const int32 & DefaultValue) const	Gets the value of PlayerId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetPlayerId(int32 & OutValue) const	Fills OutValue with the value of PlayerId_Optional and returns true if it has been set, otherwise returns false.
public inline int32 * GetPlayerIdOrNull()	Returns a pointer to PlayerId_Optional, if it has been set, otherwise returns nullptr.
public inline const int32 * GetPlayerIdOrNull() const	Returns a pointer to PlayerId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetPlayerId(int32 NewValue)	Sets the value of PlayerId_Optional and also sets PlayerId_IsSet to true.
public inline void ClearPlayerId()	Clears the value of PlayerId_Optional and sets PlayerId_IsSet to false.
public inline bool IsPlayerIdDefaultValue() const	Returns true if PlayerId_Optional is set and matches the default value.
public inline void SetPlayerIdToDefault()	Sets the value of PlayerId_Optional to its default and also sets PlayerId_IsSet to true.
public inline FGuid & GetPlayerUuid()	Gets the value of PlayerUuid.
public inline const FGuid & GetPlayerUuid() const	Gets the value of PlayerUuid.
public inline void SetPlayerUuid(FGuid NewValue)	Sets the value of PlayerUuid.
public inline ERHAPI_SessionPlayerStatus & GetStatus()	Gets the value of Status.
public inline const ERHAPI_SessionPlayerStatus & GetStatus() const	Gets the value of Status.
public inline void SetStatus(ERHAPI_SessionPlayerStatus NewValue)	Sets the value of Status.
public inline FGuid & GetInvitingPlayerUuid()	Gets the value of InvitingPlayerUuid_Optional, regardless of it having been set.
public inline const FGuid & GetInvitingPlayerUuid() const	Gets the value of InvitingPlayerUuid_Optional, regardless of it having been set.
public inline const FGuid & GetInvitingPlayerUuid(const FGuid & DefaultValue) const	Gets the value of InvitingPlayerUuid_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetInvitingPlayerUuid(FGuid & OutValue) const	Fills OutValue with the value of InvitingPlayerUuid_Optional and returns true if it has been set, otherwise returns false.
public inline FGuid * GetInvitingPlayerUuidOrNull()	Returns a pointer to InvitingPlayerUuid_Optional, if it has been set, otherwise returns nullptr.
public inline const FGuid * GetInvitingPlayerUuidOrNull() const	Returns a pointer to InvitingPlayerUuid_Optional, if it has been set, otherwise returns nullptr.
public inline void SetInvitingPlayerUuid(FGuid NewValue)	Sets the value of InvitingPlayerUuid_Optional and also sets InvitingPlayerUuid_IsSet to true.
public inline void ClearInvitingPlayerUuid()	Clears the value of InvitingPlayerUuid_Optional and sets InvitingPlayerUuid_IsSet to false.
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 FString & GetVersion()	Gets the value of Version_Optional, regardless of it having been set.
public inline const FString & GetVersion() const	Gets the value of Version_Optional, regardless of it having been set.
public inline const FString & GetVersion(const FString & DefaultValue) const	Gets the value of Version_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetVersion(FString & OutValue) const	Fills OutValue with the value of Version_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetVersionOrNull()	Returns a pointer to Version_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetVersionOrNull() const	Returns a pointer to Version_Optional, if it has been set, otherwise returns nullptr.
public inline void SetVersion(FString NewValue)	Sets the value of Version_Optional and also sets Version_IsSet to true.
public inline void ClearVersion()	Clears the value of Version_Optional and sets Version_IsSet to false.
public inline FRHAPI_ClientSettings&GetClientSettings()	Gets the value of ClientSettings_Optional, regardless of it having been set.
public inline const FRHAPI_ClientSettings&GetClientSettings() const	Gets the value of ClientSettings_Optional, regardless of it having been set.
public inline const FRHAPI_ClientSettings&GetClientSettings(const FRHAPI_ClientSettings & DefaultValue) const	Gets the value of ClientSettings_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetClientSettings(FRHAPI_ClientSettings & OutValue) const	Fills OutValue with the value of ClientSettings_Optional and returns true if it has been set, otherwise returns false.
public inline FRHAPI_ClientSettings*GetClientSettingsOrNull()	Returns a pointer to ClientSettings_Optional, if it has been set, otherwise returns nullptr.
public inline const FRHAPI_ClientSettings*GetClientSettingsOrNull() const	Returns a pointer to ClientSettings_Optional, if it has been set, otherwise returns nullptr.
public inline void SetClientSettings(FRHAPI_ClientSettings NewValue)	Sets the value of ClientSettings_Optional and also sets ClientSettings_IsSet to true.
public inline void ClearClientSettings()	Clears the value of ClientSettings_Optional and sets ClientSettings_IsSet to false.
public inline FRHAPI_CrossplayPreferences&GetCrossplayPreferences()	Gets the value of CrossplayPreferences_Optional, regardless of it having been set.
public inline const FRHAPI_CrossplayPreferences&GetCrossplayPreferences() const	Gets the value of CrossplayPreferences_Optional, regardless of it having been set.
public inline const FRHAPI_CrossplayPreferences&GetCrossplayPreferences(const FRHAPI_CrossplayPreferences & DefaultValue) const	Gets the value of CrossplayPreferences_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetCrossplayPreferences(FRHAPI_CrossplayPreferences & OutValue) const	Fills OutValue with the value of CrossplayPreferences_Optional and returns true if it has been set, otherwise returns false.
public inline FRHAPI_CrossplayPreferences*GetCrossplayPreferencesOrNull()	Returns a pointer to CrossplayPreferences_Optional, if it has been set, otherwise returns nullptr.
public inline const FRHAPI_CrossplayPreferences*GetCrossplayPreferencesOrNull() const	Returns a pointer to CrossplayPreferences_Optional, if it has been set, otherwise returns nullptr.
public inline void SetCrossplayPreferences(FRHAPI_CrossplayPreferences NewValue)	Sets the value of CrossplayPreferences_Optional and also sets CrossplayPreferences_IsSet to true.
public inline void ClearCrossplayPreferences()	Clears the value of CrossplayPreferences_Optional and sets CrossplayPreferences_IsSet to false.
public inline FDateTime & GetInvited()	Gets the value of Invited_Optional, regardless of it having been set.
public inline const FDateTime & GetInvited() const	Gets the value of Invited_Optional, regardless of it having been set.
public inline const FDateTime & GetInvited(const FDateTime & DefaultValue) const	Gets the value of Invited_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetInvited(FDateTime & OutValue) const	Fills OutValue with the value of Invited_Optional and returns true if it has been set, otherwise returns false.
public inline FDateTime * GetInvitedOrNull()	Returns a pointer to Invited_Optional, if it has been set, otherwise returns nullptr.
public inline const FDateTime * GetInvitedOrNull() const	Returns a pointer to Invited_Optional, if it has been set, otherwise returns nullptr.
public inline void SetInvited(FDateTime NewValue)	Sets the value of Invited_Optional and also sets Invited_IsSet to true.
public inline void ClearInvited()	Clears the value of Invited_Optional and sets Invited_IsSet to false.
public inline FDateTime & GetJoined()	Gets the value of Joined_Optional, regardless of it having been set.
public inline const FDateTime & GetJoined() const	Gets the value of Joined_Optional, regardless of it having been set.
public inline const FDateTime & GetJoined(const FDateTime & DefaultValue) const	Gets the value of Joined_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetJoined(FDateTime & OutValue) const	Fills OutValue with the value of Joined_Optional and returns true if it has been set, otherwise returns false.
public inline FDateTime * GetJoinedOrNull()	Returns a pointer to Joined_Optional, if it has been set, otherwise returns nullptr.
public inline const FDateTime * GetJoinedOrNull() const	Returns a pointer to Joined_Optional, if it has been set, otherwise returns nullptr.
public inline void SetJoined(FDateTime NewValue)	Sets the value of Joined_Optional and also sets Joined_IsSet to true.
public inline void ClearJoined()	Clears the value of Joined_Optional and sets Joined_IsSet to false.

Members

public int32 PlayerId_Optional

Legacy id for this player.

public bool PlayerId_IsSet

true if PlayerId_Optional has been set to a value

public FGuid PlayerUuid

UUID for this player.

public ERHAPI_SessionPlayerStatus Status

Status of the player in the session.

public FGuid InvitingPlayerUuid_Optional

If the player is only a pending invite, this is the player that requested the invite.

public bool InvitingPlayerUuid_IsSet

true if InvitingPlayerUuid_Optional has been set to a value

public TMap< FString, FString > CustomData_Optional

player-defined custom data

public bool CustomData_IsSet

true if CustomData_Optional has been set to a value

public FString Version_Optional

Product Client Version number. Used for compatibility checking with other players and instances.

public bool Version_IsSet

true if Version_Optional has been set to a value

public FRHAPI_ClientSettings ClientSettings_Optional

public bool ClientSettings_IsSet

true if ClientSettings_Optional has been set to a value

public FRHAPI_CrossplayPreferences CrossplayPreferences_Optional

public bool CrossplayPreferences_IsSet

true if CrossplayPreferences_Optional has been set to a value

public FDateTime Invited_Optional

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

public bool Invited_IsSet

true if Invited_Optional has been set to a value

public FDateTime Joined_Optional

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

public bool Joined_IsSet

true if Joined_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 int32 & GetPlayerId()

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

public inline const int32 & GetPlayerId() const

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

public inline const int32 & GetPlayerId(const int32 & DefaultValue) const

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

public inline bool GetPlayerId(int32 & OutValue) const

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

public inline int32 * GetPlayerIdOrNull()

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

public inline const int32 * GetPlayerIdOrNull() const

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

public inline void SetPlayerId(int32 NewValue)

Sets the value of PlayerId_Optional and also sets PlayerId_IsSet to true.

public inline void ClearPlayerId()

Clears the value of PlayerId_Optional and sets PlayerId_IsSet to false.

public inline bool IsPlayerIdDefaultValue() const

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

public inline void SetPlayerIdToDefault()

Sets the value of PlayerId_Optional to its default and also sets PlayerId_IsSet to true.

public inline FGuid & GetPlayerUuid()

Gets the value of PlayerUuid.

public inline const FGuid & GetPlayerUuid() const

Gets the value of PlayerUuid.

public inline void SetPlayerUuid(FGuid NewValue)

Sets the value of PlayerUuid.

public inline ERHAPI_SessionPlayerStatus & GetStatus()

Gets the value of Status.

public inline const ERHAPI_SessionPlayerStatus & GetStatus() const

Gets the value of Status.

public inline void SetStatus(ERHAPI_SessionPlayerStatus NewValue)

Sets the value of Status.

public inline FGuid & GetInvitingPlayerUuid()

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

public inline const FGuid & GetInvitingPlayerUuid() const

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

public inline const FGuid & GetInvitingPlayerUuid(const FGuid & DefaultValue) const

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

public inline bool GetInvitingPlayerUuid(FGuid & OutValue) const

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

public inline FGuid * GetInvitingPlayerUuidOrNull()

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

public inline const FGuid * GetInvitingPlayerUuidOrNull() const

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

public inline void SetInvitingPlayerUuid(FGuid NewValue)

Sets the value of InvitingPlayerUuid_Optional and also sets InvitingPlayerUuid_IsSet to true.

public inline void ClearInvitingPlayerUuid()

Clears the value of InvitingPlayerUuid_Optional and sets InvitingPlayerUuid_IsSet to false.

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 FString & GetVersion()

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

public inline const FString & GetVersion() const

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

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

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

public inline bool GetVersion(FString & OutValue) const

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

public inline FString * GetVersionOrNull()

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

public inline const FString * GetVersionOrNull() const

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

public inline void SetVersion(FString NewValue)

Sets the value of Version_Optional and also sets Version_IsSet to true.

public inline void ClearVersion()

Clears the value of Version_Optional and sets Version_IsSet to false.

public inline FRHAPI_ClientSettings&GetClientSettings()

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

public inline const FRHAPI_ClientSettings&GetClientSettings() const

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

public inline const FRHAPI_ClientSettings&GetClientSettings(const FRHAPI_ClientSettings & DefaultValue) const

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

public inline bool GetClientSettings(FRHAPI_ClientSettings & OutValue) const

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

public inline FRHAPI_ClientSettings*GetClientSettingsOrNull()

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

public inline const FRHAPI_ClientSettings*GetClientSettingsOrNull() const

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

public inline void SetClientSettings(FRHAPI_ClientSettings NewValue)

Sets the value of ClientSettings_Optional and also sets ClientSettings_IsSet to true.

public inline void ClearClientSettings()

Clears the value of ClientSettings_Optional and sets ClientSettings_IsSet to false.

public inline FRHAPI_CrossplayPreferences&GetCrossplayPreferences()

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

public inline const FRHAPI_CrossplayPreferences&GetCrossplayPreferences() const

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

public inline const FRHAPI_CrossplayPreferences&GetCrossplayPreferences(const FRHAPI_CrossplayPreferences & DefaultValue) const

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

public inline bool GetCrossplayPreferences(FRHAPI_CrossplayPreferences & OutValue) const

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

public inline FRHAPI_CrossplayPreferences*GetCrossplayPreferencesOrNull()

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

public inline const FRHAPI_CrossplayPreferences*GetCrossplayPreferencesOrNull() const

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

public inline void SetCrossplayPreferences(FRHAPI_CrossplayPreferences NewValue)

Sets the value of CrossplayPreferences_Optional and also sets CrossplayPreferences_IsSet to true.

public inline void ClearCrossplayPreferences()

Clears the value of CrossplayPreferences_Optional and sets CrossplayPreferences_IsSet to false.

public inline FDateTime & GetInvited()

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

public inline const FDateTime & GetInvited() const

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

public inline const FDateTime & GetInvited(const FDateTime & DefaultValue) const

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

public inline bool GetInvited(FDateTime & OutValue) const

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

public inline FDateTime * GetInvitedOrNull()

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

public inline const FDateTime * GetInvitedOrNull() const

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

public inline void SetInvited(FDateTime NewValue)

Sets the value of Invited_Optional and also sets Invited_IsSet to true.

public inline void ClearInvited()

Clears the value of Invited_Optional and sets Invited_IsSet to false.

public inline FDateTime & GetJoined()

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

public inline const FDateTime & GetJoined() const

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

public inline const FDateTime & GetJoined(const FDateTime & DefaultValue) const

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

public inline bool GetJoined(FDateTime & OutValue) const

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

public inline FDateTime * GetJoinedOrNull()

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

public inline const FDateTime * GetJoinedOrNull() const

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

public inline void SetJoined(FDateTime NewValue)

Sets the value of Joined_Optional and also sets Joined_IsSet to true.

public inline void ClearJoined()

Clears the value of Joined_Optional and sets Joined_IsSet to false.