RHAPI_PlatformEntitlement
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_PlatformEntitlement | Entitlement for a platform. This takes in a sku and platform entitlement id and checks to see if the user has the entitlement on the platform. |
struct FRHAPI_PlatformEntitlement
struct FRHAPI_PlatformEntitlement : public FRHAPI_ModelEntitlement for a platform. This takes in a sku and platform entitlement id and checks to see if the user has the entitlement on the platform.
Summary
| Members | Descriptions |
|---|---|
public FString PlatformSku | platform identifier for this purchase type |
public FString PlatformEntitlementId | unique identifier for this purchased item (instance owned by this user) |
public int32 Quantity_Optional | number purchased |
public bool Quantity_IsSet | true if Quantity_Optional has been set to a value |
public ERHAPI_EntitlementStatus Status_Optional | status of this entitlement |
public bool Status_IsSet | true if Status_Optional has been set to a value |
public ERHAPI_EntitlementErrorCode ErrorCode_Optional | Error code for this entitlement. |
public bool ErrorCode_IsSet | true if ErrorCode_Optional has been set to a value |
public FString OrderId_Optional | Order ID for this entitlement. |
public bool OrderId_IsSet | true if OrderId_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 FString & GetPlatformSku() | Gets the value of PlatformSku. |
public inline const FString & GetPlatformSku() const | Gets the value of PlatformSku. |
public inline void SetPlatformSku(FString NewValue) | Sets the value of PlatformSku. |
public inline FString & GetPlatformEntitlementId() | Gets the value of PlatformEntitlementId. |
public inline const FString & GetPlatformEntitlementId() const | Gets the value of PlatformEntitlementId. |
public inline void SetPlatformEntitlementId(FString NewValue) | Sets the value of PlatformEntitlementId. |
public inline int32 & GetQuantity() | Gets the value of Quantity_Optional, regardless of it having been set. |
public inline const int32 & GetQuantity() const | Gets the value of Quantity_Optional, regardless of it having been set. |
public inline const int32 & GetQuantity(const int32 & DefaultValue) const | Gets the value of Quantity_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetQuantity(int32 & OutValue) const | Fills OutValue with the value of Quantity_Optional and returns true if it has been set, otherwise returns false. |
public inline int32 * GetQuantityOrNull() | Returns a pointer to Quantity_Optional, if it has been set, otherwise returns nullptr. |
public inline const int32 * GetQuantityOrNull() const | Returns a pointer to Quantity_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetQuantity(int32 NewValue) | Sets the value of Quantity_Optional and also sets Quantity_IsSet to true. |
public inline void ClearQuantity() | Clears the value of Quantity_Optional and sets Quantity_IsSet to false. |
public inline bool IsQuantityDefaultValue() const | Returns true if Quantity_Optional is set and matches the default value. |
public inline void SetQuantityToDefault() | Sets the value of Quantity_Optional to its default and also sets Quantity_IsSet to true. |
public inline ERHAPI_EntitlementStatus & GetStatus() | Gets the value of Status_Optional, regardless of it having been set. |
public inline const ERHAPI_EntitlementStatus & GetStatus() const | Gets the value of Status_Optional, regardless of it having been set. |
public inline const ERHAPI_EntitlementStatus & GetStatus(const ERHAPI_EntitlementStatus & DefaultValue) const | Gets the value of Status_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetStatus(ERHAPI_EntitlementStatus & OutValue) const | Fills OutValue with the value of Status_Optional and returns true if it has been set, otherwise returns false. |
public inline ERHAPI_EntitlementStatus * GetStatusOrNull() | Returns a pointer to Status_Optional, if it has been set, otherwise returns nullptr. |
public inline const ERHAPI_EntitlementStatus * GetStatusOrNull() const | Returns a pointer to Status_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetStatus(ERHAPI_EntitlementStatus 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 ERHAPI_EntitlementErrorCode & GetErrorCode() | Gets the value of ErrorCode_Optional, regardless of it having been set. |
public inline const ERHAPI_EntitlementErrorCode & GetErrorCode() const | Gets the value of ErrorCode_Optional, regardless of it having been set. |
public inline const ERHAPI_EntitlementErrorCode & GetErrorCode(const ERHAPI_EntitlementErrorCode & DefaultValue) const | Gets the value of ErrorCode_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetErrorCode(ERHAPI_EntitlementErrorCode & OutValue) const | Fills OutValue with the value of ErrorCode_Optional and returns true if it has been set, otherwise returns false. |
public inline ERHAPI_EntitlementErrorCode * GetErrorCodeOrNull() | Returns a pointer to ErrorCode_Optional, if it has been set, otherwise returns nullptr. |
public inline const ERHAPI_EntitlementErrorCode * GetErrorCodeOrNull() const | Returns a pointer to ErrorCode_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetErrorCode(ERHAPI_EntitlementErrorCode NewValue) | Sets the value of ErrorCode_Optional and also sets ErrorCode_IsSet to true. |
public inline void ClearErrorCode() | Clears the value of ErrorCode_Optional and sets ErrorCode_IsSet to false. |
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. |
Members
public FString PlatformSku
platform identifier for this purchase type
#### `public FString `[`PlatformEntitlementId`](#structFRHAPI__PlatformEntitlement_1a1f0da440869af28c6c1fa699f6a203c3)
unique identifier for this purchased item (instance owned by this user)
#### `public int32 `[`Quantity_Optional`](#structFRHAPI__PlatformEntitlement_1a2b26f0881eee1e31938f8b08dd6b8213)
number purchased
#### `public bool `[`Quantity_IsSet`](#structFRHAPI__PlatformEntitlement_1ae90d971477356498b773361d21b0aec5)
true if Quantity_Optional has been set to a value
#### `public ERHAPI_EntitlementStatus `[`Status_Optional`](#structFRHAPI__PlatformEntitlement_1a790f0f33a52b22044781553c8dc89e9c)
status of this entitlement
#### `public bool `[`Status_IsSet`](#structFRHAPI__PlatformEntitlement_1adfaea0a1a88f96e0df831b5317fb9727)
true if Status_Optional has been set to a value
#### `public ERHAPI_EntitlementErrorCode `[`ErrorCode_Optional`](#structFRHAPI__PlatformEntitlement_1abc192a6b19ae2f8d78e3ab8f2bd327ad)
Error code for this entitlement.
#### `public bool `[`ErrorCode_IsSet`](#structFRHAPI__PlatformEntitlement_1a158a8da1519ab450f6b69a06c39125e4)
true if ErrorCode_Optional has been set to a value
#### `public FString `[`OrderId_Optional`](#structFRHAPI__PlatformEntitlement_1a6ccc74894efd1734a3039280c70e2cb4)
Order ID for this entitlement.
#### `public bool `[`OrderId_IsSet`](#structFRHAPI__PlatformEntitlement_1a2f2afbbb21016ec66a725cfe7d1406a6)
true if OrderId_Optional has been set to a value
#### `public virtual bool `[`FromJson`](#structFRHAPI__PlatformEntitlement_1ad434bfd6f81b303cdc2dea8d8680767c)`(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__PlatformEntitlement_1ac19edbfa175263473d02d08ce522ee75)`(TSharedRef< TJsonWriter<>> & Writer) const`
Writes the data from this object into the specified JSON Writer stream.
Parameters
WriterJSON Writer stream to push .
#### `public inline FString & `[`GetPlatformSku`](#structFRHAPI__PlatformEntitlement_1ae7d2f3e8ca78bf11f59cba1875d6db13)`()`
Gets the value of PlatformSku.
#### `public inline const FString & `[`GetPlatformSku`](#structFRHAPI__PlatformEntitlement_1a0986b55ae5a48616adafaf6125e3c1b3)`() const`
Gets the value of PlatformSku.
#### `public inline void `[`SetPlatformSku`](#structFRHAPI__PlatformEntitlement_1a9b857b2419b5825b33403ac40e664b8d)`(FString NewValue)`
Sets the value of PlatformSku.
#### `public inline FString & `[`GetPlatformEntitlementId`](#structFRHAPI__PlatformEntitlement_1a0688e6c9bdd3ea103f5b1601740d4615)`()`
Gets the value of PlatformEntitlementId.
#### `public inline const FString & `[`GetPlatformEntitlementId`](#structFRHAPI__PlatformEntitlement_1a45d894828451cafffd0a2675c14e87ac)`() const`
Gets the value of PlatformEntitlementId.
#### `public inline void `[`SetPlatformEntitlementId`](#structFRHAPI__PlatformEntitlement_1afba2455c3636f607230c156933f44a0e)`(FString NewValue)`
Sets the value of PlatformEntitlementId.
#### `public inline int32 & `[`GetQuantity`](#structFRHAPI__PlatformEntitlement_1a002b3e61860cdc0f8de9e81920d21544)`()`
Gets the value of Quantity_Optional, regardless of it having been set.
#### `public inline const int32 & `[`GetQuantity`](#structFRHAPI__PlatformEntitlement_1a087fe561641b9e08cc343a0afa374104)`() const`
Gets the value of Quantity_Optional, regardless of it having been set.
#### `public inline const int32 & `[`GetQuantity`](#structFRHAPI__PlatformEntitlement_1aaebc1948b6076293d6cb123543b4b890)`(const int32 & DefaultValue) const`
Gets the value of Quantity_Optional, if it has been set, otherwise it returns DefaultValue.
#### `public inline bool `[`GetQuantity`](#structFRHAPI__PlatformEntitlement_1adc2c8f58a43f1f99de209a3efb45f0f0)`(int32 & OutValue) const`
Fills OutValue with the value of Quantity_Optional and returns true if it has been set, otherwise returns false.
#### `public inline int32 * `[`GetQuantityOrNull`](#structFRHAPI__PlatformEntitlement_1ac82d77308557984168a59d8c113fee90)`()`
Returns a pointer to Quantity_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const int32 * `[`GetQuantityOrNull`](#structFRHAPI__PlatformEntitlement_1a96d97b68fbcc7074a86bf4fc35351789)`() const`
Returns a pointer to Quantity_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetQuantity`](#structFRHAPI__PlatformEntitlement_1ae18417879b10f68f0e2395327846da1d)`(int32 NewValue)`
Sets the value of Quantity_Optional and also sets Quantity_IsSet to true.
#### `public inline void `[`ClearQuantity`](#structFRHAPI__PlatformEntitlement_1a0a7253e3dc98331cb4688fadb3d5ba17)`()`
Clears the value of Quantity_Optional and sets Quantity_IsSet to false.
#### `public inline bool `[`IsQuantityDefaultValue`](#structFRHAPI__PlatformEntitlement_1a5dcfd409121d5748761dd5bc2c37ff51)`() const`
Returns true if Quantity_Optional is set and matches the default value.
#### `public inline void `[`SetQuantityToDefault`](#structFRHAPI__PlatformEntitlement_1a1cbce8267d138f0f12f14137240d78ac)`()`
Sets the value of Quantity_Optional to its default and also sets Quantity_IsSet to true.
#### `public inline ERHAPI_EntitlementStatus & `[`GetStatus`](#structFRHAPI__PlatformEntitlement_1a2e982caa2328108860765ab490dfe5b7)`()`
Gets the value of Status_Optional, regardless of it having been set.
#### `public inline const ERHAPI_EntitlementStatus & `[`GetStatus`](#structFRHAPI__PlatformEntitlement_1adb079b4db7bb40cbcd8d432813797bfe)`() const`
Gets the value of Status_Optional, regardless of it having been set.
#### `public inline const ERHAPI_EntitlementStatus & `[`GetStatus`](#structFRHAPI__PlatformEntitlement_1ae2552c0a2dcc6564a938c54e25702654)`(const ERHAPI_EntitlementStatus & DefaultValue) const`
Gets the value of Status_Optional, if it has been set, otherwise it returns DefaultValue.
#### `public inline bool `[`GetStatus`](#structFRHAPI__PlatformEntitlement_1a20ac5c33deadc2a4890887f370090097)`(ERHAPI_EntitlementStatus & OutValue) const`
Fills OutValue with the value of Status_Optional and returns true if it has been set, otherwise returns false.
#### `public inline ERHAPI_EntitlementStatus * `[`GetStatusOrNull`](#structFRHAPI__PlatformEntitlement_1aaaf1a94b632794d2d692e11b8dad95a6)`()`
Returns a pointer to Status_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const ERHAPI_EntitlementStatus * `[`GetStatusOrNull`](#structFRHAPI__PlatformEntitlement_1a40687660af89a86b01ec787a7185a87d)`() const`
Returns a pointer to Status_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetStatus`](#structFRHAPI__PlatformEntitlement_1ab9c910f529e6a2559087f2e2d43ee32d)`(ERHAPI_EntitlementStatus NewValue)`
Sets the value of Status_Optional and also sets Status_IsSet to true.
#### `public inline void `[`ClearStatus`](#structFRHAPI__PlatformEntitlement_1a557a01818d6f93c0569b40045cc3553a)`()`
Clears the value of Status_Optional and sets Status_IsSet to false.
#### `public inline ERHAPI_EntitlementErrorCode & `[`GetErrorCode`](#structFRHAPI__PlatformEntitlement_1a0b8960e457476470835cf61413d86c6a)`()`
Gets the value of ErrorCode_Optional, regardless of it having been set.
#### `public inline const ERHAPI_EntitlementErrorCode & `[`GetErrorCode`](#structFRHAPI__PlatformEntitlement_1a0b9c276c6fb05342bc223b09d7a866f7)`() const`
Gets the value of ErrorCode_Optional, regardless of it having been set.
#### `public inline const ERHAPI_EntitlementErrorCode & `[`GetErrorCode`](#structFRHAPI__PlatformEntitlement_1aa5d119d04de715b1228616c33d15cd21)`(const ERHAPI_EntitlementErrorCode & DefaultValue) const`
Gets the value of ErrorCode_Optional, if it has been set, otherwise it returns DefaultValue.
#### `public inline bool `[`GetErrorCode`](#structFRHAPI__PlatformEntitlement_1a2badbfc83f26e36105d15b8e982946d1)`(ERHAPI_EntitlementErrorCode & OutValue) const`
Fills OutValue with the value of ErrorCode_Optional and returns true if it has been set, otherwise returns false.
#### `public inline ERHAPI_EntitlementErrorCode * `[`GetErrorCodeOrNull`](#structFRHAPI__PlatformEntitlement_1a00ac801ee6920efdcf72db7f9d3cc5d1)`()`
Returns a pointer to ErrorCode_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const ERHAPI_EntitlementErrorCode * `[`GetErrorCodeOrNull`](#structFRHAPI__PlatformEntitlement_1a7c276c46c7f48c19b74c7cae3c3f0b03)`() const`
Returns a pointer to ErrorCode_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetErrorCode`](#structFRHAPI__PlatformEntitlement_1a56d02493d37af931b3c4ee015b8b2178)`(ERHAPI_EntitlementErrorCode NewValue)`
Sets the value of ErrorCode_Optional and also sets ErrorCode_IsSet to true.
#### `public inline void `[`ClearErrorCode`](#structFRHAPI__PlatformEntitlement_1a51228045f457ea6ce4192f90412e9ed5)`()`
Clears the value of ErrorCode_Optional and sets ErrorCode_IsSet to false.
#### `public inline FString & `[`GetOrderId`](#structFRHAPI__PlatformEntitlement_1a900cf29d0018f48bf03f0430f4f7170b)`()`
Gets the value of OrderId_Optional, regardless of it having been set.
#### `public inline const FString & `[`GetOrderId`](#structFRHAPI__PlatformEntitlement_1a2e643832eed9c113e0f483940e3fd957)`() const`
Gets the value of OrderId_Optional, regardless of it having been set.
#### `public inline const FString & `[`GetOrderId`](#structFRHAPI__PlatformEntitlement_1a58b16ad4940cebd4fee4b39a34a6a871)`(const FString & DefaultValue) const`
Gets the value of OrderId_Optional, if it has been set, otherwise it returns DefaultValue.
#### `public inline bool `[`GetOrderId`](#structFRHAPI__PlatformEntitlement_1a86aaafe683e1976797b54975c5d5239c)`(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`](#structFRHAPI__PlatformEntitlement_1accf5583e50818353ba58714c5318f9c5)`()`
Returns a pointer to OrderId_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const FString * `[`GetOrderIdOrNull`](#structFRHAPI__PlatformEntitlement_1a80209701629609076c418db7a136e3dd)`() const`
Returns a pointer to OrderId_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetOrderId`](#structFRHAPI__PlatformEntitlement_1ac0a69f4efbf33d8204f59c809393fea8)`(FString NewValue)`
Sets the value of OrderId_Optional and also sets OrderId_IsSet to true.
#### `public inline void `[`ClearOrderId`](#structFRHAPI__PlatformEntitlement_1aced25565f90e25790e543b78dc85432f)`()`
Clears the value of OrderId_Optional and sets OrderId_IsSet to false.