AccelByte.Api.Items Class Reference

Provide an API to access Items service. More...

Inheritance diagram for AccelByte.Api.Items:

Public Member Functions
void	GetItemById (string itemId, string region, string language, ResultCallback< PopulatedItemInfo > callback, string storeId="", bool populateBundle=false)
	Get ItemInfo by itemId.
void	GetItemById (string itemId, string region, string language, bool autoCalcEstimatedPrice, ResultCallback< PopulatedItemInfo > callback, string storeId="", bool populateBundle=false)
	Get ItemInfo by itemId.
void	GetItemsByCriteria (ItemCriteria criteria, ResultCallback< ItemPagingSlicedResult > callback)
	Get Items by criteria. Set ItemCriteria fields as null if you don't want to specify the criteria. The result callback will returns a ItemPagingSlicedResult that contains Items within it.
void	GetItemByAppId (string appId, ResultCallback< ItemInfo > callback, string language="", string region="")
	Get item info by AppId.
void	SearchItem (string language, string keyword, int offset, int limit, string region, ResultCallback< ItemPagingSlicedResult > callback)
	Search Item.
void	SearchItem (string language, string keyword, int offset, int limit, string region, bool autoCalcEstimatedPrice, ResultCallback< ItemPagingSlicedResult > callback)
	Search Item.
void	GetItemBySku (string sku, string language, string region, ResultCallback< ItemInfo > callback)
	Get item info by sku.
void	GetItemBySku (string sku, string language, string region, bool autoCalcEstimatedPrice, ResultCallback< ItemInfo > callback)
	Get item info by sku.
void	GetItemBySku (string sku, ResultCallback< ItemInfo > callback, bool autoCalcEstimatedPrice=false, string storeId=null, string language=null, string region=null)
	Get item info by sku.
void	BulkGetLocaleItems (string[] itemIds, string language, string region, ResultCallback< ItemInfo[]> callback, string storeId="")
	Bulk Get Locale Items.
void	BulkGetLocaleItems (string[] itemIds, string language, string region, bool autoCalcEstimatedPrice, ResultCallback< ItemInfo[]> callback, string storeId="")
	Bulk Get Locale Items.
void	GetListAllStore (ResultCallback< PlatformStore[]> callback)
	Get list all stores in a namespace.
void	GetEstimatedPrice (string[] itemIds, string region, ResultCallback< EstimatedPricesInfo[]> callback)
	Get estimated prices of an item.

Additional Inherited Members
Properties inherited from AccelByte.Core.WrapperBase
Utils.AccelByteIdValidator	IdValidator [get]

Detailed Description

Provide an API to access Items service.

Member Function Documentation

BulkGetLocaleItems() [1/2]

void AccelByte.Api.Items.BulkGetLocaleItems ( string[] itemIds, string language, string region, bool autoCalcEstimatedPrice, ResultCallback< ItemInfo[]> callback, string storeId = "" )

inline

Bulk Get Locale Items.

Parameters

itemIds	Item IDs to get item
language	display language
region	region of items
autoCalcEstimatedPrice	Auto Calculate Estimated Price. If autoCalcEstimatedPrice is true and item is flexible bundle, will auto calc price.
callback	Returns a result that contain ItemInfo via callback when completed.
storeId	If it's leaved string empty, the value will be got from published store id on the namespace

BulkGetLocaleItems() [2/2]

void AccelByte.Api.Items.BulkGetLocaleItems ( string[] itemIds, string language, string region, ResultCallback< ItemInfo[]> callback, string storeId = "" )

inline

Bulk Get Locale Items.

Parameters

itemIds	Item IDs to get item
callback	Returns a result that contain ItemInfo via callback when completed.
language	display language
region	region of items
storeId	If it's leaved string empty, the value will be got from published store id on the namespace

GetEstimatedPrice()

void AccelByte.Api.Items.GetEstimatedPrice ( string[] itemIds, string region, ResultCallback< EstimatedPricesInfo[]> callback )

inline

Get estimated prices of an item.

Parameters

itemIds	Item IDs to get the estimated items information
region	Region Code, ISO 3166-1 alpha-2 country tag, e.g., "US", "CN".Item IDs to get item
callback	Returns a result that contain EstimatedPricesInfo array via callback when completed.

GetItemByAppId()

void AccelByte.Api.Items.GetItemByAppId ( string appId, ResultCallback< ItemInfo > callback, string language = "", string region = "" )

inline

Get item info by AppId.

Parameters

appId	AppId of an item
callback	Returns a result that contain ItemInfo via callback when completed.
language	display language
region	region of items

GetItemById() [1/2]

void AccelByte.Api.Items.GetItemById ( string itemId, string region, string language, bool autoCalcEstimatedPrice, ResultCallback< PopulatedItemInfo > callback, string storeId = "", bool populateBundle = false )

inline

Get ItemInfo by itemId.

Parameters

itemId	Item ID to get item with
region	Region of the item
language	Display language
autoCalcEstimatedPrice	Auto Calculate Estimated Price. If autoCalcEstimatedPrice is true and item is flexible bundle, will auto calc price.
callback	Returns a Result that contains ItemInfo via callback when completed.
storeId	If it's leaved string empty, the value will be got from published store id on the namespace
populateBundle	Whether populate bundled items if it's a bundle, default value is false

GetItemById() [2/2]

void AccelByte.Api.Items.GetItemById ( string itemId, string region, string language, ResultCallback< PopulatedItemInfo > callback, string storeId = "", bool populateBundle = false )

inline

Get ItemInfo by itemId.

Parameters

itemId	Item ID to get item with
region	Region of the item
language	Display language
callback	Returns a Result that contains ItemInfo via callback when completed.
storeId	If it's leaved string empty, the value will be got from published store id on the namespace
populateBundle	Whether populate bundled items if it's a bundle, default value is false

GetItemBySku() [1/3]

void AccelByte.Api.Items.GetItemBySku ( string sku, ResultCallback< ItemInfo > callback, bool autoCalcEstimatedPrice = false, string storeId = null, string language = null, string region = null )

inline

Get item info by sku.

Parameters

sku	Sku should contain specific number of item Sku
storeId	store id to be queried
language	display language
region	region of items
autoCalcEstimatedPrice	Auto Calculate Estimated Price. If autoCalcEstimatedPrice is true and item is flexible bundle, will auto calc price.
callback	Returns a result that contain ItemInfo via callback when completed.

GetItemBySku() [2/3]

void AccelByte.Api.Items.GetItemBySku ( string sku, string language, string region, bool autoCalcEstimatedPrice, ResultCallback< ItemInfo > callback )

inline

Get item info by sku.

Parameters

sku	Sku should contain specific number of item Sku
language	display language
region	region of items
autoCalcEstimatedPrice	Auto Calculate Estimated Price. If autoCalcEstimatedPrice is true and item is flexible bundle, will auto calc price.
callback	Returns a result that contain ItemInfo via callback when completed.

GetItemBySku() [3/3]

void AccelByte.Api.Items.GetItemBySku ( string sku, string language, string region, ResultCallback< ItemInfo > callback )

inline

Get item info by sku.

Parameters

sku	Sku should contain specific number of item Sku
language	display language
region	region of items
callback	Returns a result that contain ItemInfo via callback when completed.

GetItemsByCriteria()

void AccelByte.Api.Items.GetItemsByCriteria ( ItemCriteria criteria, ResultCallback< ItemPagingSlicedResult > callback )

inline

Get Items by criteria. Set ItemCriteria fields as null if you don't want to specify the criteria. The result callback will returns a ItemPagingSlicedResult that contains Items within it.

Parameters

criteria	Criteria to search items
callback	Returns a Result that contains ItemPagingSlicedResult via callback when completed.

GetListAllStore()

void AccelByte.Api.Items.GetListAllStore ( ResultCallback< PlatformStore[]> callback )

inline

Get list all stores in a namespace.

Parameters

callback

Returns a result that contain PlatformStore via callback when completed.

SearchItem() [1/2]

void AccelByte.Api.Items.SearchItem ( string language, string keyword, int offset, int limit, string region, bool autoCalcEstimatedPrice, ResultCallback< ItemPagingSlicedResult > callback )

inline

Search Item.

Parameters

language	display language
keyword	Keyword Item's keyword in title or description or long description
offset	offset of items
limit	limit of items
region	Region ISO 3166-1 alpha-2 country tag, e.g., "US", "CN".
autoCalcEstimatedPrice	Auto Calculate Estimated Price. If autoCalcEstimatedPrice is true and item is flexible bundle, will auto calc price.
callback	Returns a result that contain ItemPagingSlicedResult via callback when completed.

SearchItem() [2/2]

void AccelByte.Api.Items.SearchItem ( string language, string keyword, int offset, int limit, string region, ResultCallback< ItemPagingSlicedResult > callback )

inline

Search Item.

Parameters

language	display language
keyword	Keyword Item's keyword in title or description or long description
offset	offset of items
limit	limit of items
region	Region ISO 3166-1 alpha-2 country tag, e.g., "US", "CN".
callback	Returns a result that contain ItemPagingSlicedResult via callback when completed.