RHAPI_PlayerPresence
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_PlayerPresence |
struct FRHAPI_PlayerPresence
struct FRHAPI_PlayerPresence : public FRHAPI_ModelSummary
| Members | Descriptions |
|---|---|
public ERHAPI_OnlineStatus Status_Optional | Is the player currently online? |
public bool Status_IsSet | true if Status_Optional has been set to a value |
public FString Message_Optional | Optional custom message to display alongside the user’s online status. |
public bool Message_IsSet | true if Message_Optional has been set to a value |
public FString Platform | Platform the user was online in. |
public FString DisplayName | Player Display Name. |
public TMap< FString, FString > CustomData_Optional | custom fields for the player to update about their presence |
public bool CustomData_IsSet | true if CustomData_Optional has been set to a value |
public int32 PlayerId_Optional | Player ID for the player if it was provided as part of the request. |
public bool PlayerId_IsSet | true if PlayerId_Optional has been set to a value |
public FGuid PlayerUuid | UUID of the player whose presence this represents. |
public bool DoNotDisturb_Optional | Disables notifications and invites. Only set for self or admin. |
public bool DoNotDisturb_IsSet | true if DoNotDisturb_Optional has been set to a value |
public FDateTime LastSeen_Optional | Info about the player the last time they reported their status. Only set for self or admin. |
public bool LastSeen_IsSet | true if LastSeen_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 ERHAPI_OnlineStatus & GetStatus() | Gets the value of Status_Optional, regardless of it having been set. |
public inline const ERHAPI_OnlineStatus & GetStatus() const | Gets the value of Status_Optional, regardless of it having been set. |
public inline const ERHAPI_OnlineStatus & GetStatus(const ERHAPI_OnlineStatus & DefaultValue) const | Gets the value of Status_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetStatus(ERHAPI_OnlineStatus & OutValue) const | Fills OutValue with the value of Status_Optional and returns true if it has been set, otherwise returns false. |
public inline ERHAPI_OnlineStatus * GetStatusOrNull() | Returns a pointer to Status_Optional, if it has been set, otherwise returns nullptr. |
public inline const ERHAPI_OnlineStatus * GetStatusOrNull() const | Returns a pointer to Status_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetStatus(ERHAPI_OnlineStatus NewValue) | Sets the value of Status_Optional and also sets Status_IsSet to true. |
public inline void ClearStatus() | Clears the value of Status_Optional and sets Status_IsSet to false. |
public inline FString & GetMessage() | Gets the value of Message_Optional, regardless of it having been set. |
public inline const FString & GetMessage() const | Gets the value of Message_Optional, regardless of it having been set. |
public inline const FString & GetMessage(const FString & DefaultValue) const | Gets the value of Message_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetMessage(FString & OutValue) const | Fills OutValue with the value of Message_Optional and returns true if it has been set, otherwise returns false. |
public inline FString * GetMessageOrNull() | Returns a pointer to Message_Optional, if it has been set, otherwise returns nullptr. |
public inline const FString * GetMessageOrNull() const | Returns a pointer to Message_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetMessage(FString NewValue) | Sets the value of Message_Optional and also sets Message_IsSet to true. |
public inline void ClearMessage() | Clears the value of Message_Optional and sets Message_IsSet to false. |
public inline bool IsMessageDefaultValue() const | Returns true if Message_Optional is set and matches the default value. |
public inline void SetMessageToDefault() | Sets the value of Message_Optional to its default and also sets Message_IsSet to true. |
public inline FString & GetPlatform() | Gets the value of Platform. |
public inline const FString & GetPlatform() const | Gets the value of Platform. |
public inline void SetPlatform(FString NewValue) | Sets the value of Platform. |
public inline FString & GetDisplayName() | Gets the value of DisplayName. |
public inline const FString & GetDisplayName() const | Gets the value of DisplayName. |
public inline void SetDisplayName(FString NewValue) | Sets the value of DisplayName. |
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 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 bool & GetDoNotDisturb() | Gets the value of DoNotDisturb_Optional, regardless of it having been set. |
public inline const bool & GetDoNotDisturb() const | Gets the value of DoNotDisturb_Optional, regardless of it having been set. |
public inline const bool & GetDoNotDisturb(const bool & DefaultValue) const | Gets the value of DoNotDisturb_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetDoNotDisturb(bool & OutValue) const | Fills OutValue with the value of DoNotDisturb_Optional and returns true if it has been set, otherwise returns false. |
public inline bool * GetDoNotDisturbOrNull() | Returns a pointer to DoNotDisturb_Optional, if it has been set, otherwise returns nullptr. |
public inline const bool * GetDoNotDisturbOrNull() const | Returns a pointer to DoNotDisturb_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetDoNotDisturb(bool NewValue) | Sets the value of DoNotDisturb_Optional and also sets DoNotDisturb_IsSet to true. |
public inline void ClearDoNotDisturb() | Clears the value of DoNotDisturb_Optional and sets DoNotDisturb_IsSet to false. |
public inline bool IsDoNotDisturbDefaultValue() const | Returns true if DoNotDisturb_Optional is set and matches the default value. |
public inline void SetDoNotDisturbToDefault() | Sets the value of DoNotDisturb_Optional to its default and also sets DoNotDisturb_IsSet to true. |
public inline FDateTime & GetLastSeen() | Gets the value of LastSeen_Optional, regardless of it having been set. |
public inline const FDateTime & GetLastSeen() const | Gets the value of LastSeen_Optional, regardless of it having been set. |
public inline const FDateTime & GetLastSeen(const FDateTime & DefaultValue) const | Gets the value of LastSeen_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetLastSeen(FDateTime & OutValue) const | Fills OutValue with the value of LastSeen_Optional and returns true if it has been set, otherwise returns false. |
public inline FDateTime * GetLastSeenOrNull() | Returns a pointer to LastSeen_Optional, if it has been set, otherwise returns nullptr. |
public inline const FDateTime * GetLastSeenOrNull() const | Returns a pointer to LastSeen_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetLastSeen(FDateTime NewValue) | Sets the value of LastSeen_Optional and also sets LastSeen_IsSet to true. |
public inline void ClearLastSeen() | Clears the value of LastSeen_Optional and sets LastSeen_IsSet to false. |
Members
public ERHAPI_OnlineStatus Status_Optional
Is the player currently online?
public bool Status_IsSet
true if Status_Optional has been set to a value
public FString Message_Optional
Optional custom message to display alongside the user’s online status.
public bool Message_IsSet
true if Message_Optional has been set to a value
public FString Platform
Platform the user was online in.
public FString DisplayName
Player Display Name.
public TMap< FString, FString > CustomData_Optional
custom fields for the player to update about their presence
public bool CustomData_IsSet
true if CustomData_Optional has been set to a value
public int32 PlayerId_Optional
Player ID for the player if it was provided as part of the request.
public bool PlayerId_IsSet
true if PlayerId_Optional has been set to a value
public FGuid PlayerUuid
UUID of the player whose presence this represents.
public bool DoNotDisturb_Optional
Disables notifications and invites. Only set for self or admin.
public bool DoNotDisturb_IsSet
true if DoNotDisturb_Optional has been set to a value
public FDateTime LastSeen_Optional
Info about the player the last time they reported their status. Only set for self or admin.
public bool LastSeen_IsSet
true if LastSeen_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
JsonValueData 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
WriterJSON Writer stream to push .
public inline ERHAPI_OnlineStatus & GetStatus()
Gets the value of Status_Optional, regardless of it having been set.
public inline const ERHAPI_OnlineStatus & GetStatus() const
Gets the value of Status_Optional, regardless of it having been set.
public inline const ERHAPI_OnlineStatus & GetStatus(const ERHAPI_OnlineStatus & DefaultValue) const
Gets the value of Status_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetStatus(ERHAPI_OnlineStatus & OutValue) const
Fills OutValue with the value of Status_Optional and returns true if it has been set, otherwise returns false.
public inline ERHAPI_OnlineStatus * GetStatusOrNull()
Returns a pointer to Status_Optional, if it has been set, otherwise returns nullptr.
public inline const ERHAPI_OnlineStatus * GetStatusOrNull() const
Returns a pointer to Status_Optional, if it has been set, otherwise returns nullptr.
public inline void SetStatus(ERHAPI_OnlineStatus NewValue)
Sets the value of Status_Optional and also sets Status_IsSet to true.
public inline void ClearStatus()
Clears the value of Status_Optional and sets Status_IsSet to false.
public inline FString & GetMessage()
Gets the value of Message_Optional, regardless of it having been set.
public inline const FString & GetMessage() const
Gets the value of Message_Optional, regardless of it having been set.
public inline const FString & GetMessage(const FString & DefaultValue) const
Gets the value of Message_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetMessage(FString & OutValue) const
Fills OutValue with the value of Message_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetMessageOrNull()
Returns a pointer to Message_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetMessageOrNull() const
Returns a pointer to Message_Optional, if it has been set, otherwise returns nullptr.
public inline void SetMessage(FString NewValue)
Sets the value of Message_Optional and also sets Message_IsSet to true.
public inline void ClearMessage()
Clears the value of Message_Optional and sets Message_IsSet to false.
public inline bool IsMessageDefaultValue() const
Returns true if Message_Optional is set and matches the default value.
public inline void SetMessageToDefault()
Sets the value of Message_Optional to its default and also sets Message_IsSet to true.
public inline FString & GetPlatform()
Gets the value of Platform.
public inline const FString & GetPlatform() const
Gets the value of Platform.
public inline void SetPlatform(FString NewValue)
Sets the value of Platform.
public inline FString & GetDisplayName()
Gets the value of DisplayName.
public inline const FString & GetDisplayName() const
Gets the value of DisplayName.
public inline void SetDisplayName(FString NewValue)
Sets the value of DisplayName.
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 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 bool & GetDoNotDisturb()
Gets the value of DoNotDisturb_Optional, regardless of it having been set.
public inline const bool & GetDoNotDisturb() const
Gets the value of DoNotDisturb_Optional, regardless of it having been set.
public inline const bool & GetDoNotDisturb(const bool & DefaultValue) const
Gets the value of DoNotDisturb_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetDoNotDisturb(bool & OutValue) const
Fills OutValue with the value of DoNotDisturb_Optional and returns true if it has been set, otherwise returns false.
public inline bool * GetDoNotDisturbOrNull()
Returns a pointer to DoNotDisturb_Optional, if it has been set, otherwise returns nullptr.
public inline const bool * GetDoNotDisturbOrNull() const
Returns a pointer to DoNotDisturb_Optional, if it has been set, otherwise returns nullptr.
public inline void SetDoNotDisturb(bool NewValue)
Sets the value of DoNotDisturb_Optional and also sets DoNotDisturb_IsSet to true.
public inline void ClearDoNotDisturb()
Clears the value of DoNotDisturb_Optional and sets DoNotDisturb_IsSet to false.
public inline bool IsDoNotDisturbDefaultValue() const
Returns true if DoNotDisturb_Optional is set and matches the default value.
public inline void SetDoNotDisturbToDefault()
Sets the value of DoNotDisturb_Optional to its default and also sets DoNotDisturb_IsSet to true.
public inline FDateTime & GetLastSeen()
Gets the value of LastSeen_Optional, regardless of it having been set.
public inline const FDateTime & GetLastSeen() const
Gets the value of LastSeen_Optional, regardless of it having been set.
public inline const FDateTime & GetLastSeen(const FDateTime & DefaultValue) const
Gets the value of LastSeen_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetLastSeen(FDateTime & OutValue) const
Fills OutValue with the value of LastSeen_Optional and returns true if it has been set, otherwise returns false.
public inline FDateTime * GetLastSeenOrNull()
Returns a pointer to LastSeen_Optional, if it has been set, otherwise returns nullptr.
public inline const FDateTime * GetLastSeenOrNull() const
Returns a pointer to LastSeen_Optional, if it has been set, otherwise returns nullptr.
public inline void SetLastSeen(FDateTime NewValue)
Sets the value of LastSeen_Optional and also sets LastSeen_IsSet to true.
public inline void ClearLastSeen()
Clears the value of LastSeen_Optional and sets LastSeen_IsSet to false.