PlayFab.ClientModels.ItemInstance Class Reference

A unique instance of an item in a user's inventory. Note, to retrieve additional information for an item such as Tags, Description that are the same across all instances of the item, a call to GetCatalogItems is required. The ItemID of can be matched to a catalog entry, which contains the additional information. Also note that Custom Data is only set when the User's specific instance has updated the CustomData via a call to UpdateUserInventoryItemCustomData. Other fields such as UnitPrice and UnitCurrency are only set when the item was granted via a purchase. More...

Inheritance diagram for PlayFab.ClientModels.ItemInstance:

Public Attributes
string	Annotation
	Game specific comment associated with this instance when it was added to the user inventory.
List< string >	BundleContents
	Array of unique items that were awarded when this catalog item was purchased.
string	BundleParent
	Unique identifier for the parent inventory item, as defined in the catalog, for object which were added from a bundle or container.
string	CatalogVersion
	Catalog version for the inventory item, when this instance was created.
Dictionary< string, string >	CustomData
	A set of custom key-value pairs on the instance of the inventory item, which is not to be confused with the catalog item's custom data.
string	DisplayName
	CatalogItem.DisplayName at the time this item was purchased.
DateTime?	Expiration
	Timestamp for when this instance will expire.
string	ItemClass
	Class name for the inventory item, as defined in the catalog.
string	ItemId
	Unique identifier for the inventory item, as defined in the catalog.
string	ItemInstanceId
	Unique item identifier for this specific instance of the item.
DateTime?	PurchaseDate
	Timestamp for when this instance was purchased.
int?	RemainingUses
	Total number of remaining uses, if this is a consumable item.
string	UnitCurrency
	Currency type for the cost of the catalog item. Not available when granting items.
uint	UnitPrice
	Cost of the catalog item in the given currency. Not available when granting items.
int?	UsesIncrementedBy
	The number of uses that were added or removed to this item in this call.

Additional Inherited Members
Public Member Functions inherited from PlayFab.SharedModels.PlayFabBaseModel
string	ToJson ()

Detailed Description

A unique instance of an item in a user's inventory. Note, to retrieve additional information for an item such as Tags, Description that are the same across all instances of the item, a call to GetCatalogItems is required. The ItemID of can be matched to a catalog entry, which contains the additional information. Also note that Custom Data is only set when the User's specific instance has updated the CustomData via a call to UpdateUserInventoryItemCustomData. Other fields such as UnitPrice and UnitCurrency are only set when the item was granted via a purchase.

---

The documentation for this class was generated from the following file:

• C:/Transhuman/S2/Assets/Plugins/Teal-Net/Plugins/PlayFabSDK/Client/PlayFabClientModels.cs