RHAPI_PlayerSessionInvite
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_PlayerSessionInvite | Information about an invite to a session that a player received. |
struct FRHAPI_PlayerSessionInvite
struct FRHAPI_PlayerSessionInvite
: public FRHAPI_Model
Information about an invite to a session that a player received.
Summary
| Members | Descriptions |
|---|---|
public FString SessionId | Session ID for the invite. |
public FGuid InvitingPlayerUuid_Optional | Player who sent the invite. |
public bool InvitingPlayerUuid_IsSet | true if InvitingPlayerUuid_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 & GetSessionId() | Gets the value of SessionId. |
public inline const FString & GetSessionId() const | Gets the value of SessionId. |
public inline void SetSessionId(FString NewValue) | Sets the value of SessionId. |
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. |
Members
public FString SessionId
Session ID for the invite.
public FGuid InvitingPlayerUuid_Optional
Player who sent the invite.
public bool InvitingPlayerUuid_IsSet
true if InvitingPlayerUuid_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 FString & GetSessionId()
Gets the value of SessionId.
public inline const FString & GetSessionId() const
Gets the value of SessionId.
public inline void SetSessionId(FString NewValue)
Sets the value of SessionId.
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.