Skip to content

RHAPI_PlayerOrderCreate

Summary

MembersDescriptions
struct FRHAPI_PlayerOrderCreateCreate a new Player Order. Note: `use_inventory_bucket` will be ignored on the PlayerOrderEntryCreate if the `source` equals `CLIENT`..

struct FRHAPI_PlayerOrderCreate

struct FRHAPI_PlayerOrderCreate
: public FRHAPI_Model

Create a new Player Order. Note: `use_inventory_bucket` will be ignored on the PlayerOrderEntryCreate if the `source` equals `CLIENT`..

Summary

MembersDescriptions
public ERHAPI_Source Source_OptionalThe source of the Player Order.
public bool Source_IsSettrue if Source_Optional has been set to a value
public FGuid ClientOrderRefId_OptionalArbitrary UUID clients can use to track Orders between request to response.
public bool ClientOrderRefId_IsSettrue if ClientOrderRefId_Optional has been set to a value
public ERHAPI_Portal PortalId_OptionalPortal of the Portal User the Player Order belongs to.
public bool PortalId_IsSettrue if PortalId_Optional has been set to a value
public FString PortalUserId_OptionalPortal User Id for the Player this Player Order belongs to.
public bool PortalUserId_IsSettrue if PortalUserId_Optional has been set to a value
public FString InstanceId_OptionalInstance Id for the Instance who submits the Player Order.
public bool InstanceId_IsSettrue if InstanceId_Optional has been set to a value
public FString MatchId_OptionalMatch Id for the Match that generated the Player Order.
public bool MatchId_IsSettrue if MatchId_Optional has been set to a value
public bool IsTransaction_OptionalIf an order is a transaction, any failed entries will roll back changes from all other entries.
public bool IsTransaction_IsSettrue if IsTransaction_Optional has been set to a value
public FString OrderId_OptionalUnique Identifier for the Order.
public bool OrderId_IsSettrue if OrderId_Optional has been set to a value
public TArray< FRHAPI_PlayerOrderEntryCreate>EntriesList of Player Order Entries for the Player Order.
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 ERHAPI_Source & GetSource()Gets the value of Source_Optional, regardless of it having been set.
public inline const ERHAPI_Source & GetSource() constGets the value of Source_Optional, regardless of it having been set.
public inline const ERHAPI_Source & GetSource(const ERHAPI_Source & DefaultValue) constGets the value of Source_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetSource(ERHAPI_Source & OutValue) constFills OutValue with the value of Source_Optional and returns true if it has been set, otherwise returns false.
public inline ERHAPI_Source * GetSourceOrNull()Returns a pointer to Source_Optional, if it has been set, otherwise returns nullptr.
public inline const ERHAPI_Source * GetSourceOrNull() constReturns a pointer to Source_Optional, if it has been set, otherwise returns nullptr.
public inline void SetSource(ERHAPI_Source NewValue)Sets the value of Source_Optional and also sets Source_IsSet to true.
public inline void ClearSource()Clears the value of Source_Optional and sets Source_IsSet to false.
public inline FGuid & GetClientOrderRefId()Gets the value of ClientOrderRefId_Optional, regardless of it having been set.
public inline const FGuid & GetClientOrderRefId() constGets the value of ClientOrderRefId_Optional, regardless of it having been set.
public inline const FGuid & GetClientOrderRefId(const FGuid & DefaultValue) constGets the value of ClientOrderRefId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetClientOrderRefId(FGuid & OutValue) constFills OutValue with the value of ClientOrderRefId_Optional and returns true if it has been set, otherwise returns false.
public inline FGuid * GetClientOrderRefIdOrNull()Returns a pointer to ClientOrderRefId_Optional, if it has been set, otherwise returns nullptr.
public inline const FGuid * GetClientOrderRefIdOrNull() constReturns a pointer to ClientOrderRefId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetClientOrderRefId(FGuid NewValue)Sets the value of ClientOrderRefId_Optional and also sets ClientOrderRefId_IsSet to true.
public inline void ClearClientOrderRefId()Clears the value of ClientOrderRefId_Optional and sets ClientOrderRefId_IsSet to false.
public inline ERHAPI_Portal & GetPortalId()Gets the value of PortalId_Optional, regardless of it having been set.
public inline const ERHAPI_Portal & GetPortalId() constGets the value of PortalId_Optional, regardless of it having been set.
public inline const ERHAPI_Portal & GetPortalId(const ERHAPI_Portal & DefaultValue) constGets the value of PortalId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetPortalId(ERHAPI_Portal & OutValue) constFills OutValue with the value of PortalId_Optional and returns true if it has been set, otherwise returns false.
public inline ERHAPI_Portal * GetPortalIdOrNull()Returns a pointer to PortalId_Optional, if it has been set, otherwise returns nullptr.
public inline const ERHAPI_Portal * GetPortalIdOrNull() constReturns a pointer to PortalId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetPortalId(ERHAPI_Portal NewValue)Sets the value of PortalId_Optional and also sets PortalId_IsSet to true.
public inline void ClearPortalId()Clears the value of PortalId_Optional and sets PortalId_IsSet to false.
public inline FString & GetPortalUserId()Gets the value of PortalUserId_Optional, regardless of it having been set.
public inline const FString & GetPortalUserId() constGets the value of PortalUserId_Optional, regardless of it having been set.
public inline const FString & GetPortalUserId(const FString & DefaultValue) constGets the value of PortalUserId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetPortalUserId(FString & OutValue) constFills OutValue with the value of PortalUserId_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetPortalUserIdOrNull()Returns a pointer to PortalUserId_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetPortalUserIdOrNull() constReturns a pointer to PortalUserId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetPortalUserId(FString NewValue)Sets the value of PortalUserId_Optional and also sets PortalUserId_IsSet to true.
public inline void ClearPortalUserId()Clears the value of PortalUserId_Optional and sets PortalUserId_IsSet to false.
public inline FString & GetInstanceId()Gets the value of InstanceId_Optional, regardless of it having been set.
public inline const FString & GetInstanceId() constGets the value of InstanceId_Optional, regardless of it having been set.
public inline const FString & GetInstanceId(const FString & DefaultValue) constGets the value of InstanceId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetInstanceId(FString & OutValue) constFills OutValue with the value of InstanceId_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetInstanceIdOrNull()Returns a pointer to InstanceId_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetInstanceIdOrNull() constReturns a pointer to InstanceId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetInstanceId(FString NewValue)Sets the value of InstanceId_Optional and also sets InstanceId_IsSet to true.
public inline void ClearInstanceId()Clears the value of InstanceId_Optional and sets InstanceId_IsSet to false.
public inline FString & GetMatchId()Gets the value of MatchId_Optional, regardless of it having been set.
public inline const FString & GetMatchId() constGets the value of MatchId_Optional, regardless of it having been set.
public inline const FString & GetMatchId(const FString & DefaultValue) constGets the value of MatchId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetMatchId(FString & OutValue) constFills OutValue with the value of MatchId_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetMatchIdOrNull()Returns a pointer to MatchId_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetMatchIdOrNull() constReturns a pointer to MatchId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetMatchId(FString NewValue)Sets the value of MatchId_Optional and also sets MatchId_IsSet to true.
public inline void ClearMatchId()Clears the value of MatchId_Optional and sets MatchId_IsSet to false.
public inline bool & GetIsTransaction()Gets the value of IsTransaction_Optional, regardless of it having been set.
public inline const bool & GetIsTransaction() constGets the value of IsTransaction_Optional, regardless of it having been set.
public inline const bool & GetIsTransaction(const bool & DefaultValue) constGets the value of IsTransaction_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetIsTransaction(bool & OutValue) constFills OutValue with the value of IsTransaction_Optional and returns true if it has been set, otherwise returns false.
public inline bool * GetIsTransactionOrNull()Returns a pointer to IsTransaction_Optional, if it has been set, otherwise returns nullptr.
public inline const bool * GetIsTransactionOrNull() constReturns a pointer to IsTransaction_Optional, if it has been set, otherwise returns nullptr.
public inline void SetIsTransaction(bool NewValue)Sets the value of IsTransaction_Optional and also sets IsTransaction_IsSet to true.
public inline void ClearIsTransaction()Clears the value of IsTransaction_Optional and sets IsTransaction_IsSet to false.
public inline bool IsIsTransactionDefaultValue() constReturns true if IsTransaction_Optional is set and matches the default value.
public inline void SetIsTransactionToDefault()Sets the value of IsTransaction_Optional to its default and also sets IsTransaction_IsSet to true.
public inline FString & GetOrderId()Gets the value of OrderId_Optional, regardless of it having been set.
public inline const FString & GetOrderId() constGets the value of OrderId_Optional, regardless of it having been set.
public inline const FString & GetOrderId(const FString & DefaultValue) constGets the value of OrderId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetOrderId(FString & OutValue) constFills OutValue with the value of OrderId_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetOrderIdOrNull()Returns a pointer to OrderId_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetOrderIdOrNull() constReturns a pointer to OrderId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetOrderId(FString NewValue)Sets the value of OrderId_Optional and also sets OrderId_IsSet to true.
public inline void ClearOrderId()Clears the value of OrderId_Optional and sets OrderId_IsSet to false.
public inline TArray< FRHAPI_PlayerOrderEntryCreate> &GetEntries()Gets the value of Entries.
public inline const TArray< FRHAPI_PlayerOrderEntryCreate> &GetEntries() constGets the value of Entries.
public inline void SetEntries(TArray< FRHAPI_PlayerOrderEntryCreate > NewValue)Sets the value of Entries.

Members

public ERHAPI_Source Source_Optional

The source of the Player Order.

public bool Source_IsSet

true if Source_Optional has been set to a value

public FGuid ClientOrderRefId_Optional

Arbitrary UUID clients can use to track Orders between request to response.

public bool ClientOrderRefId_IsSet

true if ClientOrderRefId_Optional has been set to a value

public ERHAPI_Portal PortalId_Optional

Portal of the Portal User the Player Order belongs to.

public bool PortalId_IsSet

true if PortalId_Optional has been set to a value

public FString PortalUserId_Optional

Portal User Id for the Player this Player Order belongs to.

public bool PortalUserId_IsSet

true if PortalUserId_Optional has been set to a value

public FString InstanceId_Optional

Instance Id for the Instance who submits the Player Order.

public bool InstanceId_IsSet

true if InstanceId_Optional has been set to a value

public FString MatchId_Optional

Match Id for the Match that generated the Player Order.

public bool MatchId_IsSet

true if MatchId_Optional has been set to a value

public bool IsTransaction_Optional

If an order is a transaction, any failed entries will roll back changes from all other entries.

public bool IsTransaction_IsSet

true if IsTransaction_Optional has been set to a value

public FString OrderId_Optional

Unique Identifier for the Order.

public bool OrderId_IsSet

true if OrderId_Optional has been set to a value

public TArray< FRHAPI_PlayerOrderEntryCreate>Entries

List of Player Order Entries for the Player Order.

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 ERHAPI_Source & GetSource()

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

public inline const ERHAPI_Source & GetSource() const

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

public inline const ERHAPI_Source & GetSource(const ERHAPI_Source & DefaultValue) const

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

public inline bool GetSource(ERHAPI_Source & OutValue) const

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

public inline ERHAPI_Source * GetSourceOrNull()

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

public inline const ERHAPI_Source * GetSourceOrNull() const

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

public inline void SetSource(ERHAPI_Source NewValue)

Sets the value of Source_Optional and also sets Source_IsSet to true.

public inline void ClearSource()

Clears the value of Source_Optional and sets Source_IsSet to false.

public inline FGuid & GetClientOrderRefId()

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

public inline const FGuid & GetClientOrderRefId() const

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

public inline const FGuid & GetClientOrderRefId(const FGuid & DefaultValue) const

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

public inline bool GetClientOrderRefId(FGuid & OutValue) const

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

public inline FGuid * GetClientOrderRefIdOrNull()

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

public inline const FGuid * GetClientOrderRefIdOrNull() const

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

public inline void SetClientOrderRefId(FGuid NewValue)

Sets the value of ClientOrderRefId_Optional and also sets ClientOrderRefId_IsSet to true.

public inline void ClearClientOrderRefId()

Clears the value of ClientOrderRefId_Optional and sets ClientOrderRefId_IsSet to false.

public inline ERHAPI_Portal & GetPortalId()

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

public inline const ERHAPI_Portal & GetPortalId() const

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

public inline const ERHAPI_Portal & GetPortalId(const ERHAPI_Portal & DefaultValue) const

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

public inline bool GetPortalId(ERHAPI_Portal & OutValue) const

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

public inline ERHAPI_Portal * GetPortalIdOrNull()

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

public inline const ERHAPI_Portal * GetPortalIdOrNull() const

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

public inline void SetPortalId(ERHAPI_Portal NewValue)

Sets the value of PortalId_Optional and also sets PortalId_IsSet to true.

public inline void ClearPortalId()

Clears the value of PortalId_Optional and sets PortalId_IsSet to false.

public inline FString & GetPortalUserId()

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

public inline const FString & GetPortalUserId() const

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

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

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

public inline bool GetPortalUserId(FString & OutValue) const

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

public inline FString * GetPortalUserIdOrNull()

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

public inline const FString * GetPortalUserIdOrNull() const

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

public inline void SetPortalUserId(FString NewValue)

Sets the value of PortalUserId_Optional and also sets PortalUserId_IsSet to true.

public inline void ClearPortalUserId()

Clears the value of PortalUserId_Optional and sets PortalUserId_IsSet to false.

public inline FString & GetInstanceId()

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

public inline const FString & GetInstanceId() const

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

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

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

public inline bool GetInstanceId(FString & OutValue) const

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

public inline FString * GetInstanceIdOrNull()

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

public inline const FString * GetInstanceIdOrNull() const

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

public inline void SetInstanceId(FString NewValue)

Sets the value of InstanceId_Optional and also sets InstanceId_IsSet to true.

public inline void ClearInstanceId()

Clears the value of InstanceId_Optional and sets InstanceId_IsSet to false.

public inline FString & GetMatchId()

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

public inline const FString & GetMatchId() const

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

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

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

public inline bool GetMatchId(FString & OutValue) const

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

public inline FString * GetMatchIdOrNull()

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

public inline const FString * GetMatchIdOrNull() const

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

public inline void SetMatchId(FString NewValue)

Sets the value of MatchId_Optional and also sets MatchId_IsSet to true.

public inline void ClearMatchId()

Clears the value of MatchId_Optional and sets MatchId_IsSet to false.

public inline bool & GetIsTransaction()

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

public inline const bool & GetIsTransaction() const

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

public inline const bool & GetIsTransaction(const bool & DefaultValue) const

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

public inline bool GetIsTransaction(bool & OutValue) const

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

public inline bool * GetIsTransactionOrNull()

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

public inline const bool * GetIsTransactionOrNull() const

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

public inline void SetIsTransaction(bool NewValue)

Sets the value of IsTransaction_Optional and also sets IsTransaction_IsSet to true.

public inline void ClearIsTransaction()

Clears the value of IsTransaction_Optional and sets IsTransaction_IsSet to false.

public inline bool IsIsTransactionDefaultValue() const

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

public inline void SetIsTransactionToDefault()

Sets the value of IsTransaction_Optional to its default and also sets IsTransaction_IsSet to true.

public inline FString & GetOrderId()

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

public inline const FString & GetOrderId() const

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

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

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

public inline bool GetOrderId(FString & OutValue) const

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

public inline FString * GetOrderIdOrNull()

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

public inline const FString * GetOrderIdOrNull() const

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

public inline void SetOrderId(FString NewValue)

Sets the value of OrderId_Optional and also sets OrderId_IsSet to true.

public inline void ClearOrderId()

Clears the value of OrderId_Optional and sets OrderId_IsSet to false.

public inline TArray< FRHAPI_PlayerOrderEntryCreate> &GetEntries()

Gets the value of Entries.

public inline const TArray< FRHAPI_PlayerOrderEntryCreate> &GetEntries() const

Gets the value of Entries.

public inline void SetEntries(TArray< FRHAPI_PlayerOrderEntryCreate > NewValue)

Sets the value of Entries.