RHAPI_PlayerPresenceUpdateSelf

Summary

Members	Descriptions
struct FRHAPI_PlayerPresenceUpdateSelf

struct FRHAPI_PlayerPresenceUpdateSelf

struct FRHAPI_PlayerPresenceUpdateSelf
  : public FRHAPI_Model

Summary

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. Leaving this unset will not change the value.
public bool Message_IsSet	true if Message_Optional has been set to a value
public bool DoNotDisturb_Optional	Disables notifications and invites. Leaving this unset will not change the value.
public bool DoNotDisturb_IsSet	true if DoNotDisturb_Optional has been set to a value
public TMap< FString, FString > CustomData_Optional	custom fields for the player to update about their presence. Custom data with a null value will be removed
public bool CustomData_IsSet	true if CustomData_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 & 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 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.

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. Leaving this unset will not change the value.

public bool Message_IsSet

true if Message_Optional has been set to a value

public bool DoNotDisturb_Optional

Disables notifications and invites. Leaving this unset will not change the value.

public bool DoNotDisturb_IsSet

true if DoNotDisturb_Optional has been set to a value

public TMap< FString, FString > CustomData_Optional

custom fields for the player to update about their presence. Custom data with a null value will be removed

public bool CustomData_IsSet

true if CustomData_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 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 & 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 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.