RHAPI_UpdateInventoryRequest
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_UpdateInventoryRequest | Request to Update an existing Inventory entry. If the Inventory entry does not exist, then the request will fail. |
struct FRHAPI_UpdateInventoryRequest
struct FRHAPI_UpdateInventoryRequest
: public FRHAPI_ModelRequest to Update an existing Inventory entry. If the Inventory entry does not exist, then the request will fail.
Summary
| Members | Descriptions |
|---|---|
public ERHAPI_Source Source_Optional | Source of this Inventory Operation. |
public bool Source_IsSet | true if Source_Optional has been set to a value |
public FGuid ClientOrderRefId_Optional | Arbitrary UUID that can be used by clients to correlate Order requests with Order responses. |
public bool ClientOrderRefId_IsSet | true if ClientOrderRefId_Optional has been set to a value |
public ERHAPI_InventoryBucket Bucket_Optional | Inventory Bucket for this Inventory Operation. |
public bool Bucket_IsSet | true if Bucket_Optional has been set to a value |
public int32 Count_Optional | Count for this Inventory Operation. |
public bool Count_IsSet | true if Count_Optional has been set to a value |
public FDateTime Expires_Optional | Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone. |
public bool Expires_IsSet | true if Expires_Optional has been set to a value |
public TMap< FString, FString > CustomData_Optional | Arbitrary data map that can be set to add additional data to Inventory. |
public bool CustomData_IsSet | true if CustomData_Optional has been set to a value |
public int32 ItemId_Optional | Item ID for this Inventory Operation. If the Item ID is not set during an Update Inventory Request, then the Item ID will not be modified on the existing Inventory Record. |
public bool ItemId_IsSet | true if ItemId_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_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_InventoryBucket & GetBucket() | Gets the value of Bucket_Optional, regardless of it having been set. |
public inline const ERHAPI_InventoryBucket & GetBucket() const | Gets the value of Bucket_Optional, regardless of it having been set. |
public inline const ERHAPI_InventoryBucket & GetBucket(const ERHAPI_InventoryBucket & DefaultValue) const | Gets the value of Bucket_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetBucket(ERHAPI_InventoryBucket & OutValue) const | Fills OutValue with the value of Bucket_Optional and returns true if it has been set, otherwise returns false. |
public inline ERHAPI_InventoryBucket * GetBucketOrNull() | Returns a pointer to Bucket_Optional, if it has been set, otherwise returns nullptr. |
public inline const ERHAPI_InventoryBucket * GetBucketOrNull() const | Returns a pointer to Bucket_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetBucket(ERHAPI_InventoryBucket NewValue) | Sets the value of Bucket_Optional and also sets Bucket_IsSet to true. |
public inline void ClearBucket() | Clears the value of Bucket_Optional and sets Bucket_IsSet to false. |
public inline int32 & GetCount() | Gets the value of Count_Optional, regardless of it having been set. |
public inline const int32 & GetCount() const | Gets the value of Count_Optional, regardless of it having been set. |
public inline const int32 & GetCount(const int32 & DefaultValue) const | Gets the value of Count_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetCount(int32 & OutValue) const | Fills OutValue with the value of Count_Optional and returns true if it has been set, otherwise returns false. |
public inline int32 * GetCountOrNull() | Returns a pointer to Count_Optional, if it has been set, otherwise returns nullptr. |
public inline const int32 * GetCountOrNull() const | Returns a pointer to Count_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetCount(int32 NewValue) | Sets the value of Count_Optional and also sets Count_IsSet to true. |
public inline void ClearCount() | Clears the value of Count_Optional and sets Count_IsSet to false. |
public inline bool IsCountDefaultValue() const | Returns true if Count_Optional is set and matches the default value. |
public inline void SetCountToDefault() | Sets the value of Count_Optional to its default and also sets Count_IsSet to true. |
public inline FDateTime & GetExpires() | Gets the value of Expires_Optional, regardless of it having been set. |
public inline const FDateTime & GetExpires() const | Gets the value of Expires_Optional, regardless of it having been set. |
public inline const FDateTime & GetExpires(const FDateTime & DefaultValue) const | Gets the value of Expires_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetExpires(FDateTime & OutValue) const | Fills OutValue with the value of Expires_Optional and returns true if it has been set, otherwise returns false. |
public inline FDateTime * GetExpiresOrNull() | Returns a pointer to Expires_Optional, if it has been set, otherwise returns nullptr. |
public inline const FDateTime * GetExpiresOrNull() const | Returns a pointer to Expires_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetExpires(FDateTime NewValue) | Sets the value of Expires_Optional and also sets Expires_IsSet to true. |
public inline void ClearExpires() | Clears the value of Expires_Optional and sets Expires_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. |
public inline int32 & GetItemId() | Gets the value of ItemId_Optional, regardless of it having been set. |
public inline const int32 & GetItemId() const | Gets the value of ItemId_Optional, regardless of it having been set. |
public inline const int32 & GetItemId(const int32 & DefaultValue) const | Gets the value of ItemId_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetItemId(int32 & OutValue) const | Fills OutValue with the value of ItemId_Optional and returns true if it has been set, otherwise returns false. |
public inline int32 * GetItemIdOrNull() | Returns a pointer to ItemId_Optional, if it has been set, otherwise returns nullptr. |
public inline const int32 * GetItemIdOrNull() const | Returns a pointer to ItemId_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetItemId(int32 NewValue) | Sets the value of ItemId_Optional and also sets ItemId_IsSet to true. |
public inline void ClearItemId() | Clears the value of ItemId_Optional and sets ItemId_IsSet to false. |
public inline bool IsItemIdDefaultValue() const | Returns true if ItemId_Optional is set and matches the default value. |
public inline void SetItemIdToDefault() | Sets the value of ItemId_Optional to its default and also sets ItemId_IsSet to true. |
Members
public ERHAPI_Source Source_Optional
Source of this Inventory Operation.
public bool Source_IsSet
true if Source_Optional has been set to a value
public FGuid ClientOrderRefId_Optional
Arbitrary UUID that can be used by clients to correlate Order requests with Order responses.
public bool ClientOrderRefId_IsSet
true if ClientOrderRefId_Optional has been set to a value
public ERHAPI_InventoryBucket Bucket_Optional
Inventory Bucket for this Inventory Operation.
public bool Bucket_IsSet
true if Bucket_Optional has been set to a value
public int32 Count_Optional
Count for this Inventory Operation.
public bool Count_IsSet
true if Count_Optional has been set to a value
public FDateTime Expires_Optional
Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.
public bool Expires_IsSet
true if Expires_Optional has been set to a value
public TMap< FString, FString > CustomData_Optional
Arbitrary data map that can be set to add additional data to Inventory.
public bool CustomData_IsSet
true if CustomData_Optional has been set to a value
public int32 ItemId_Optional
Item ID for this Inventory Operation. If the Item ID is not set during an Update Inventory Request, then the Item ID will not be modified on the existing Inventory Record.
public bool ItemId_IsSet
true if ItemId_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
JsonValueData 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
WriterJSON 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_InventoryBucket & GetBucket()
Gets the value of Bucket_Optional, regardless of it having been set.
public inline const ERHAPI_InventoryBucket & GetBucket() const
Gets the value of Bucket_Optional, regardless of it having been set.
public inline const ERHAPI_InventoryBucket & GetBucket(const ERHAPI_InventoryBucket & DefaultValue) const
Gets the value of Bucket_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetBucket(ERHAPI_InventoryBucket & OutValue) const
Fills OutValue with the value of Bucket_Optional and returns true if it has been set, otherwise returns false.
public inline ERHAPI_InventoryBucket * GetBucketOrNull()
Returns a pointer to Bucket_Optional, if it has been set, otherwise returns nullptr.
public inline const ERHAPI_InventoryBucket * GetBucketOrNull() const
Returns a pointer to Bucket_Optional, if it has been set, otherwise returns nullptr.
public inline void SetBucket(ERHAPI_InventoryBucket NewValue)
Sets the value of Bucket_Optional and also sets Bucket_IsSet to true.
public inline void ClearBucket()
Clears the value of Bucket_Optional and sets Bucket_IsSet to false.
public inline int32 & GetCount()
Gets the value of Count_Optional, regardless of it having been set.
public inline const int32 & GetCount() const
Gets the value of Count_Optional, regardless of it having been set.
public inline const int32 & GetCount(const int32 & DefaultValue) const
Gets the value of Count_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetCount(int32 & OutValue) const
Fills OutValue with the value of Count_Optional and returns true if it has been set, otherwise returns false.
public inline int32 * GetCountOrNull()
Returns a pointer to Count_Optional, if it has been set, otherwise returns nullptr.
public inline const int32 * GetCountOrNull() const
Returns a pointer to Count_Optional, if it has been set, otherwise returns nullptr.
public inline void SetCount(int32 NewValue)
Sets the value of Count_Optional and also sets Count_IsSet to true.
public inline void ClearCount()
Clears the value of Count_Optional and sets Count_IsSet to false.
public inline bool IsCountDefaultValue() const
Returns true if Count_Optional is set and matches the default value.
public inline void SetCountToDefault()
Sets the value of Count_Optional to its default and also sets Count_IsSet to true.
public inline FDateTime & GetExpires()
Gets the value of Expires_Optional, regardless of it having been set.
public inline const FDateTime & GetExpires() const
Gets the value of Expires_Optional, regardless of it having been set.
public inline const FDateTime & GetExpires(const FDateTime & DefaultValue) const
Gets the value of Expires_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetExpires(FDateTime & OutValue) const
Fills OutValue with the value of Expires_Optional and returns true if it has been set, otherwise returns false.
public inline FDateTime * GetExpiresOrNull()
Returns a pointer to Expires_Optional, if it has been set, otherwise returns nullptr.
public inline const FDateTime * GetExpiresOrNull() const
Returns a pointer to Expires_Optional, if it has been set, otherwise returns nullptr.
public inline void SetExpires(FDateTime NewValue)
Sets the value of Expires_Optional and also sets Expires_IsSet to true.
public inline void ClearExpires()
Clears the value of Expires_Optional and sets Expires_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.
public inline int32 & GetItemId()
Gets the value of ItemId_Optional, regardless of it having been set.
public inline const int32 & GetItemId() const
Gets the value of ItemId_Optional, regardless of it having been set.
public inline const int32 & GetItemId(const int32 & DefaultValue) const
Gets the value of ItemId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetItemId(int32 & OutValue) const
Fills OutValue with the value of ItemId_Optional and returns true if it has been set, otherwise returns false.
public inline int32 * GetItemIdOrNull()
Returns a pointer to ItemId_Optional, if it has been set, otherwise returns nullptr.
public inline const int32 * GetItemIdOrNull() const
Returns a pointer to ItemId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetItemId(int32 NewValue)
Sets the value of ItemId_Optional and also sets ItemId_IsSet to true.
public inline void ClearItemId()
Clears the value of ItemId_Optional and sets ItemId_IsSet to false.
public inline bool IsItemIdDefaultValue() const
Returns true if ItemId_Optional is set and matches the default value.
public inline void SetItemIdToDefault()
Sets the value of ItemId_Optional to its default and also sets ItemId_IsSet to true.