RHAPI_CreateOrJoinRequest

Summary

Members	Descriptions
struct FRHAPI_CreateOrJoinRequest	A request body for a player to join a session.

struct FRHAPI_CreateOrJoinRequest

struct FRHAPI_CreateOrJoinRequest
  : public FRHAPI_Model

A request body for a player to join a session.

Summary

Members	Descriptions
public FString ClientVersion	String representation of semver for client.
public FRHAPI_ClientSettings ClientSettings	Which input type the client is using. Platform is now gotten from authorization claims, and will overwrite the platform passed here.
public FRHAPI_CrossplayPreferences CrossplayPreferences_Optional	Client's desired crossplay settings to determine which other clients it can play with. If not defined, assumed to be as permissive as possible.
public bool CrossplayPreferences_IsSet	true if CrossplayPreferences_Optional has been set to a value
public FString SessionType	Type of session client is creating or joining.
public FString RegionId_Optional	Preferred region for the instance and match to take place in.
public bool RegionId_IsSet	true if RegionId_Optional has been set to a value
public FRHAPI_SelfSessionPlayerUpdateRequest Player_Optional	Optional information about player in order to join the new/existing session. V2 version of CreateOrJoin will require this.
public bool Player_IsSet	true if Player_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 & GetClientVersion()	Gets the value of ClientVersion.
public inline const FString & GetClientVersion() const	Gets the value of ClientVersion.
public inline void SetClientVersion(const FString & NewValue)	Sets the value of ClientVersion.
public inline void SetClientVersion(FString && NewValue)	Sets the value of ClientVersion using move semantics.
public inline FRHAPI_ClientSettings&GetClientSettings()	Gets the value of ClientSettings.
public inline const FRHAPI_ClientSettings&GetClientSettings() const	Gets the value of ClientSettings.
public inline void SetClientSettings(const FRHAPI_ClientSettings & NewValue)	Sets the value of ClientSettings.
public inline void SetClientSettings(FRHAPI_ClientSettings && NewValue)	Sets the value of ClientSettings using move semantics.
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(const FRHAPI_CrossplayPreferences & NewValue)	Sets the value of CrossplayPreferences_Optional and also sets CrossplayPreferences_IsSet to true.
public inline void SetCrossplayPreferences(FRHAPI_CrossplayPreferences && NewValue)	Sets the value of CrossplayPreferences_Optional and also sets CrossplayPreferences_IsSet to true using move semantics.
public inline void ClearCrossplayPreferences()	Clears the value of CrossplayPreferences_Optional and sets CrossplayPreferences_IsSet to false.
public inline bool IsCrossplayPreferencesSet() const	Checks whether CrossplayPreferences_Optional has been set.
public inline FString & GetSessionType()	Gets the value of SessionType.
public inline const FString & GetSessionType() const	Gets the value of SessionType.
public inline void SetSessionType(const FString & NewValue)	Sets the value of SessionType.
public inline void SetSessionType(FString && NewValue)	Sets the value of SessionType using move semantics.
public inline FString & GetRegionId()	Gets the value of RegionId_Optional, regardless of it having been set.
public inline const FString & GetRegionId() const	Gets the value of RegionId_Optional, regardless of it having been set.
public inline const FString & GetRegionId(const FString & DefaultValue) const	Gets the value of RegionId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetRegionId(FString & OutValue) const	Fills OutValue with the value of RegionId_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetRegionIdOrNull()	Returns a pointer to RegionId_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetRegionIdOrNull() const	Returns a pointer to RegionId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetRegionId(const FString & NewValue)	Sets the value of RegionId_Optional and also sets RegionId_IsSet to true.
public inline void SetRegionId(FString && NewValue)	Sets the value of RegionId_Optional and also sets RegionId_IsSet to true using move semantics.
public inline void ClearRegionId()	Clears the value of RegionId_Optional and sets RegionId_IsSet to false.
public inline bool IsRegionIdSet() const	Checks whether RegionId_Optional has been set.
public inline FRHAPI_SelfSessionPlayerUpdateRequest&GetPlayer()	Gets the value of Player_Optional, regardless of it having been set.
public inline const FRHAPI_SelfSessionPlayerUpdateRequest&GetPlayer() const	Gets the value of Player_Optional, regardless of it having been set.
public inline const FRHAPI_SelfSessionPlayerUpdateRequest&GetPlayer(const FRHAPI_SelfSessionPlayerUpdateRequest & DefaultValue) const	Gets the value of Player_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetPlayer(FRHAPI_SelfSessionPlayerUpdateRequest & OutValue) const	Fills OutValue with the value of Player_Optional and returns true if it has been set, otherwise returns false.
public inline FRHAPI_SelfSessionPlayerUpdateRequest*GetPlayerOrNull()	Returns a pointer to Player_Optional, if it has been set, otherwise returns nullptr.
public inline const FRHAPI_SelfSessionPlayerUpdateRequest*GetPlayerOrNull() const	Returns a pointer to Player_Optional, if it has been set, otherwise returns nullptr.
public inline void SetPlayer(const FRHAPI_SelfSessionPlayerUpdateRequest & NewValue)	Sets the value of Player_Optional and also sets Player_IsSet to true.
public inline void SetPlayer(FRHAPI_SelfSessionPlayerUpdateRequest && NewValue)	Sets the value of Player_Optional and also sets Player_IsSet to true using move semantics.
public inline void ClearPlayer()	Clears the value of Player_Optional and sets Player_IsSet to false.
public inline bool IsPlayerSet() const	Checks whether Player_Optional has been set.

Members

public FString ClientVersion

String representation of semver for client.

public FRHAPI_ClientSettings ClientSettings

Which input type the client is using. Platform is now gotten from authorization claims, and will overwrite the platform passed here.

public FRHAPI_CrossplayPreferences CrossplayPreferences_Optional

Client's desired crossplay settings to determine which other clients it can play with. If not defined, assumed to be as permissive as possible.

public bool CrossplayPreferences_IsSet

true if CrossplayPreferences_Optional has been set to a value

public FString SessionType

Type of session client is creating or joining.

public FString RegionId_Optional

Preferred region for the instance and match to take place in.

public bool RegionId_IsSet

true if RegionId_Optional has been set to a value

public FRHAPI_SelfSessionPlayerUpdateRequest Player_Optional

Optional information about player in order to join the new/existing session. V2 version of CreateOrJoin will require this.

public bool Player_IsSet

true if Player_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 & GetClientVersion()

Gets the value of ClientVersion.

public inline const FString & GetClientVersion() const

Gets the value of ClientVersion.

public inline void SetClientVersion(const FString & NewValue)

Sets the value of ClientVersion.

public inline void SetClientVersion(FString && NewValue)

Sets the value of ClientVersion using move semantics.

public inline FRHAPI_ClientSettings&GetClientSettings()

Gets the value of ClientSettings.

public inline const FRHAPI_ClientSettings&GetClientSettings() const

Gets the value of ClientSettings.

public inline void SetClientSettings(const FRHAPI_ClientSettings & NewValue)

Sets the value of ClientSettings.

public inline void SetClientSettings(FRHAPI_ClientSettings && NewValue)

Sets the value of ClientSettings using move semantics.

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

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

public inline void SetCrossplayPreferences(FRHAPI_CrossplayPreferences && NewValue)

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

public inline void ClearCrossplayPreferences()

Clears the value of CrossplayPreferences_Optional and sets CrossplayPreferences_IsSet to false.

public inline bool IsCrossplayPreferencesSet() const

Checks whether CrossplayPreferences_Optional has been set.

public inline FString & GetSessionType()

Gets the value of SessionType.

public inline const FString & GetSessionType() const

Gets the value of SessionType.

public inline void SetSessionType(const FString & NewValue)

Sets the value of SessionType.

public inline void SetSessionType(FString && NewValue)

Sets the value of SessionType using move semantics.

public inline FString & GetRegionId()

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

public inline const FString & GetRegionId() const

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

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

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

public inline bool GetRegionId(FString & OutValue) const

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

public inline FString * GetRegionIdOrNull()

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

public inline const FString * GetRegionIdOrNull() const

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

public inline void SetRegionId(const FString & NewValue)

Sets the value of RegionId_Optional and also sets RegionId_IsSet to true.

public inline void SetRegionId(FString && NewValue)

Sets the value of RegionId_Optional and also sets RegionId_IsSet to true using move semantics.

public inline void ClearRegionId()

Clears the value of RegionId_Optional and sets RegionId_IsSet to false.

public inline bool IsRegionIdSet() const

Checks whether RegionId_Optional has been set.

public inline FRHAPI_SelfSessionPlayerUpdateRequest&GetPlayer()

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

public inline const FRHAPI_SelfSessionPlayerUpdateRequest&GetPlayer() const

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

public inline const FRHAPI_SelfSessionPlayerUpdateRequest&GetPlayer(const FRHAPI_SelfSessionPlayerUpdateRequest & DefaultValue) const

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

public inline bool GetPlayer(FRHAPI_SelfSessionPlayerUpdateRequest & OutValue) const

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

public inline FRHAPI_SelfSessionPlayerUpdateRequest*GetPlayerOrNull()

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

public inline const FRHAPI_SelfSessionPlayerUpdateRequest*GetPlayerOrNull() const

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

public inline void SetPlayer(const FRHAPI_SelfSessionPlayerUpdateRequest & NewValue)

Sets the value of Player_Optional and also sets Player_IsSet to true.

public inline void SetPlayer(FRHAPI_SelfSessionPlayerUpdateRequest && NewValue)

Sets the value of Player_Optional and also sets Player_IsSet to true using move semantics.

public inline void ClearPlayer()

Clears the value of Player_Optional and sets Player_IsSet to false.

public inline bool IsPlayerSet() const

Checks whether Player_Optional has been set.