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_Model
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.
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(const FString & NewValue) | Sets the value of PlatformSku. |
public inline void SetPlatformSku(FString && NewValue) | Sets the value of PlatformSku using move semantics. |
public inline FString & GetPlatformEntitlementId() | Gets the value of PlatformEntitlementId. |
public inline const FString & GetPlatformEntitlementId() const | Gets the value of PlatformEntitlementId. |
public inline void SetPlatformEntitlementId(const FString & NewValue) | Sets the value of PlatformEntitlementId. |
public inline void SetPlatformEntitlementId(FString && NewValue) | Sets the value of PlatformEntitlementId using move semantics. |
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(const int32 & NewValue) | Sets the value of Quantity_Optional and also sets Quantity_IsSet to true. |
public inline void SetQuantity(int32 && NewValue) | Sets the value of Quantity_Optional and also sets Quantity_IsSet to true using move semantics. |
public inline void ClearQuantity() | Clears the value of Quantity_Optional and sets Quantity_IsSet to false. |
public inline bool IsQuantitySet() const | Checks whether Quantity_Optional has been set. |
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(const ERHAPI_EntitlementStatus & NewValue) | Sets the value of Status_Optional and also sets Status_IsSet to true. |
public inline void SetStatus(ERHAPI_EntitlementStatus && NewValue) | Sets the value of Status_Optional and also sets Status_IsSet to true using move semantics. |
public inline void ClearStatus() | Clears the value of Status_Optional and sets Status_IsSet to false. |
public inline bool IsStatusSet() const | Checks whether Status_Optional has been set. |
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(const ERHAPI_EntitlementErrorCode & NewValue) | Sets the value of ErrorCode_Optional and also sets ErrorCode_IsSet to true. |
public inline void SetErrorCode(ERHAPI_EntitlementErrorCode && NewValue) | Sets the value of ErrorCode_Optional and also sets ErrorCode_IsSet to true using move semantics. |
public inline void ClearErrorCode() | Clears the value of ErrorCode_Optional and sets ErrorCode_IsSet to false. |
public inline bool IsErrorCodeSet() const | Checks whether ErrorCode_Optional has been set. |
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(const FString & NewValue) | Sets the value of OrderId_Optional and also sets OrderId_IsSet to true. |
public inline void SetOrderId(FString && NewValue) | Sets the value of OrderId_Optional and also sets OrderId_IsSet to true using move semantics. |
public inline void ClearOrderId() | Clears the value of OrderId_Optional and sets OrderId_IsSet to false. |
public inline bool IsOrderIdSet() const | Checks whether OrderId_Optional has been set. |
Members
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.
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 FString & GetPlatformSku()
Gets the value of PlatformSku.
public inline const FString & GetPlatformSku() const
Gets the value of PlatformSku.
public inline void SetPlatformSku(const FString & NewValue)
Sets the value of PlatformSku.
public inline void SetPlatformSku(FString && NewValue)
Sets the value of PlatformSku using move semantics.
public inline FString & GetPlatformEntitlementId()
Gets the value of PlatformEntitlementId.
public inline const FString & GetPlatformEntitlementId() const
Gets the value of PlatformEntitlementId.
public inline void SetPlatformEntitlementId(const FString & NewValue)
Sets the value of PlatformEntitlementId.
public inline void SetPlatformEntitlementId(FString && NewValue)
Sets the value of PlatformEntitlementId using move semantics.
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(const int32 & NewValue)
Sets the value of Quantity_Optional and also sets Quantity_IsSet to true.
public inline void SetQuantity(int32 && NewValue)
Sets the value of Quantity_Optional and also sets Quantity_IsSet to true using move semantics.
public inline void ClearQuantity()
Clears the value of Quantity_Optional and sets Quantity_IsSet to false.
public inline bool IsQuantitySet() const
Checks whether Quantity_Optional has been set.
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(const ERHAPI_EntitlementStatus & NewValue)
Sets the value of Status_Optional and also sets Status_IsSet to true.
public inline void SetStatus(ERHAPI_EntitlementStatus && NewValue)
Sets the value of Status_Optional and also sets Status_IsSet to true using move semantics.
public inline void ClearStatus()
Clears the value of Status_Optional and sets Status_IsSet to false.
public inline bool IsStatusSet() const
Checks whether Status_Optional has been set.
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(const ERHAPI_EntitlementErrorCode & NewValue)
Sets the value of ErrorCode_Optional and also sets ErrorCode_IsSet to true.
public inline void SetErrorCode(ERHAPI_EntitlementErrorCode && NewValue)
Sets the value of ErrorCode_Optional and also sets ErrorCode_IsSet to true using move semantics.
public inline void ClearErrorCode()
Clears the value of ErrorCode_Optional and sets ErrorCode_IsSet to false.
public inline bool IsErrorCodeSet() const
Checks whether ErrorCode_Optional has been set.
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(const FString & NewValue)
Sets the value of OrderId_Optional and also sets OrderId_IsSet to true.
public inline void SetOrderId(FString && NewValue)
Sets the value of OrderId_Optional and also sets OrderId_IsSet to true using move semantics.
public inline void ClearOrderId()
Clears the value of OrderId_Optional and sets OrderId_IsSet to false.
public inline bool IsOrderIdSet() const
Checks whether OrderId_Optional has been set.