Skip to content

RHAPI_SessionUpdate

Summary

MembersDescriptions
struct FRHAPI_SessionUpdateA request body to update information about a session resource.

struct FRHAPI_SessionUpdate

struct FRHAPI_SessionUpdate
: public FRHAPI_Model

A request body to update information about a session resource.

Summary

MembersDescriptions
public FString RegionId_OptionalPreferred region for the instance and match to take place in.
public bool RegionId_IsSettrue if RegionId_Optional has been set to a value
public TMap< FString, FString > CustomData_OptionalLeader Player or instance defined custom data about this session.
public bool CustomData_IsSettrue if CustomData_Optional has been set to a value
public bool Joinable_OptionalFlag for if players can freely join this session without an invite.
public bool Joinable_IsSettrue if Joinable_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) constWrites the data from this object into the specified JSON Writer stream.
public inline FString & GetRegionId()Gets the value of RegionId_Optional, regardless of it having been set.
public inline const FString & GetRegionId() constGets the value of RegionId_Optional, regardless of it having been set.
public inline const FString & GetRegionId(const FString & DefaultValue) constGets the value of RegionId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetRegionId(FString & OutValue) constFills 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() constReturns a pointer to RegionId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetRegionId(FString NewValue)Sets the value of RegionId_Optional and also sets RegionId_IsSet to true.
public inline void ClearRegionId()Clears the value of RegionId_Optional and sets RegionId_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() constGets the value of CustomData_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetCustomData(const TMap< FString, FString > & DefaultValue) constGets the value of CustomData_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetCustomData(TMap< FString, FString > & OutValue) constFills 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() constReturns 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 bool & GetJoinable()Gets the value of Joinable_Optional, regardless of it having been set.
public inline const bool & GetJoinable() constGets the value of Joinable_Optional, regardless of it having been set.
public inline const bool & GetJoinable(const bool & DefaultValue) constGets the value of Joinable_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetJoinable(bool & OutValue) constFills OutValue with the value of Joinable_Optional and returns true if it has been set, otherwise returns false.
public inline bool * GetJoinableOrNull()Returns a pointer to Joinable_Optional, if it has been set, otherwise returns nullptr.
public inline const bool * GetJoinableOrNull() constReturns a pointer to Joinable_Optional, if it has been set, otherwise returns nullptr.
public inline void SetJoinable(bool NewValue)Sets the value of Joinable_Optional and also sets Joinable_IsSet to true.
public inline void ClearJoinable()Clears the value of Joinable_Optional and sets Joinable_IsSet to false.
public inline bool IsJoinableDefaultValue() constReturns true if Joinable_Optional is set and matches the default value.
public inline void SetJoinableToDefault()Sets the value of Joinable_Optional to its default and also sets Joinable_IsSet to true.

Members

public FString RegionId_Optional

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


#### `public bool `[`RegionId_IsSet`](#structFRHAPI__SessionUpdate_1a9da573f2aec70094dcf75954ace79333)

true if RegionId_Optional has been set to a value


#### `public TMap< FString, FString > `[`CustomData_Optional`](#structFRHAPI__SessionUpdate_1a75a25433fd525c331b5e6119f40c6816)

Leader Player or instance defined custom data about this session.


#### `public bool `[`CustomData_IsSet`](#structFRHAPI__SessionUpdate_1a2e97bffd938db16822e8f35b4b808ef6)

true if CustomData_Optional has been set to a value


#### `public bool `[`Joinable_Optional`](#structFRHAPI__SessionUpdate_1aacbfdec8b14c38f25c0a26d96e373f80)

Flag for if players can freely join this session without an invite.


#### `public bool `[`Joinable_IsSet`](#structFRHAPI__SessionUpdate_1a1771b6a886f26629df2e7c1f798c3632)

true if Joinable_Optional has been set to a value


#### `public virtual bool `[`FromJson`](#structFRHAPI__SessionUpdate_1afa43baf74e0c17d38ef79d73a9101d5d)`(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`](#structFRHAPI__SessionUpdate_1ac9074a03cedc50aa8525fadaa378bf75)`(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 & `[`GetRegionId`](#structFRHAPI__SessionUpdate_1a89c91fcd33810a8033ff794ad01923ab)`()`

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


#### `public inline const FString & `[`GetRegionId`](#structFRHAPI__SessionUpdate_1aead7d3b8758e4d3009ae50a728814bf9)`() const`

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


#### `public inline const FString & `[`GetRegionId`](#structFRHAPI__SessionUpdate_1a7a63b0205dd6e8ec13ff38eae4bc7729)`(const FString & DefaultValue) const`

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


#### `public inline bool `[`GetRegionId`](#structFRHAPI__SessionUpdate_1abb52a4f959368b5ff17dfca55868ca1a)`(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`](#structFRHAPI__SessionUpdate_1a98aa631f19fe9d833553ce00e76784c9)`()`

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


#### `public inline const FString * `[`GetRegionIdOrNull`](#structFRHAPI__SessionUpdate_1a3c305f88622374211674d0460ffbe2ec)`() const`

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


#### `public inline void `[`SetRegionId`](#structFRHAPI__SessionUpdate_1af3738baba2b55dd312a464d2cd2cb5b2)`(FString NewValue)`

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


#### `public inline void `[`ClearRegionId`](#structFRHAPI__SessionUpdate_1a9d0d41f29e5abde04971abc760e79cad)`()`

Clears the value of RegionId_Optional and sets RegionId_IsSet to false.


#### `public inline TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__SessionUpdate_1a90c555e3270441fd39ca37b48f42e4b7)`()`

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


#### `public inline const TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__SessionUpdate_1a25f19ba461efb88d2e796043b704acbe)`() const`

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


#### `public inline const TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__SessionUpdate_1ad55370ef9e60177045854e7ef98dce12)`(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__SessionUpdate_1a6ad53d6269bd9319b6aa9fd4d6dc57f7)`(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__SessionUpdate_1a511d62a037fe7af840ad0a35146fa553)`()`

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


#### `public inline const TMap< FString, FString > * `[`GetCustomDataOrNull`](#structFRHAPI__SessionUpdate_1a24df114a5fcae9e12a1c2d0c35d9ab5e)`() const`

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


#### `public inline void `[`SetCustomData`](#structFRHAPI__SessionUpdate_1a067b23e769c67dbef812810ef33038fd)`(TMap< FString, FString > NewValue)`

Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.


#### `public inline void `[`ClearCustomData`](#structFRHAPI__SessionUpdate_1ae42a27ea8701e456d8c7da0a840ab67a)`()`

Clears the value of CustomData_Optional and sets CustomData_IsSet to false.


#### `public inline bool & `[`GetJoinable`](#structFRHAPI__SessionUpdate_1a02c087ef532461a4a67965edf157e2be)`()`

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


#### `public inline const bool & `[`GetJoinable`](#structFRHAPI__SessionUpdate_1a76ddc37b2559202fb20415df8dd2b6b7)`() const`

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


#### `public inline const bool & `[`GetJoinable`](#structFRHAPI__SessionUpdate_1a702ccd3fd1429a1fa75cc224af6609f2)`(const bool & DefaultValue) const`

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


#### `public inline bool `[`GetJoinable`](#structFRHAPI__SessionUpdate_1ab8ce51e436d1aec01168e2685464133f)`(bool & OutValue) const`

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


#### `public inline bool * `[`GetJoinableOrNull`](#structFRHAPI__SessionUpdate_1a72e87a8e9e412964af2f81946e6adbb4)`()`

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


#### `public inline const bool * `[`GetJoinableOrNull`](#structFRHAPI__SessionUpdate_1a81dd7dfa0fc643e2c7f136d667fe5112)`() const`

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


#### `public inline void `[`SetJoinable`](#structFRHAPI__SessionUpdate_1ad3553aa34e058ae6965d6c915ac88254)`(bool NewValue)`

Sets the value of Joinable_Optional and also sets Joinable_IsSet to true.


#### `public inline void `[`ClearJoinable`](#structFRHAPI__SessionUpdate_1a5e38954afb4281bfd14241a6b0faca88)`()`

Clears the value of Joinable_Optional and sets Joinable_IsSet to false.


#### `public inline bool `[`IsJoinableDefaultValue`](#structFRHAPI__SessionUpdate_1a6c81424549450bef7b7430faa548f0e4)`() const`

Returns true if Joinable_Optional is set and matches the default value.


#### `public inline void `[`SetJoinableToDefault`](#structFRHAPI__SessionUpdate_1a0831036473b80aa18223036feeab2a6f)`()`

Sets the value of Joinable_Optional to its default and also sets Joinable_IsSet to true.