RHAPI_PlatformEntitlementProcessRequest
Summary
Members | Descriptions |
---|---|
struct FRHAPI_PlatformEntitlementProcessRequest | Request to process a platform entitlement. |
struct FRHAPI_PlatformEntitlementProcessRequest
Request to process a platform entitlement.
Summary
Members | Descriptions |
---|---|
public FString TransactionId | unique id for this transaction on the platform |
public FString PlatformToken | Platform token that can be used to verify the identity of the user. |
public FString PlatformId | Platform this entitlement was purchased was made on. |
public ERHAPI_PlatformRegion PlatformRegion | region this purchase was made in |
public ERHAPI_ClientType ClientType | client type this purchase was made on |
public TArray< FRHAPI_PlatformEntitlement > Entitlements_Optional | Platform entitlements to process. |
public bool Entitlements_IsSet | true if Entitlements_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 & GetTransactionId () | Gets the value of TransactionId. |
public inline const FString & GetTransactionId () const | Gets the value of TransactionId. |
public inline void SetTransactionId (FString NewValue) | Sets the value of TransactionId. |
public inline FString & GetPlatformToken () | Gets the value of PlatformToken. |
public inline const FString & GetPlatformToken () const | Gets the value of PlatformToken. |
public inline void SetPlatformToken (FString NewValue) | Sets the value of PlatformToken. |
public inline FString & GetPlatformId () | Gets the value of PlatformId. |
public inline const FString & GetPlatformId () const | Gets the value of PlatformId. |
public inline void SetPlatformId (FString NewValue) | Sets the value of PlatformId. |
public inline ERHAPI_PlatformRegion & GetPlatformRegion () | Gets the value of PlatformRegion. |
public inline const ERHAPI_PlatformRegion & GetPlatformRegion () const | Gets the value of PlatformRegion. |
public inline void SetPlatformRegion (ERHAPI_PlatformRegion NewValue) | Sets the value of PlatformRegion. |
public inline ERHAPI_ClientType & GetClientType () | Gets the value of ClientType. |
public inline const ERHAPI_ClientType & GetClientType () const | Gets the value of ClientType. |
public inline void SetClientType (ERHAPI_ClientType NewValue) | Sets the value of ClientType. |
public inline TArray< FRHAPI_PlatformEntitlement > & GetEntitlements () | Gets the value of Entitlements_Optional, regardless of it having been set. |
public inline const TArray< FRHAPI_PlatformEntitlement > & GetEntitlements () const | Gets the value of Entitlements_Optional, regardless of it having been set. |
public inline const TArray< FRHAPI_PlatformEntitlement > & GetEntitlements (const TArray< FRHAPI_PlatformEntitlement > & DefaultValue) const | Gets the value of Entitlements_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetEntitlements (TArray< FRHAPI_PlatformEntitlement > & OutValue) const | Fills OutValue with the value of Entitlements_Optional and returns true if it has been set, otherwise returns false. |
public inline TArray< FRHAPI_PlatformEntitlement > * GetEntitlementsOrNull () | Returns a pointer to Entitlements_Optional, if it has been set, otherwise returns nullptr. |
public inline const TArray< FRHAPI_PlatformEntitlement > * GetEntitlementsOrNull () const | Returns a pointer to Entitlements_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetEntitlements (TArray< FRHAPI_PlatformEntitlement > NewValue) | Sets the value of Entitlements_Optional and also sets Entitlements_IsSet to true. |
public inline void ClearEntitlements () | Clears the value of Entitlements_Optional and sets Entitlements_IsSet to false. |
Members
public FString
TransactionId
unique id for this transaction on the platform
#### `public FString `[`PlatformToken`](#structFRHAPI__PlatformEntitlementProcessRequest_1a746f9d065dc766bde99e6444dccd5d32)
Platform token that can be used to verify the identity of the user.
#### `public FString `[`PlatformId`](#structFRHAPI__PlatformEntitlementProcessRequest_1aecab53e4d07a58f9224c82ad6da8c2c6)
Platform this entitlement was purchased was made on.
#### `public ERHAPI_PlatformRegion `[`PlatformRegion`](#structFRHAPI__PlatformEntitlementProcessRequest_1a72ee6aadcdaa3a4c8bf1e482694d14db)
region this purchase was made in
#### `public ERHAPI_ClientType `[`ClientType`](#structFRHAPI__PlatformEntitlementProcessRequest_1a9674cba794d55a042afd6040cbf260a7)
client type this purchase was made on
#### `public TArray< `[`FRHAPI_PlatformEntitlement`](RHAPI_PlatformEntitlement.md#structFRHAPI__PlatformEntitlement)` > `[`Entitlements_Optional`](#structFRHAPI__PlatformEntitlementProcessRequest_1adffb3e1d7d754a5bf42491736b963426)
Platform entitlements to process.
#### `public bool `[`Entitlements_IsSet`](#structFRHAPI__PlatformEntitlementProcessRequest_1a1182b812111a8390a0f9ba60649e0755)
true if Entitlements_Optional has been set to a value
#### `public virtual bool `[`FromJson`](#structFRHAPI__PlatformEntitlementProcessRequest_1a4748b946408ef3779d62d3cc9518c16a)`(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`](#structFRHAPI__PlatformEntitlementProcessRequest_1af0754b911184c7a6b5bb0efc399ff22b)`(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 FString & `[`GetTransactionId`](#structFRHAPI__PlatformEntitlementProcessRequest_1a51301f3004ef1dbbaf6340a1d18d5ff8)`()`
Gets the value of TransactionId.
#### `public inline const FString & `[`GetTransactionId`](#structFRHAPI__PlatformEntitlementProcessRequest_1aadf7387ad49aafa891f81900413c8df7)`() const`
Gets the value of TransactionId.
#### `public inline void `[`SetTransactionId`](#structFRHAPI__PlatformEntitlementProcessRequest_1ac826ac5ce2ab0999dc8d40a1789c5172)`(FString NewValue)`
Sets the value of TransactionId.
#### `public inline FString & `[`GetPlatformToken`](#structFRHAPI__PlatformEntitlementProcessRequest_1a46c556ef651d060f6d30bb51cf6f6a34)`()`
Gets the value of PlatformToken.
#### `public inline const FString & `[`GetPlatformToken`](#structFRHAPI__PlatformEntitlementProcessRequest_1a6cd05cb4e91dab59f3ce419454a7b915)`() const`
Gets the value of PlatformToken.
#### `public inline void `[`SetPlatformToken`](#structFRHAPI__PlatformEntitlementProcessRequest_1a63265337309b5ef52f5fce355b035b96)`(FString NewValue)`
Sets the value of PlatformToken.
#### `public inline FString & `[`GetPlatformId`](#structFRHAPI__PlatformEntitlementProcessRequest_1a45d91a4c47c73b3b28382d05e785ea0d)`()`
Gets the value of PlatformId.
#### `public inline const FString & `[`GetPlatformId`](#structFRHAPI__PlatformEntitlementProcessRequest_1ab89c3edcccc8bc9d465296a82dec2976)`() const`
Gets the value of PlatformId.
#### `public inline void `[`SetPlatformId`](#structFRHAPI__PlatformEntitlementProcessRequest_1ae74dc5c9f4b4dd92b814be44dda4e2ba)`(FString NewValue)`
Sets the value of PlatformId.
#### `public inline ERHAPI_PlatformRegion & `[`GetPlatformRegion`](#structFRHAPI__PlatformEntitlementProcessRequest_1ab827b8b08f6bc72dc2cdf3626deb7f19)`()`
Gets the value of PlatformRegion.
#### `public inline const ERHAPI_PlatformRegion & `[`GetPlatformRegion`](#structFRHAPI__PlatformEntitlementProcessRequest_1a8c0ca241313bb3e2f1d0d173a23dc372)`() const`
Gets the value of PlatformRegion.
#### `public inline void `[`SetPlatformRegion`](#structFRHAPI__PlatformEntitlementProcessRequest_1a80832fbb3596577cf4a49c020951b15d)`(ERHAPI_PlatformRegion NewValue)`
Sets the value of PlatformRegion.
#### `public inline ERHAPI_ClientType & `[`GetClientType`](#structFRHAPI__PlatformEntitlementProcessRequest_1a89fcf5846ed78023c699b6ca31d7c275)`()`
Gets the value of ClientType.
#### `public inline const ERHAPI_ClientType & `[`GetClientType`](#structFRHAPI__PlatformEntitlementProcessRequest_1a1e2eb1ee2959340470e82afb81ceea75)`() const`
Gets the value of ClientType.
#### `public inline void `[`SetClientType`](#structFRHAPI__PlatformEntitlementProcessRequest_1a07f9403c901988ddb953920bfaa4e0f6)`(ERHAPI_ClientType NewValue)`
Sets the value of ClientType.
#### `public inline TArray< `[`FRHAPI_PlatformEntitlement`](RHAPI_PlatformEntitlement.md#structFRHAPI__PlatformEntitlement)` > & `[`GetEntitlements`](#structFRHAPI__PlatformEntitlementProcessRequest_1a601120e574160eca58e98170e9d4b4e7)`()`
Gets the value of Entitlements_Optional, regardless of it having been set.
#### `public inline const TArray< `[`FRHAPI_PlatformEntitlement`](RHAPI_PlatformEntitlement.md#structFRHAPI__PlatformEntitlement)` > & `[`GetEntitlements`](#structFRHAPI__PlatformEntitlementProcessRequest_1a5e5780d5354d2f2e6a60d18933840e14)`() const`
Gets the value of Entitlements_Optional, regardless of it having been set.
#### `public inline const TArray< `[`FRHAPI_PlatformEntitlement`](RHAPI_PlatformEntitlement.md#structFRHAPI__PlatformEntitlement)` > & `[`GetEntitlements`](#structFRHAPI__PlatformEntitlementProcessRequest_1a375ef768b008aa6ecadbc0b2a4062761)`(const TArray< `[`FRHAPI_PlatformEntitlement`](RHAPI_PlatformEntitlement.md#structFRHAPI__PlatformEntitlement)` > & DefaultValue) const`
Gets the value of Entitlements_Optional, if it has been set, otherwise it returns DefaultValue.
#### `public inline bool `[`GetEntitlements`](#structFRHAPI__PlatformEntitlementProcessRequest_1ac72ca2c63c2fc3f571fb4475cbd96f82)`(TArray< `[`FRHAPI_PlatformEntitlement`](RHAPI_PlatformEntitlement.md#structFRHAPI__PlatformEntitlement)` > & OutValue) const`
Fills OutValue with the value of Entitlements_Optional and returns true if it has been set, otherwise returns false.
#### `public inline TArray< `[`FRHAPI_PlatformEntitlement`](RHAPI_PlatformEntitlement.md#structFRHAPI__PlatformEntitlement)` > * `[`GetEntitlementsOrNull`](#structFRHAPI__PlatformEntitlementProcessRequest_1ad288e59a3bc25d6f4f6c33b802d38fdf)`()`
Returns a pointer to Entitlements_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const TArray< `[`FRHAPI_PlatformEntitlement`](RHAPI_PlatformEntitlement.md#structFRHAPI__PlatformEntitlement)` > * `[`GetEntitlementsOrNull`](#structFRHAPI__PlatformEntitlementProcessRequest_1addaede490193b8714cdf49552bceeac2)`() const`
Returns a pointer to Entitlements_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetEntitlements`](#structFRHAPI__PlatformEntitlementProcessRequest_1add57dd436f6402d835ebe33e4d76305b)`(TArray< `[`FRHAPI_PlatformEntitlement`](RHAPI_PlatformEntitlement.md#structFRHAPI__PlatformEntitlement)` > NewValue)`
Sets the value of Entitlements_Optional and also sets Entitlements_IsSet to true.
#### `public inline void `[`ClearEntitlements`](#structFRHAPI__PlatformEntitlementProcessRequest_1a9493313ad553516ff62bf102065e1344)`()`
Clears the value of Entitlements_Optional and sets Entitlements_IsSet to false.