RHAPI_KeyClaim

Summary

Members	Descriptions
struct FRHAPI_KeyClaim	A KeyClaim is a reward a player for fulfilling requirements of an eternal marketing campaign. Once the player has completed the requirements of the campaign and have been assigned a sku of the campaign by the Platform, invoke Process Key Entitlements to consume the sku from the Platform for a Key Claim.

struct FRHAPI_KeyClaim

struct FRHAPI_KeyClaim
  : public FRHAPI_Model

A KeyClaim is a reward a player for fulfilling requirements of an eternal marketing campaign. Once the player has completed the requirements of the campaign and have been assigned a sku of the campaign by the Platform, invoke Process Key Entitlements to consume the sku from the Platform for a Key Claim.

Summary

Members	Descriptions
public ERHAPI_InventoryPortal PortalId_Optional	Platform the player is on.
public bool PortalId_IsSet	true if PortalId_Optional has been set to a value
public FString PortalUserId_Optional	The Platform’s unique identifier for the player.
public bool PortalUserId_IsSet	true if PortalUserId_Optional has been set to a value
public FGuid KeyClaimUuid	The unique identifier for the KeyClaim.
public bool Claimed_Optional	Whether the KeyClaim has been claimed.
public bool Claimed_IsSet	true if Claimed_Optional has been set to a value
public FString ExternalKey_Optional	The external key that was been claimed by the player. This is only filled out once the KeyClaim has been claimed.
public bool ExternalKey_IsSet	true if ExternalKey_Optional has been set to a value
public FGuid ExternalKeyCampaignUuid_Optional	The unique identifier for the MarketingCampaign that the external key was claimed from.
public bool ExternalKeyCampaignUuid_IsSet	true if ExternalKeyCampaignUuid_Optional has been set to a value
public FString ExternalKeyType_Optional	This can be used to allow the player to claim different types based on their preferrence. While we don’t have requirement for what should contain, it must match a key type assigned to the external campaign.
public bool ExternalKeyType_IsSet	true if ExternalKeyType_Optional has been set to a value
public FString CreatedOn_Optional	The time the KeyClaim was created.
public bool CreatedOn_IsSet	true if CreatedOn_Optional has been set to a value
public FString LastModifiedOn_Optional	The time the KeyClaim was last modified.
public bool LastModifiedOn_IsSet	true if LastModifiedOn_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 ERHAPI_InventoryPortal & GetPortalId()	Gets the value of PortalId_Optional, regardless of it having been set.
public inline const ERHAPI_InventoryPortal & GetPortalId() const	Gets the value of PortalId_Optional, regardless of it having been set.
public inline const ERHAPI_InventoryPortal & GetPortalId(const ERHAPI_InventoryPortal & DefaultValue) const	Gets the value of PortalId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetPortalId(ERHAPI_InventoryPortal & OutValue) const	Fills OutValue with the value of PortalId_Optional and returns true if it has been set, otherwise returns false.
public inline ERHAPI_InventoryPortal * GetPortalIdOrNull()	Returns a pointer to PortalId_Optional, if it has been set, otherwise returns nullptr.
public inline const ERHAPI_InventoryPortal * GetPortalIdOrNull() const	Returns a pointer to PortalId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetPortalId(ERHAPI_InventoryPortal NewValue)	Sets the value of PortalId_Optional and also sets PortalId_IsSet to true.
public inline void ClearPortalId()	Clears the value of PortalId_Optional and sets PortalId_IsSet to false.
public inline FString & GetPortalUserId()	Gets the value of PortalUserId_Optional, regardless of it having been set.
public inline const FString & GetPortalUserId() const	Gets the value of PortalUserId_Optional, regardless of it having been set.
public inline const FString & GetPortalUserId(const FString & DefaultValue) const	Gets the value of PortalUserId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetPortalUserId(FString & OutValue) const	Fills OutValue with the value of PortalUserId_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetPortalUserIdOrNull()	Returns a pointer to PortalUserId_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetPortalUserIdOrNull() const	Returns a pointer to PortalUserId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetPortalUserId(FString NewValue)	Sets the value of PortalUserId_Optional and also sets PortalUserId_IsSet to true.
public inline void ClearPortalUserId()	Clears the value of PortalUserId_Optional and sets PortalUserId_IsSet to false.
public inline FGuid & GetKeyClaimUuid()	Gets the value of KeyClaimUuid.
public inline const FGuid & GetKeyClaimUuid() const	Gets the value of KeyClaimUuid.
public inline void SetKeyClaimUuid(FGuid NewValue)	Sets the value of KeyClaimUuid.
public inline bool & GetClaimed()	Gets the value of Claimed_Optional, regardless of it having been set.
public inline const bool & GetClaimed() const	Gets the value of Claimed_Optional, regardless of it having been set.
public inline const bool & GetClaimed(const bool & DefaultValue) const	Gets the value of Claimed_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetClaimed(bool & OutValue) const	Fills OutValue with the value of Claimed_Optional and returns true if it has been set, otherwise returns false.
public inline bool * GetClaimedOrNull()	Returns a pointer to Claimed_Optional, if it has been set, otherwise returns nullptr.
public inline const bool * GetClaimedOrNull() const	Returns a pointer to Claimed_Optional, if it has been set, otherwise returns nullptr.
public inline void SetClaimed(bool NewValue)	Sets the value of Claimed_Optional and also sets Claimed_IsSet to true.
public inline void ClearClaimed()	Clears the value of Claimed_Optional and sets Claimed_IsSet to false.
public inline bool IsClaimedDefaultValue() const	Returns true if Claimed_Optional is set and matches the default value.
public inline void SetClaimedToDefault()	Sets the value of Claimed_Optional to its default and also sets Claimed_IsSet to true.
public inline FString & GetExternalKey()	Gets the value of ExternalKey_Optional, regardless of it having been set.
public inline const FString & GetExternalKey() const	Gets the value of ExternalKey_Optional, regardless of it having been set.
public inline const FString & GetExternalKey(const FString & DefaultValue) const	Gets the value of ExternalKey_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetExternalKey(FString & OutValue) const	Fills OutValue with the value of ExternalKey_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetExternalKeyOrNull()	Returns a pointer to ExternalKey_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetExternalKeyOrNull() const	Returns a pointer to ExternalKey_Optional, if it has been set, otherwise returns nullptr.
public inline void SetExternalKey(FString NewValue)	Sets the value of ExternalKey_Optional and also sets ExternalKey_IsSet to true.
public inline void ClearExternalKey()	Clears the value of ExternalKey_Optional and sets ExternalKey_IsSet to false.
public inline FGuid & GetExternalKeyCampaignUuid()	Gets the value of ExternalKeyCampaignUuid_Optional, regardless of it having been set.
public inline const FGuid & GetExternalKeyCampaignUuid() const	Gets the value of ExternalKeyCampaignUuid_Optional, regardless of it having been set.
public inline const FGuid & GetExternalKeyCampaignUuid(const FGuid & DefaultValue) const	Gets the value of ExternalKeyCampaignUuid_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetExternalKeyCampaignUuid(FGuid & OutValue) const	Fills OutValue with the value of ExternalKeyCampaignUuid_Optional and returns true if it has been set, otherwise returns false.
public inline FGuid * GetExternalKeyCampaignUuidOrNull()	Returns a pointer to ExternalKeyCampaignUuid_Optional, if it has been set, otherwise returns nullptr.
public inline const FGuid * GetExternalKeyCampaignUuidOrNull() const	Returns a pointer to ExternalKeyCampaignUuid_Optional, if it has been set, otherwise returns nullptr.
public inline void SetExternalKeyCampaignUuid(FGuid NewValue)	Sets the value of ExternalKeyCampaignUuid_Optional and also sets ExternalKeyCampaignUuid_IsSet to true.
public inline void ClearExternalKeyCampaignUuid()	Clears the value of ExternalKeyCampaignUuid_Optional and sets ExternalKeyCampaignUuid_IsSet to false.
public inline FString & GetExternalKeyType()	Gets the value of ExternalKeyType_Optional, regardless of it having been set.
public inline const FString & GetExternalKeyType() const	Gets the value of ExternalKeyType_Optional, regardless of it having been set.
public inline const FString & GetExternalKeyType(const FString & DefaultValue) const	Gets the value of ExternalKeyType_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetExternalKeyType(FString & OutValue) const	Fills OutValue with the value of ExternalKeyType_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetExternalKeyTypeOrNull()	Returns a pointer to ExternalKeyType_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetExternalKeyTypeOrNull() const	Returns a pointer to ExternalKeyType_Optional, if it has been set, otherwise returns nullptr.
public inline void SetExternalKeyType(FString NewValue)	Sets the value of ExternalKeyType_Optional and also sets ExternalKeyType_IsSet to true.
public inline void ClearExternalKeyType()	Clears the value of ExternalKeyType_Optional and sets ExternalKeyType_IsSet to false.
public inline FString & GetCreatedOn()	Gets the value of CreatedOn_Optional, regardless of it having been set.
public inline const FString & GetCreatedOn() const	Gets the value of CreatedOn_Optional, regardless of it having been set.
public inline const FString & GetCreatedOn(const FString & DefaultValue) const	Gets the value of CreatedOn_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetCreatedOn(FString & OutValue) const	Fills OutValue with the value of CreatedOn_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetCreatedOnOrNull()	Returns a pointer to CreatedOn_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetCreatedOnOrNull() const	Returns a pointer to CreatedOn_Optional, if it has been set, otherwise returns nullptr.
public inline void SetCreatedOn(FString NewValue)	Sets the value of CreatedOn_Optional and also sets CreatedOn_IsSet to true.
public inline void ClearCreatedOn()	Clears the value of CreatedOn_Optional and sets CreatedOn_IsSet to false.
public inline FString & GetLastModifiedOn()	Gets the value of LastModifiedOn_Optional, regardless of it having been set.
public inline const FString & GetLastModifiedOn() const	Gets the value of LastModifiedOn_Optional, regardless of it having been set.
public inline const FString & GetLastModifiedOn(const FString & DefaultValue) const	Gets the value of LastModifiedOn_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetLastModifiedOn(FString & OutValue) const	Fills OutValue with the value of LastModifiedOn_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetLastModifiedOnOrNull()	Returns a pointer to LastModifiedOn_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetLastModifiedOnOrNull() const	Returns a pointer to LastModifiedOn_Optional, if it has been set, otherwise returns nullptr.
public inline void SetLastModifiedOn(FString NewValue)	Sets the value of LastModifiedOn_Optional and also sets LastModifiedOn_IsSet to true.
public inline void ClearLastModifiedOn()	Clears the value of LastModifiedOn_Optional and sets LastModifiedOn_IsSet to false.

Members

public ERHAPI_InventoryPortal PortalId_Optional

Platform the player is on.

public bool PortalId_IsSet

true if PortalId_Optional has been set to a value

public FString PortalUserId_Optional

The Platform’s unique identifier for the player.

public bool PortalUserId_IsSet

true if PortalUserId_Optional has been set to a value

public FGuid KeyClaimUuid

The unique identifier for the KeyClaim.

public bool Claimed_Optional

Whether the KeyClaim has been claimed.

public bool Claimed_IsSet

true if Claimed_Optional has been set to a value

public FString ExternalKey_Optional

The external key that was been claimed by the player. This is only filled out once the KeyClaim has been claimed.

public bool ExternalKey_IsSet

true if ExternalKey_Optional has been set to a value

public FGuid ExternalKeyCampaignUuid_Optional

The unique identifier for the MarketingCampaign that the external key was claimed from.

public bool ExternalKeyCampaignUuid_IsSet

true if ExternalKeyCampaignUuid_Optional has been set to a value

public FString ExternalKeyType_Optional

This can be used to allow the player to claim different types based on their preferrence. While we don’t have requirement for what should contain, it must match a key type assigned to the external campaign.

public bool ExternalKeyType_IsSet

true if ExternalKeyType_Optional has been set to a value

public FString CreatedOn_Optional

The time the KeyClaim was created.

public bool CreatedOn_IsSet

true if CreatedOn_Optional has been set to a value

public FString LastModifiedOn_Optional

The time the KeyClaim was last modified.

public bool LastModifiedOn_IsSet

true if LastModifiedOn_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 ERHAPI_InventoryPortal & GetPortalId()

Gets the value of PortalId_Optional, regardless of it having been set.

public inline const ERHAPI_InventoryPortal & GetPortalId() const

Gets the value of PortalId_Optional, regardless of it having been set.

public inline const ERHAPI_InventoryPortal & GetPortalId(const ERHAPI_InventoryPortal & DefaultValue) const

Gets the value of PortalId_Optional, if it has been set, otherwise it returns DefaultValue.

public inline bool GetPortalId(ERHAPI_InventoryPortal & OutValue) const

Fills OutValue with the value of PortalId_Optional and returns true if it has been set, otherwise returns false.

public inline ERHAPI_InventoryPortal * GetPortalIdOrNull()

Returns a pointer to PortalId_Optional, if it has been set, otherwise returns nullptr.

public inline const ERHAPI_InventoryPortal * GetPortalIdOrNull() const

Returns a pointer to PortalId_Optional, if it has been set, otherwise returns nullptr.

public inline void SetPortalId(ERHAPI_InventoryPortal NewValue)

Sets the value of PortalId_Optional and also sets PortalId_IsSet to true.

public inline void ClearPortalId()

Clears the value of PortalId_Optional and sets PortalId_IsSet to false.

public inline FString & GetPortalUserId()

Gets the value of PortalUserId_Optional, regardless of it having been set.

public inline const FString & GetPortalUserId() const

Gets the value of PortalUserId_Optional, regardless of it having been set.

public inline const FString & GetPortalUserId(const FString & DefaultValue) const

Gets the value of PortalUserId_Optional, if it has been set, otherwise it returns DefaultValue.

public inline bool GetPortalUserId(FString & OutValue) const

Fills OutValue with the value of PortalUserId_Optional and returns true if it has been set, otherwise returns false.

public inline FString * GetPortalUserIdOrNull()

Returns a pointer to PortalUserId_Optional, if it has been set, otherwise returns nullptr.

public inline const FString * GetPortalUserIdOrNull() const

Returns a pointer to PortalUserId_Optional, if it has been set, otherwise returns nullptr.

public inline void SetPortalUserId(FString NewValue)

Sets the value of PortalUserId_Optional and also sets PortalUserId_IsSet to true.

public inline void ClearPortalUserId()

Clears the value of PortalUserId_Optional and sets PortalUserId_IsSet to false.

public inline FGuid & GetKeyClaimUuid()

Gets the value of KeyClaimUuid.

public inline const FGuid & GetKeyClaimUuid() const

Gets the value of KeyClaimUuid.

public inline void SetKeyClaimUuid(FGuid NewValue)

Sets the value of KeyClaimUuid.

public inline bool & GetClaimed()

Gets the value of Claimed_Optional, regardless of it having been set.

public inline const bool & GetClaimed() const

Gets the value of Claimed_Optional, regardless of it having been set.

public inline const bool & GetClaimed(const bool & DefaultValue) const

Gets the value of Claimed_Optional, if it has been set, otherwise it returns DefaultValue.

public inline bool GetClaimed(bool & OutValue) const

Fills OutValue with the value of Claimed_Optional and returns true if it has been set, otherwise returns false.

public inline bool * GetClaimedOrNull()

Returns a pointer to Claimed_Optional, if it has been set, otherwise returns nullptr.

public inline const bool * GetClaimedOrNull() const

Returns a pointer to Claimed_Optional, if it has been set, otherwise returns nullptr.

public inline void SetClaimed(bool NewValue)

Sets the value of Claimed_Optional and also sets Claimed_IsSet to true.

public inline void ClearClaimed()

Clears the value of Claimed_Optional and sets Claimed_IsSet to false.

public inline bool IsClaimedDefaultValue() const

Returns true if Claimed_Optional is set and matches the default value.

public inline void SetClaimedToDefault()

Sets the value of Claimed_Optional to its default and also sets Claimed_IsSet to true.

public inline FString & GetExternalKey()

Gets the value of ExternalKey_Optional, regardless of it having been set.

public inline const FString & GetExternalKey() const

Gets the value of ExternalKey_Optional, regardless of it having been set.

public inline const FString & GetExternalKey(const FString & DefaultValue) const

Gets the value of ExternalKey_Optional, if it has been set, otherwise it returns DefaultValue.

public inline bool GetExternalKey(FString & OutValue) const

Fills OutValue with the value of ExternalKey_Optional and returns true if it has been set, otherwise returns false.

public inline FString * GetExternalKeyOrNull()

Returns a pointer to ExternalKey_Optional, if it has been set, otherwise returns nullptr.

public inline const FString * GetExternalKeyOrNull() const

Returns a pointer to ExternalKey_Optional, if it has been set, otherwise returns nullptr.

public inline void SetExternalKey(FString NewValue)

Sets the value of ExternalKey_Optional and also sets ExternalKey_IsSet to true.

public inline void ClearExternalKey()

Clears the value of ExternalKey_Optional and sets ExternalKey_IsSet to false.

public inline FGuid & GetExternalKeyCampaignUuid()

Gets the value of ExternalKeyCampaignUuid_Optional, regardless of it having been set.

public inline const FGuid & GetExternalKeyCampaignUuid() const

Gets the value of ExternalKeyCampaignUuid_Optional, regardless of it having been set.

public inline const FGuid & GetExternalKeyCampaignUuid(const FGuid & DefaultValue) const

Gets the value of ExternalKeyCampaignUuid_Optional, if it has been set, otherwise it returns DefaultValue.

public inline bool GetExternalKeyCampaignUuid(FGuid & OutValue) const

Fills OutValue with the value of ExternalKeyCampaignUuid_Optional and returns true if it has been set, otherwise returns false.

public inline FGuid * GetExternalKeyCampaignUuidOrNull()

Returns a pointer to ExternalKeyCampaignUuid_Optional, if it has been set, otherwise returns nullptr.

public inline const FGuid * GetExternalKeyCampaignUuidOrNull() const

Returns a pointer to ExternalKeyCampaignUuid_Optional, if it has been set, otherwise returns nullptr.

public inline void SetExternalKeyCampaignUuid(FGuid NewValue)

Sets the value of ExternalKeyCampaignUuid_Optional and also sets ExternalKeyCampaignUuid_IsSet to true.

public inline void ClearExternalKeyCampaignUuid()

Clears the value of ExternalKeyCampaignUuid_Optional and sets ExternalKeyCampaignUuid_IsSet to false.

public inline FString & GetExternalKeyType()

Gets the value of ExternalKeyType_Optional, regardless of it having been set.

public inline const FString & GetExternalKeyType() const

Gets the value of ExternalKeyType_Optional, regardless of it having been set.

public inline const FString & GetExternalKeyType(const FString & DefaultValue) const

Gets the value of ExternalKeyType_Optional, if it has been set, otherwise it returns DefaultValue.

public inline bool GetExternalKeyType(FString & OutValue) const

Fills OutValue with the value of ExternalKeyType_Optional and returns true if it has been set, otherwise returns false.

public inline FString * GetExternalKeyTypeOrNull()

Returns a pointer to ExternalKeyType_Optional, if it has been set, otherwise returns nullptr.

public inline const FString * GetExternalKeyTypeOrNull() const

Returns a pointer to ExternalKeyType_Optional, if it has been set, otherwise returns nullptr.

public inline void SetExternalKeyType(FString NewValue)

Sets the value of ExternalKeyType_Optional and also sets ExternalKeyType_IsSet to true.

public inline void ClearExternalKeyType()

Clears the value of ExternalKeyType_Optional and sets ExternalKeyType_IsSet to false.

public inline FString & GetCreatedOn()

Gets the value of CreatedOn_Optional, regardless of it having been set.

public inline const FString & GetCreatedOn() const

Gets the value of CreatedOn_Optional, regardless of it having been set.

public inline const FString & GetCreatedOn(const FString & DefaultValue) const

Gets the value of CreatedOn_Optional, if it has been set, otherwise it returns DefaultValue.

public inline bool GetCreatedOn(FString & OutValue) const

Fills OutValue with the value of CreatedOn_Optional and returns true if it has been set, otherwise returns false.

public inline FString * GetCreatedOnOrNull()

Returns a pointer to CreatedOn_Optional, if it has been set, otherwise returns nullptr.

public inline const FString * GetCreatedOnOrNull() const

Returns a pointer to CreatedOn_Optional, if it has been set, otherwise returns nullptr.

public inline void SetCreatedOn(FString NewValue)

Sets the value of CreatedOn_Optional and also sets CreatedOn_IsSet to true.

public inline void ClearCreatedOn()

Clears the value of CreatedOn_Optional and sets CreatedOn_IsSet to false.

public inline FString & GetLastModifiedOn()

Gets the value of LastModifiedOn_Optional, regardless of it having been set.

public inline const FString & GetLastModifiedOn() const

Gets the value of LastModifiedOn_Optional, regardless of it having been set.

public inline const FString & GetLastModifiedOn(const FString & DefaultValue) const

Gets the value of LastModifiedOn_Optional, if it has been set, otherwise it returns DefaultValue.

public inline bool GetLastModifiedOn(FString & OutValue) const

Fills OutValue with the value of LastModifiedOn_Optional and returns true if it has been set, otherwise returns false.

public inline FString * GetLastModifiedOnOrNull()

Returns a pointer to LastModifiedOn_Optional, if it has been set, otherwise returns nullptr.

public inline const FString * GetLastModifiedOnOrNull() const

Returns a pointer to LastModifiedOn_Optional, if it has been set, otherwise returns nullptr.

public inline void SetLastModifiedOn(FString NewValue)

Sets the value of LastModifiedOn_Optional and also sets LastModifiedOn_IsSet to true.

public inline void ClearLastModifiedOn()

Clears the value of LastModifiedOn_Optional and sets LastModifiedOn_IsSet to false.