RHAPI_PlatformEntitlementProcessRequest
Summary
Members | Descriptions |
---|---|
struct FRHAPI_PlatformEntitlementProcessRequest | Request to process a platform entitlement. |
struct FRHAPI_PlatformEntitlementProcessRequest
struct FRHAPI_PlatformEntitlementProcessRequest
: public FRHAPI_Model
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
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.
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 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.