RHAPI_PlatformEntitlementProcessResult
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_PlatformEntitlementProcessResult | Result of processing a platform entitlement. |
struct FRHAPI_PlatformEntitlementProcessResult
struct FRHAPI_PlatformEntitlementProcessResult
: public FRHAPI_Model
Result of processing a platform entitlement.
Summary
| Members | Descriptions |
|---|---|
public FString RequestId | unique id to allow tracking the request |
public ERHAPI_ClientType ClientType | client type this purchase was made on |
public FString TransactionId | unique id for this transaction on the platform |
public ERHAPI_PlatformRegion PlatformRegion | region this purchase was made in |
public FString Status_Optional | status of this result |
public bool Status_IsSet | true if Status_Optional has been set to a value |
public FString ErrorCode_Optional | Error code for failures not associated with a specific entitlement. |
public bool ErrorCode_IsSet | true if ErrorCode_Optional has been set to a value |
public TArray< FRHAPI_PlatformEntitlement>ClientEntitlements_Optional | Client entitlements that have been processed. |
public bool ClientEntitlements_IsSet | true if ClientEntitlements_Optional has been set to a value |
public TArray< FRHAPI_PlatformEntitlement>ServerEntitlements_Optional | Server entitlements that have been processed. |
public bool ServerEntitlements_IsSet | true if ServerEntitlements_Optional has been set to a value |
public ERHAPI_Platform PlatformId | Platform these transactions were processed on. |
public FString PlatformUserId | Unique identifier for the platform user that processed this entitlement. |
public bool SkippedServerEntitlements_Optional | True if the server entitlements were skipped. |
public bool SkippedServerEntitlements_IsSet | true if SkippedServerEntitlements_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 & GetRequestId() | Gets the value of RequestId. |
public inline const FString & GetRequestId() const | Gets the value of RequestId. |
public inline void SetRequestId(const FString & NewValue) | Sets the value of RequestId. |
public inline void SetRequestId(FString && NewValue) | Sets the value of RequestId using move semantics. |
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(const ERHAPI_ClientType & NewValue) | Sets the value of ClientType. |
public inline void SetClientType(ERHAPI_ClientType && NewValue) | Sets the value of ClientType using move semantics. |
public inline FString & GetTransactionId() | Gets the value of TransactionId. |
public inline const FString & GetTransactionId() const | Gets the value of TransactionId. |
public inline void SetTransactionId(const FString & NewValue) | Sets the value of TransactionId. |
public inline void SetTransactionId(FString && NewValue) | Sets the value of TransactionId using move semantics. |
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(const ERHAPI_PlatformRegion & NewValue) | Sets the value of PlatformRegion. |
public inline void SetPlatformRegion(ERHAPI_PlatformRegion && NewValue) | Sets the value of PlatformRegion using move semantics. |
public inline FString & GetStatus() | Gets the value of Status_Optional, regardless of it having been set. |
public inline const FString & GetStatus() const | Gets the value of Status_Optional, regardless of it having been set. |
public inline const FString & GetStatus(const FString & DefaultValue) const | Gets the value of Status_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetStatus(FString & OutValue) const | Fills OutValue with the value of Status_Optional and returns true if it has been set, otherwise returns false. |
public inline FString * GetStatusOrNull() | Returns a pointer to Status_Optional, if it has been set, otherwise returns nullptr. |
public inline const FString * GetStatusOrNull() const | Returns a pointer to Status_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetStatus(const FString & NewValue) | Sets the value of Status_Optional and also sets Status_IsSet to true. |
public inline void SetStatus(FString && 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 bool IsStatusDefaultValue() const | Returns true if Status_Optional is set and matches the default value. |
public inline void SetStatusToDefault() | Sets the value of Status_Optional to its default and also sets Status_IsSet to true. |
public inline FString & GetErrorCode() | Gets the value of ErrorCode_Optional, regardless of it having been set. |
public inline const FString & GetErrorCode() const | Gets the value of ErrorCode_Optional, regardless of it having been set. |
public inline const FString & GetErrorCode(const FString & DefaultValue) const | Gets the value of ErrorCode_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetErrorCode(FString & OutValue) const | Fills OutValue with the value of ErrorCode_Optional and returns true if it has been set, otherwise returns false. |
public inline FString * GetErrorCodeOrNull() | Returns a pointer to ErrorCode_Optional, if it has been set, otherwise returns nullptr. |
public inline const FString * GetErrorCodeOrNull() const | Returns a pointer to ErrorCode_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetErrorCode(const FString & NewValue) | Sets the value of ErrorCode_Optional and also sets ErrorCode_IsSet to true. |
public inline void SetErrorCode(FString && 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 TArray< FRHAPI_PlatformEntitlement> &GetClientEntitlements() | Gets the value of ClientEntitlements_Optional, regardless of it having been set. |
public inline const TArray< FRHAPI_PlatformEntitlement> &GetClientEntitlements() const | Gets the value of ClientEntitlements_Optional, regardless of it having been set. |
public inline const TArray< FRHAPI_PlatformEntitlement> &GetClientEntitlements(const TArray< FRHAPI_PlatformEntitlement > & DefaultValue) const | Gets the value of ClientEntitlements_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetClientEntitlements(TArray< FRHAPI_PlatformEntitlement > & OutValue) const | Fills OutValue with the value of ClientEntitlements_Optional and returns true if it has been set, otherwise returns false. |
public inline TArray< FRHAPI_PlatformEntitlement> *GetClientEntitlementsOrNull() | Returns a pointer to ClientEntitlements_Optional, if it has been set, otherwise returns nullptr. |
public inline const TArray< FRHAPI_PlatformEntitlement> *GetClientEntitlementsOrNull() const | Returns a pointer to ClientEntitlements_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetClientEntitlements(const TArray< FRHAPI_PlatformEntitlement > & NewValue) | Sets the value of ClientEntitlements_Optional and also sets ClientEntitlements_IsSet to true. |
public inline void SetClientEntitlements(TArray< FRHAPI_PlatformEntitlement > && NewValue) | Sets the value of ClientEntitlements_Optional and also sets ClientEntitlements_IsSet to true using move semantics. |
public inline void ClearClientEntitlements() | Clears the value of ClientEntitlements_Optional and sets ClientEntitlements_IsSet to false. |
public inline bool IsClientEntitlementsSet() const | Checks whether ClientEntitlements_Optional has been set. |
public inline TArray< FRHAPI_PlatformEntitlement> &GetServerEntitlements() | Gets the value of ServerEntitlements_Optional, regardless of it having been set. |
public inline const TArray< FRHAPI_PlatformEntitlement> &GetServerEntitlements() const | Gets the value of ServerEntitlements_Optional, regardless of it having been set. |
public inline const TArray< FRHAPI_PlatformEntitlement> &GetServerEntitlements(const TArray< FRHAPI_PlatformEntitlement > & DefaultValue) const | Gets the value of ServerEntitlements_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetServerEntitlements(TArray< FRHAPI_PlatformEntitlement > & OutValue) const | Fills OutValue with the value of ServerEntitlements_Optional and returns true if it has been set, otherwise returns false. |
public inline TArray< FRHAPI_PlatformEntitlement> *GetServerEntitlementsOrNull() | Returns a pointer to ServerEntitlements_Optional, if it has been set, otherwise returns nullptr. |
public inline const TArray< FRHAPI_PlatformEntitlement> *GetServerEntitlementsOrNull() const | Returns a pointer to ServerEntitlements_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetServerEntitlements(const TArray< FRHAPI_PlatformEntitlement > & NewValue) | Sets the value of ServerEntitlements_Optional and also sets ServerEntitlements_IsSet to true. |
public inline void SetServerEntitlements(TArray< FRHAPI_PlatformEntitlement > && NewValue) | Sets the value of ServerEntitlements_Optional and also sets ServerEntitlements_IsSet to true using move semantics. |
public inline void ClearServerEntitlements() | Clears the value of ServerEntitlements_Optional and sets ServerEntitlements_IsSet to false. |
public inline bool IsServerEntitlementsSet() const | Checks whether ServerEntitlements_Optional has been set. |
public inline ERHAPI_Platform & GetPlatformId() | Gets the value of PlatformId. |
public inline const ERHAPI_Platform & GetPlatformId() const | Gets the value of PlatformId. |
public inline void SetPlatformId(const ERHAPI_Platform & NewValue) | Sets the value of PlatformId. |
public inline void SetPlatformId(ERHAPI_Platform && NewValue) | Sets the value of PlatformId using move semantics. |
public inline FString & GetPlatformUserId() | Gets the value of PlatformUserId. |
public inline const FString & GetPlatformUserId() const | Gets the value of PlatformUserId. |
public inline void SetPlatformUserId(const FString & NewValue) | Sets the value of PlatformUserId. |
public inline void SetPlatformUserId(FString && NewValue) | Sets the value of PlatformUserId using move semantics. |
public inline bool & GetSkippedServerEntitlements() | Gets the value of SkippedServerEntitlements_Optional, regardless of it having been set. |
public inline const bool & GetSkippedServerEntitlements() const | Gets the value of SkippedServerEntitlements_Optional, regardless of it having been set. |
public inline const bool & GetSkippedServerEntitlements(const bool & DefaultValue) const | Gets the value of SkippedServerEntitlements_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetSkippedServerEntitlements(bool & OutValue) const | Fills OutValue with the value of SkippedServerEntitlements_Optional and returns true if it has been set, otherwise returns false. |
public inline bool * GetSkippedServerEntitlementsOrNull() | Returns a pointer to SkippedServerEntitlements_Optional, if it has been set, otherwise returns nullptr. |
public inline const bool * GetSkippedServerEntitlementsOrNull() const | Returns a pointer to SkippedServerEntitlements_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetSkippedServerEntitlements(const bool & NewValue) | Sets the value of SkippedServerEntitlements_Optional and also sets SkippedServerEntitlements_IsSet to true. |
public inline void SetSkippedServerEntitlements(bool && NewValue) | Sets the value of SkippedServerEntitlements_Optional and also sets SkippedServerEntitlements_IsSet to true using move semantics. |
public inline void ClearSkippedServerEntitlements() | Clears the value of SkippedServerEntitlements_Optional and sets SkippedServerEntitlements_IsSet to false. |
public inline bool IsSkippedServerEntitlementsSet() const | Checks whether SkippedServerEntitlements_Optional has been set. |
public inline bool IsSkippedServerEntitlementsDefaultValue() const | Returns true if SkippedServerEntitlements_Optional is set and matches the default value. |
public inline void SetSkippedServerEntitlementsToDefault() | Sets the value of SkippedServerEntitlements_Optional to its default and also sets SkippedServerEntitlements_IsSet to true. |
Members
public FString RequestId
unique id to allow tracking the request
public ERHAPI_ClientType ClientType
client type this purchase was made on
public FString TransactionId
unique id for this transaction on the platform
public ERHAPI_PlatformRegion PlatformRegion
region this purchase was made in
public FString Status_Optional
status of this result
public bool Status_IsSet
true if Status_Optional has been set to a value
public FString ErrorCode_Optional
Error code for failures not associated with a specific entitlement.
public bool ErrorCode_IsSet
true if ErrorCode_Optional has been set to a value
public TArray< FRHAPI_PlatformEntitlement>ClientEntitlements_Optional
Client entitlements that have been processed.
public bool ClientEntitlements_IsSet
true if ClientEntitlements_Optional has been set to a value
public TArray< FRHAPI_PlatformEntitlement>ServerEntitlements_Optional
Server entitlements that have been processed.
public bool ServerEntitlements_IsSet
true if ServerEntitlements_Optional has been set to a value
public ERHAPI_Platform PlatformId
Platform these transactions were processed on.
public FString PlatformUserId
Unique identifier for the platform user that processed this entitlement.
public bool SkippedServerEntitlements_Optional
True if the server entitlements were skipped.
public bool SkippedServerEntitlements_IsSet
true if SkippedServerEntitlements_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 & GetRequestId()
Gets the value of RequestId.
public inline const FString & GetRequestId() const
Gets the value of RequestId.
public inline void SetRequestId(const FString & NewValue)
Sets the value of RequestId.
public inline void SetRequestId(FString && NewValue)
Sets the value of RequestId using move semantics.
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(const ERHAPI_ClientType & NewValue)
Sets the value of ClientType.
public inline void SetClientType(ERHAPI_ClientType && NewValue)
Sets the value of ClientType using move semantics.
public inline FString & GetTransactionId()
Gets the value of TransactionId.
public inline const FString & GetTransactionId() const
Gets the value of TransactionId.
public inline void SetTransactionId(const FString & NewValue)
Sets the value of TransactionId.
public inline void SetTransactionId(FString && NewValue)
Sets the value of TransactionId using move semantics.
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(const ERHAPI_PlatformRegion & NewValue)
Sets the value of PlatformRegion.
public inline void SetPlatformRegion(ERHAPI_PlatformRegion && NewValue)
Sets the value of PlatformRegion using move semantics.
public inline FString & GetStatus()
Gets the value of Status_Optional, regardless of it having been set.
public inline const FString & GetStatus() const
Gets the value of Status_Optional, regardless of it having been set.
public inline const FString & GetStatus(const FString & DefaultValue) const
Gets the value of Status_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetStatus(FString & OutValue) const
Fills OutValue with the value of Status_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetStatusOrNull()
Returns a pointer to Status_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetStatusOrNull() const
Returns a pointer to Status_Optional, if it has been set, otherwise returns nullptr.
public inline void SetStatus(const FString & NewValue)
Sets the value of Status_Optional and also sets Status_IsSet to true.
public inline void SetStatus(FString && 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 bool IsStatusDefaultValue() const
Returns true if Status_Optional is set and matches the default value.
public inline void SetStatusToDefault()
Sets the value of Status_Optional to its default and also sets Status_IsSet to true.
public inline FString & GetErrorCode()
Gets the value of ErrorCode_Optional, regardless of it having been set.
public inline const FString & GetErrorCode() const
Gets the value of ErrorCode_Optional, regardless of it having been set.
public inline const FString & GetErrorCode(const FString & DefaultValue) const
Gets the value of ErrorCode_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetErrorCode(FString & OutValue) const
Fills OutValue with the value of ErrorCode_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetErrorCodeOrNull()
Returns a pointer to ErrorCode_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetErrorCodeOrNull() const
Returns a pointer to ErrorCode_Optional, if it has been set, otherwise returns nullptr.
public inline void SetErrorCode(const FString & NewValue)
Sets the value of ErrorCode_Optional and also sets ErrorCode_IsSet to true.
public inline void SetErrorCode(FString && 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 TArray< FRHAPI_PlatformEntitlement> &GetClientEntitlements()
Gets the value of ClientEntitlements_Optional, regardless of it having been set.
public inline const TArray< FRHAPI_PlatformEntitlement> &GetClientEntitlements() const
Gets the value of ClientEntitlements_Optional, regardless of it having been set.
public inline const TArray< FRHAPI_PlatformEntitlement> &GetClientEntitlements(const TArray< FRHAPI_PlatformEntitlement > & DefaultValue) const
Gets the value of ClientEntitlements_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetClientEntitlements(TArray< FRHAPI_PlatformEntitlement > & OutValue) const
Fills OutValue with the value of ClientEntitlements_Optional and returns true if it has been set, otherwise returns false.
public inline TArray< FRHAPI_PlatformEntitlement> *GetClientEntitlementsOrNull()
Returns a pointer to ClientEntitlements_Optional, if it has been set, otherwise returns nullptr.
public inline const TArray< FRHAPI_PlatformEntitlement> *GetClientEntitlementsOrNull() const
Returns a pointer to ClientEntitlements_Optional, if it has been set, otherwise returns nullptr.
public inline void SetClientEntitlements(const TArray< FRHAPI_PlatformEntitlement > & NewValue)
Sets the value of ClientEntitlements_Optional and also sets ClientEntitlements_IsSet to true.
public inline void SetClientEntitlements(TArray< FRHAPI_PlatformEntitlement > && NewValue)
Sets the value of ClientEntitlements_Optional and also sets ClientEntitlements_IsSet to true using move semantics.
public inline void ClearClientEntitlements()
Clears the value of ClientEntitlements_Optional and sets ClientEntitlements_IsSet to false.
public inline bool IsClientEntitlementsSet() const
Checks whether ClientEntitlements_Optional has been set.
public inline TArray< FRHAPI_PlatformEntitlement> &GetServerEntitlements()
Gets the value of ServerEntitlements_Optional, regardless of it having been set.
public inline const TArray< FRHAPI_PlatformEntitlement> &GetServerEntitlements() const
Gets the value of ServerEntitlements_Optional, regardless of it having been set.
public inline const TArray< FRHAPI_PlatformEntitlement> &GetServerEntitlements(const TArray< FRHAPI_PlatformEntitlement > & DefaultValue) const
Gets the value of ServerEntitlements_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetServerEntitlements(TArray< FRHAPI_PlatformEntitlement > & OutValue) const
Fills OutValue with the value of ServerEntitlements_Optional and returns true if it has been set, otherwise returns false.
public inline TArray< FRHAPI_PlatformEntitlement> *GetServerEntitlementsOrNull()
Returns a pointer to ServerEntitlements_Optional, if it has been set, otherwise returns nullptr.
public inline const TArray< FRHAPI_PlatformEntitlement> *GetServerEntitlementsOrNull() const
Returns a pointer to ServerEntitlements_Optional, if it has been set, otherwise returns nullptr.
public inline void SetServerEntitlements(const TArray< FRHAPI_PlatformEntitlement > & NewValue)
Sets the value of ServerEntitlements_Optional and also sets ServerEntitlements_IsSet to true.
public inline void SetServerEntitlements(TArray< FRHAPI_PlatformEntitlement > && NewValue)
Sets the value of ServerEntitlements_Optional and also sets ServerEntitlements_IsSet to true using move semantics.
public inline void ClearServerEntitlements()
Clears the value of ServerEntitlements_Optional and sets ServerEntitlements_IsSet to false.
public inline bool IsServerEntitlementsSet() const
Checks whether ServerEntitlements_Optional has been set.
public inline ERHAPI_Platform & GetPlatformId()
Gets the value of PlatformId.
public inline const ERHAPI_Platform & GetPlatformId() const
Gets the value of PlatformId.
public inline void SetPlatformId(const ERHAPI_Platform & NewValue)
Sets the value of PlatformId.
public inline void SetPlatformId(ERHAPI_Platform && NewValue)
Sets the value of PlatformId using move semantics.
public inline FString & GetPlatformUserId()
Gets the value of PlatformUserId.
public inline const FString & GetPlatformUserId() const
Gets the value of PlatformUserId.
public inline void SetPlatformUserId(const FString & NewValue)
Sets the value of PlatformUserId.
public inline void SetPlatformUserId(FString && NewValue)
Sets the value of PlatformUserId using move semantics.
public inline bool & GetSkippedServerEntitlements()
Gets the value of SkippedServerEntitlements_Optional, regardless of it having been set.
public inline const bool & GetSkippedServerEntitlements() const
Gets the value of SkippedServerEntitlements_Optional, regardless of it having been set.
public inline const bool & GetSkippedServerEntitlements(const bool & DefaultValue) const
Gets the value of SkippedServerEntitlements_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetSkippedServerEntitlements(bool & OutValue) const
Fills OutValue with the value of SkippedServerEntitlements_Optional and returns true if it has been set, otherwise returns false.
public inline bool * GetSkippedServerEntitlementsOrNull()
Returns a pointer to SkippedServerEntitlements_Optional, if it has been set, otherwise returns nullptr.
public inline const bool * GetSkippedServerEntitlementsOrNull() const
Returns a pointer to SkippedServerEntitlements_Optional, if it has been set, otherwise returns nullptr.
public inline void SetSkippedServerEntitlements(const bool & NewValue)
Sets the value of SkippedServerEntitlements_Optional and also sets SkippedServerEntitlements_IsSet to true.
public inline void SetSkippedServerEntitlements(bool && NewValue)
Sets the value of SkippedServerEntitlements_Optional and also sets SkippedServerEntitlements_IsSet to true using move semantics.
public inline void ClearSkippedServerEntitlements()
Clears the value of SkippedServerEntitlements_Optional and sets SkippedServerEntitlements_IsSet to false.
public inline bool IsSkippedServerEntitlementsSet() const
Checks whether SkippedServerEntitlements_Optional has been set.
public inline bool IsSkippedServerEntitlementsDefaultValue() const
Returns true if SkippedServerEntitlements_Optional is set and matches the default value.
public inline void SetSkippedServerEntitlementsToDefault()
Sets the value of SkippedServerEntitlements_Optional to its default and also sets SkippedServerEntitlements_IsSet to true.