Skip to main content

RHAPI_SessionInviteRequest

Summary​

MembersDescriptions
struct FRHAPI_SessionInviteRequest

struct FRHAPI_SessionInviteRequest ​

struct FRHAPI_SessionInviteRequest
  : public FRHAPI_Model

Summary​

MembersDescriptions
public int32 TeamId_OptionalWhich team the players in the source session should be on.
public bool TeamId_IsSettrue if TeamId_Optional has been set to a value
public ERHAPI_TeamOverflowAction OverflowAction_OptionalHow we should handle too many players being invited to the chosen team.
public bool OverflowAction_IsSettrue if OverflowAction_Optional has been set to a value
public TMap< FString, FString > CustomData_OptionalCustom data for all players being invited.
public bool CustomData_IsSettrue 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) constWrites the data from this object into the specified JSON Writer stream.
public inline int32 & GetTeamId()Gets the value of TeamId_Optional, regardless of it having been set.
public inline const int32 & GetTeamId() constGets the value of TeamId_Optional, regardless of it having been set.
public inline const int32 & GetTeamId(const int32 & DefaultValue) constGets the value of TeamId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetTeamId(int32 & OutValue) constFills OutValue with the value of TeamId_Optional and returns true if it has been set, otherwise returns false.
public inline int32 * GetTeamIdOrNull()Returns a pointer to TeamId_Optional, if it has been set, otherwise returns nullptr.
public inline const int32 * GetTeamIdOrNull() constReturns a pointer to TeamId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetTeamId(const int32 & NewValue)Sets the value of TeamId_Optional and also sets TeamId_IsSet to true.
public inline void SetTeamId(int32 && NewValue)Sets the value of TeamId_Optional and also sets TeamId_IsSet to true using move semantics.
public inline void ClearTeamId()Clears the value of TeamId_Optional and sets TeamId_IsSet to false.
public inline bool IsTeamIdSet() constChecks whether TeamId_Optional has been set.
public inline bool IsTeamIdDefaultValue() constReturns true if TeamId_Optional is set and matches the default value.
public inline void SetTeamIdToDefault()Sets the value of TeamId_Optional to its default and also sets TeamId_IsSet to true.
public inline ERHAPI_TeamOverflowAction & GetOverflowAction()Gets the value of OverflowAction_Optional, regardless of it having been set.
public inline const ERHAPI_TeamOverflowAction & GetOverflowAction() constGets the value of OverflowAction_Optional, regardless of it having been set.
public inline const ERHAPI_TeamOverflowAction & GetOverflowAction(const ERHAPI_TeamOverflowAction & DefaultValue) constGets the value of OverflowAction_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetOverflowAction(ERHAPI_TeamOverflowAction & OutValue) constFills OutValue with the value of OverflowAction_Optional and returns true if it has been set, otherwise returns false.
public inline ERHAPI_TeamOverflowAction * GetOverflowActionOrNull()Returns a pointer to OverflowAction_Optional, if it has been set, otherwise returns nullptr.
public inline const ERHAPI_TeamOverflowAction * GetOverflowActionOrNull() constReturns a pointer to OverflowAction_Optional, if it has been set, otherwise returns nullptr.
public inline void SetOverflowAction(const ERHAPI_TeamOverflowAction & NewValue)Sets the value of OverflowAction_Optional and also sets OverflowAction_IsSet to true.
public inline void SetOverflowAction(ERHAPI_TeamOverflowAction && NewValue)Sets the value of OverflowAction_Optional and also sets OverflowAction_IsSet to true using move semantics.
public inline void ClearOverflowAction()Clears the value of OverflowAction_Optional and sets OverflowAction_IsSet to false.
public inline bool IsOverflowActionSet() constChecks whether OverflowAction_Optional has been set.
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(const TMap< FString, FString > & NewValue)Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.
public inline void SetCustomData(TMap< FString, FString > && NewValue)Sets the value of CustomData_Optional and also sets CustomData_IsSet to true using move semantics.
public inline void ClearCustomData()Clears the value of CustomData_Optional and sets CustomData_IsSet to false.
public inline bool IsCustomDataSet() constChecks whether CustomData_Optional has been set.

Members​

public int32 TeamId_Optional ​

Which team the players in the source session should be on.

public bool TeamId_IsSet ​

true if TeamId_Optional has been set to a value

public ERHAPI_TeamOverflowAction OverflowAction_Optional ​

How we should handle too many players being invited to the chosen team.

public bool OverflowAction_IsSet ​

true if OverflowAction_Optional has been set to a value

public TMap< FString, FString > CustomData_Optional ​

Custom data for all players being invited.

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 int32 & GetTeamId() ​

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

public inline const int32 & GetTeamId() const ​

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

public inline const int32 & GetTeamId(const int32 & DefaultValue) const ​

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

public inline bool GetTeamId(int32 & OutValue) const ​

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

public inline int32 * GetTeamIdOrNull() ​

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

public inline const int32 * GetTeamIdOrNull() const ​

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

public inline void SetTeamId(const int32 & NewValue) ​

Sets the value of TeamId_Optional and also sets TeamId_IsSet to true.

public inline void SetTeamId(int32 && NewValue) ​

Sets the value of TeamId_Optional and also sets TeamId_IsSet to true using move semantics.

public inline void ClearTeamId() ​

Clears the value of TeamId_Optional and sets TeamId_IsSet to false.

public inline bool IsTeamIdSet() const ​

Checks whether TeamId_Optional has been set.

public inline bool IsTeamIdDefaultValue() const ​

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

public inline void SetTeamIdToDefault() ​

Sets the value of TeamId_Optional to its default and also sets TeamId_IsSet to true.

public inline ERHAPI_TeamOverflowAction & GetOverflowAction() ​

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

public inline const ERHAPI_TeamOverflowAction & GetOverflowAction() const ​

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

public inline const ERHAPI_TeamOverflowAction & GetOverflowAction(const ERHAPI_TeamOverflowAction & DefaultValue) const ​

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

public inline bool GetOverflowAction(ERHAPI_TeamOverflowAction & OutValue) const ​

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

public inline ERHAPI_TeamOverflowAction * GetOverflowActionOrNull() ​

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

public inline const ERHAPI_TeamOverflowAction * GetOverflowActionOrNull() const ​

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

public inline void SetOverflowAction(const ERHAPI_TeamOverflowAction & NewValue) ​

Sets the value of OverflowAction_Optional and also sets OverflowAction_IsSet to true.

public inline void SetOverflowAction(ERHAPI_TeamOverflowAction && NewValue) ​

Sets the value of OverflowAction_Optional and also sets OverflowAction_IsSet to true using move semantics.

public inline void ClearOverflowAction() ​

Clears the value of OverflowAction_Optional and sets OverflowAction_IsSet to false.

public inline bool IsOverflowActionSet() const ​

Checks whether OverflowAction_Optional has been set.

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(const TMap< FString, FString > & NewValue) ​

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

public inline void SetCustomData(TMap< FString, FString > && NewValue) ​

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

public inline void ClearCustomData() ​

Clears the value of CustomData_Optional and sets CustomData_IsSet to false.

public inline bool IsCustomDataSet() const ​

Checks whether CustomData_Optional has been set.