RHAPI_SelfSessionPlayerUpdateRequest
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_SelfSessionPlayerUpdateRequest | A request body for a player updating information about themselves. |
struct FRHAPI_SelfSessionPlayerUpdateRequest
struct FRHAPI_SelfSessionPlayerUpdateRequest : public FRHAPI_ModelA request body for a player updating information about themselves.
Summary
| Members | Descriptions |
|---|---|
public ERHAPI_SessionPlayerStatus Status_Optional | Status that the player would like after the request is complete. Note that some join operations may promote the player from member to leader |
public bool Status_IsSet | true if Status_Optional has been set to a value |
public FString ClientVersion | Semver for updated client. |
public FRHAPI_ClientSettings ClientSettings | Which input type and platform the client is using. |
public int32 TeamId | Which team the player is one. |
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 TMap< FString, FString > CustomData_Optional | player-defined custom data |
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_SessionPlayerStatus & GetStatus() | Gets the value of Status_Optional, regardless of it having been set. |
public inline const ERHAPI_SessionPlayerStatus & GetStatus() const | Gets the value of Status_Optional, regardless of it having been set. |
public inline const ERHAPI_SessionPlayerStatus & GetStatus(const ERHAPI_SessionPlayerStatus & DefaultValue) const | Gets the value of Status_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetStatus(ERHAPI_SessionPlayerStatus & OutValue) const | Fills OutValue with the value of Status_Optional and returns true if it has been set, otherwise returns false. |
public inline ERHAPI_SessionPlayerStatus * GetStatusOrNull() | Returns a pointer to Status_Optional, if it has been set, otherwise returns nullptr. |
public inline const ERHAPI_SessionPlayerStatus * GetStatusOrNull() const | Returns a pointer to Status_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetStatus(ERHAPI_SessionPlayerStatus 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 & GetClientVersion() | Gets the value of ClientVersion. |
public inline const FString & GetClientVersion() const | Gets the value of ClientVersion. |
public inline void SetClientVersion(FString NewValue) | Sets the value of ClientVersion. |
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(FRHAPI_ClientSettings NewValue) | Sets the value of ClientSettings. |
public inline int32 & GetTeamId() | Gets the value of TeamId. |
public inline const int32 & GetTeamId() const | Gets the value of TeamId. |
public inline void SetTeamId(int32 NewValue) | Sets the value of TeamId. |
public inline bool IsTeamIdDefaultValue() const | Returns true if TeamId matches the default value. |
public inline void SetTeamIdToDefault() | Sets the value of TeamId to its default |
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 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_SessionPlayerStatus Status_Optional
Status that the player would like after the request is complete. Note that some join operations may promote the player from member to leader
#### `public bool `[`Status_IsSet`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1acdead63ce3719b7cb13bda50220e44c3)
true if Status_Optional has been set to a value
#### `public FString `[`ClientVersion`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1a578153977ab83acf82c229604c427a41)
Semver for updated client.
#### `public `[`FRHAPI_ClientSettings`](RHAPI_ClientSettings.md#structFRHAPI__ClientSettings)` `[`ClientSettings`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1a51b20cb17231495ddb6e7904e67ff3b5)
Which input type and platform the client is using.
#### `public int32 `[`TeamId`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1a6e30cb01f64056bb327e4bc9214d11c1)
Which team the player is one.
#### `public `[`FRHAPI_CrossplayPreferences`](RHAPI_CrossplayPreferences.md#structFRHAPI__CrossplayPreferences)` `[`CrossplayPreferences_Optional`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1a3add0a8d848cdc7ba37ad9e02c33df33)
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`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1abea2347af254bb0e3f9eb8cbb46fc9e3)
true if CrossplayPreferences_Optional has been set to a value
#### `public TMap< FString, FString > `[`CustomData_Optional`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1aaa1ded6c84ac6e5ddda821fe76a086ae)
player-defined custom data
#### `public bool `[`CustomData_IsSet`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1a8217d194f5c6d231a970922b72505333)
true if CustomData_Optional has been set to a value
#### `public virtual bool `[`FromJson`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1a8284666cfe41673b366681ac424cbef7)`(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`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1a7ea4fe3aca12fa5606e876af960c89a4)`(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_SessionPlayerStatus & `[`GetStatus`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1a9396bf8b5d1ade1bcfba5f0012a7e840)`()`
Gets the value of Status_Optional, regardless of it having been set.
#### `public inline const ERHAPI_SessionPlayerStatus & `[`GetStatus`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1a02a02d49641845b380e4a9d6012cab8d)`() const`
Gets the value of Status_Optional, regardless of it having been set.
#### `public inline const ERHAPI_SessionPlayerStatus & `[`GetStatus`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1a2cf4b2102c37b21941a5880e3effab85)`(const ERHAPI_SessionPlayerStatus & DefaultValue) const`
Gets the value of Status_Optional, if it has been set, otherwise it returns DefaultValue.
#### `public inline bool `[`GetStatus`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1aa4778eafeab137a80737cb4ac3b85aeb)`(ERHAPI_SessionPlayerStatus & OutValue) const`
Fills OutValue with the value of Status_Optional and returns true if it has been set, otherwise returns false.
#### `public inline ERHAPI_SessionPlayerStatus * `[`GetStatusOrNull`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1a1eb593819087754e5872e9b91f1b3289)`()`
Returns a pointer to Status_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const ERHAPI_SessionPlayerStatus * `[`GetStatusOrNull`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1af709ed3c843dcbaea33f66daf04b195e)`() const`
Returns a pointer to Status_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetStatus`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1af3d37c0180946dedce83850037f7631e)`(ERHAPI_SessionPlayerStatus NewValue)`
Sets the value of Status_Optional and also sets Status_IsSet to true.
#### `public inline void `[`ClearStatus`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1a43b611f41d315e4d920418702e1c508b)`()`
Clears the value of Status_Optional and sets Status_IsSet to false.
#### `public inline FString & `[`GetClientVersion`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1ac28d2a14c9ab5f993dcf0f115ffe8065)`()`
Gets the value of ClientVersion.
#### `public inline const FString & `[`GetClientVersion`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1a9884671fb2a07272c4a254db4b5a60ea)`() const`
Gets the value of ClientVersion.
#### `public inline void `[`SetClientVersion`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1a5a7b1202b482322ca10a8b8046ecc13c)`(FString NewValue)`
Sets the value of ClientVersion.
#### `public inline `[`FRHAPI_ClientSettings`](RHAPI_ClientSettings.md#structFRHAPI__ClientSettings)` & `[`GetClientSettings`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1aae5c9917394a8daea13f8e1b3fede7fc)`()`
Gets the value of ClientSettings.
#### `public inline const `[`FRHAPI_ClientSettings`](RHAPI_ClientSettings.md#structFRHAPI__ClientSettings)` & `[`GetClientSettings`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1ab53168dd05e16b5cae6ed2ffe4e2dd04)`() const`
Gets the value of ClientSettings.
#### `public inline void `[`SetClientSettings`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1a0e9e7718d3337ecd2f87be25e9084ba9)`(`[`FRHAPI_ClientSettings`](RHAPI_ClientSettings.md#structFRHAPI__ClientSettings)` NewValue)`
Sets the value of ClientSettings.
#### `public inline int32 & `[`GetTeamId`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1aa91152f39bf35cdfd48f092e198c0864)`()`
Gets the value of TeamId.
#### `public inline const int32 & `[`GetTeamId`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1a72f5cc93485c3a7f055640acf9665505)`() const`
Gets the value of TeamId.
#### `public inline void `[`SetTeamId`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1a6d0501d38d1c6dd22cad1956528500b1)`(int32 NewValue)`
Sets the value of TeamId.
#### `public inline bool `[`IsTeamIdDefaultValue`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1a15c6b3db1569e1555132bf0540770064)`() const`
Returns true if TeamId matches the default value.
#### `public inline void `[`SetTeamIdToDefault`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1a3782cd521bb7775f673f97861613130d)`()`
Sets the value of TeamId to its default
#### `public inline `[`FRHAPI_CrossplayPreferences`](RHAPI_CrossplayPreferences.md#structFRHAPI__CrossplayPreferences)` & `[`GetCrossplayPreferences`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1a17bf901ce856d781acf75d3c05ce2051)`()`
Gets the value of CrossplayPreferences_Optional, regardless of it having been set.
#### `public inline const `[`FRHAPI_CrossplayPreferences`](RHAPI_CrossplayPreferences.md#structFRHAPI__CrossplayPreferences)` & `[`GetCrossplayPreferences`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1abfd05b4337095d683eb2c1c3239bd146)`() const`
Gets the value of CrossplayPreferences_Optional, regardless of it having been set.
#### `public inline const `[`FRHAPI_CrossplayPreferences`](RHAPI_CrossplayPreferences.md#structFRHAPI__CrossplayPreferences)` & `[`GetCrossplayPreferences`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1ab9f7a945381549ddc70c0bf455f1864c)`(const `[`FRHAPI_CrossplayPreferences`](RHAPI_CrossplayPreferences.md#structFRHAPI__CrossplayPreferences)` & DefaultValue) const`
Gets the value of CrossplayPreferences_Optional, if it has been set, otherwise it returns DefaultValue.
#### `public inline bool `[`GetCrossplayPreferences`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1adb508ab41d796ca2863c518504d67284)`(`[`FRHAPI_CrossplayPreferences`](RHAPI_CrossplayPreferences.md#structFRHAPI__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`](RHAPI_CrossplayPreferences.md#structFRHAPI__CrossplayPreferences)` * `[`GetCrossplayPreferencesOrNull`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1ae91328b352d515792e7bfef9c022ed2e)`()`
Returns a pointer to CrossplayPreferences_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const `[`FRHAPI_CrossplayPreferences`](RHAPI_CrossplayPreferences.md#structFRHAPI__CrossplayPreferences)` * `[`GetCrossplayPreferencesOrNull`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1adf3c02f507868c0c8da429df6f6b7b0f)`() const`
Returns a pointer to CrossplayPreferences_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetCrossplayPreferences`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1a8257fa87ed002fcbca2abde0e5db3d29)`(`[`FRHAPI_CrossplayPreferences`](RHAPI_CrossplayPreferences.md#structFRHAPI__CrossplayPreferences)` NewValue)`
Sets the value of CrossplayPreferences_Optional and also sets CrossplayPreferences_IsSet to true.
#### `public inline void `[`ClearCrossplayPreferences`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1ad9dacb94ea41b6f8efbf9c1c9ed3420e)`()`
Clears the value of CrossplayPreferences_Optional and sets CrossplayPreferences_IsSet to false.
#### `public inline TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1a9ecf38ff0a4a3ba94c5a1106348428f9)`()`
Gets the value of CustomData_Optional, regardless of it having been set.
#### `public inline const TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1a7f2afaef3a77a2a4697806a10de2a5af)`() const`
Gets the value of CustomData_Optional, regardless of it having been set.
#### `public inline const TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1afbfbe077f9a58ba48b4f735d7de5e92e)`(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`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1a77e8157f202a5ad51f743a00178f92a4)`(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`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1af13635fbf33bc082ff124b33867ee5cb)`()`
Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const TMap< FString, FString > * `[`GetCustomDataOrNull`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1a24356665c3aeec53f6f5367d79920207)`() const`
Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetCustomData`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1ae06caba5bb32425ee95705a6e8e05937)`(TMap< FString, FString > NewValue)`
Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.
#### `public inline void `[`ClearCustomData`](#structFRHAPI__SelfSessionPlayerUpdateRequest_1afc76499c6b23732fdd02a72402d7e752)`()`
Clears the value of CustomData_Optional and sets CustomData_IsSet to false.