Contains commerce related functionality for the Astra SDK More...

Static Public Member Functions
static GetAppShopInfoJob	GetAppShopInfo (ulong appId, int parentJobId=Job.kNoParentJobId)
	Get Application Cart Information. Application ID will need to be what SetApp was called with More...

static GetClosetJob	GetCloset (int parentJobId=Job.kNoParentJobId)

static List< string >	GetClosetGuidsUpdated (int parentJobId=Job.kNoParentJobId)

static void	GetAssetInfo (string assetGuid, Action< AssetInfo > callback, int parentJobId=Job.kNoParentJobId)

static GetCategoryFullJob	GetCategoryFull (ulong categoryId, int parentJobId=Job.kNoParentJobId)
	Get Hierarchical information for a category More...

static GetCategoryDetailJob	GetCategoryDetail (ulong categoryId, int parentJobId=Job.kNoParentJobId)
	Get Detail information for a category More...

static GetProductSlabJob	GetProductSlab (ulong productId, int parentJobId=Job.kNoParentJobId)
	Get slab information for a product More...

static GetProductDetailJob	GetProductDetail (ulong productId, int parentJobId=Job.kNoParentJobId)
	Get detail information for a product More...

static GetBillingListJob	GetBillingList (int parentJobId=Job.kNoParentJobId)
	Get Billing Profile List More...

static AddBillingJob	AddBilling (AddBillingJob.AddBilling billing, int parentJobId=Job.kNoParentJobId)
	Add new billing profile More...

static RemoveBillingJob	RemoveBilling (string billingId, int parentJobId=Job.kNoParentJobId)
	Remove billing address More...

static SetDefaultBillingJob	SetDefaultBilling (string billingId, int parentJobId=Job.kNoParentJobId)
	Set default billing address More...

static GetCurrencyBalanceJob	GetCurrencyBalance (string currencyType, int parentJobId=Job.kNoParentJobId)
	Get Currency balance for customer More...

static GetProductsByAssetsJob	GetProductsByAssets (List< string > guids, int parentJobId=Job.kNoParentJobId)
	Get Product IDs associated with assets More...

static GetAssetsByProductsJob	GetAssetsByProducts (List< ulong > ids, int parentJobId=Job.kNoParentJobId)
	Get Asset GUIDs associated with products More...

static GetCartJob	GetCart (ulong cartConfigId, int parentJobId=Job.kNoParentJobId)
	Get Cart More...

static GetCartJob	GetCart (ulong cartConfigId, string cartQualifier, int parentJobId=Job.kNoParentJobId)
	Get Cart More...

static SetupCartJob	SetupCart (ulong cartConfigId, string currency, int parentJobId=Job.kNoParentJobId)
	Setup a cart currency More...

static SetupCartJob	SetupCart (ulong cartConfigId, string currency, string cartQualifier, int parentJobId=Job.kNoParentJobId)
	Setup a cart currency More...

static AddToCartJob	AddToCart (AddToCartJob.AddCartParameter cart, int parentJobId=Job.kNoParentJobId)
	Add to cart More...

static ClearCartJob	ClearCart (ulong cartConfigId, int parentJobId=Job.kNoParentJobId)
	Clear Cart More...

static ClearCartJob	ClearCart (ulong cartConfigId, string cartQualifier, int parentJobId=Job.kNoParentJobId)
	Clear Cart More...

static RemoveFromCartJob	RemoveFromCart (RemoveFromCartJob.RemoveCartParameter cart, int parentJobId=Job.kNoParentJobId)
	Remove Product from Cart More...

static UpdateCartJob	UpdateCart (UpdateCartJob.UpdateCartParameter cart, int parentJobId=Job.kNoParentJobId)
	Update Product in Cart More...

static CheckOutInitJob	CheckOutInit (CheckOutInitJob.CheckOutInitParameter checkout, int parentJobId=Job.kNoParentJobId)
	CheckOut init More...

static CheckOutJob	CheckOut (CheckOutJob.CheckOutParameter checkout, int parentJobId=Job.kNoParentJobId)
	Checkout More...

static CheckOutSuccessJob	CheckOutSuccess (string orderId, int parentJobId=Job.kNoParentJobId)
	Checkout Success More...

static GetSlabsByProductIdsJob	GetSlabsByProductIds (List< ulong > ids, int parentJobId=Job.kNoParentJobId)
	Get slab information More...

static GetSlabsByCategoryIdJob	GetSlabsByCategoryId (ulong categoryId, int parentJobId=Job.kNoParentJobId)
	Get slab information More...

static GetProductsByCategoryIdJob	GetProductsByCategoryId (ulong categoryId, int parentJobId=Job.kNoParentJobId)
	Get products information More...

static GetPurchasedProductsJob	GetPurchasedProducts (int parentJobId=Job.kNoParentJobId)
	Get List of purchased products More...

Detailed Description

Contains commerce related functionality for the Astra SDK

Member Function Documentation

◆ AddBilling()

static AddBillingJob Astra.Shop.AddBilling	(	AddBillingJob.AddBilling	billing,
		int	parentJobId = `Job.kNoParentJobId`
	)

inlinestatic

Add new billing profile

Parameters

billing	billing profile details
parentJobId	Id of the parent job, if it applies. Optional.

Returns

◆ AddToCart()

static AddToCartJob Astra.Shop.AddToCart	(	AddToCartJob.AddCartParameter	cart,
		int	parentJobId = `Job.kNoParentJobId`
	)

inlinestatic

Add to cart

Parameters

cart
parentJobId	Id of the parent job, if it applies. Optional.

Returns

◆ CheckOut()

static CheckOutJob Astra.Shop.CheckOut	(	CheckOutJob.CheckOutParameter	checkout,
		int	parentJobId = `Job.kNoParentJobId`
	)

inlinestatic

Checkout

Parameters

checkout
parentJobId	Id of the parent job, if it applies. Optional.

Returns

◆ CheckOutInit()

static CheckOutInitJob Astra.Shop.CheckOutInit	(	CheckOutInitJob.CheckOutInitParameter	checkout,
		int	parentJobId = `Job.kNoParentJobId`
	)

inlinestatic

CheckOut init

Parameters

cart
parentJobId	Id of the parent job, if it applies. Optional.

Returns

◆ CheckOutSuccess()

static CheckOutSuccessJob Astra.Shop.CheckOutSuccess	(	string	orderId,
		int	parentJobId = `Job.kNoParentJobId`
	)

inlinestatic

Checkout Success

Parameters

orderId
parentJobId	Id of the parent job, if it applies. Optional.

Returns

◆ ClearCart() [1/2]

static ClearCartJob Astra.Shop.ClearCart	(	ulong	cartConfigId,
		int	parentJobId = `Job.kNoParentJobId`
	)

inlinestatic

Clear Cart

Parameters

cartConfigId
parentJobId	Id of the parent job, if it applies. Optional.

Returns

◆ ClearCart() [2/2]

static ClearCartJob Astra.Shop.ClearCart	(	ulong	cartConfigId,
		string	cartQualifier,
		int	parentJobId = `Job.kNoParentJobId`
	)

inlinestatic

Clear Cart

Parameters

cartConfigId
cartQualifier
parentJobId	Id of the parent job, if it applies. Optional.

Returns

◆ GetAppShopInfo()

static GetAppShopInfoJob Astra.Shop.GetAppShopInfo	(	ulong	appId,
		int	parentJobId = `Job.kNoParentJobId`
	)

inlinestatic

Get Application Cart Information. Application ID will need to be what SetApp was called with

Parameters

appId	Applciation ID
parentJobId	Id of the parent job, if it applies. Optional.

Returns: Job for tracking

◆ GetAssetsByProducts()

static GetAssetsByProductsJob Astra.Shop.GetAssetsByProducts	(	List< ulong >	ids,
		int	parentJobId = `Job.kNoParentJobId`
	)

inlinestatic

Get Asset GUIDs associated with products

Parameters

ids	List of product ids
parentJobId	Id of the parent job, if it applies. Optional.

Returns

◆ GetBillingList()

static GetBillingListJob Astra.Shop.GetBillingList ( int parentJobId = Job.kNoParentJobId )

inlinestatic

Get Billing Profile List

Parameters

parentJobId Id of the parent job, if it applies. Optional.

Returns

◆ GetCart() [1/2]

static GetCartJob Astra.Shop.GetCart	(	ulong	cartConfigId,
		int	parentJobId = `Job.kNoParentJobId`
	)

inlinestatic

Get Cart

Parameters

cartConfigId
parentJobId	Id of the parent job, if it applies. Optional.

Returns

◆ GetCart() [2/2]

static GetCartJob Astra.Shop.GetCart	(	ulong	cartConfigId,
		string	cartQualifier,
		int	parentJobId = `Job.kNoParentJobId`
	)

inlinestatic

Get Cart

Parameters

cartConfigId
cartQualifier
parentJobId	Id of the parent job, if it applies. Optional.

Returns

◆ GetCategoryDetail()

static GetCategoryDetailJob Astra.Shop.GetCategoryDetail	(	ulong	categoryId,
		int	parentJobId = `Job.kNoParentJobId`
	)

inlinestatic

Get Detail information for a category

Parameters

categoryId	Category ID
parentJobId	Id of the parent job, if it applies. Optional.

Returns: Job for tracking

◆ GetCategoryFull()

static GetCategoryFullJob Astra.Shop.GetCategoryFull	(	ulong	categoryId,
		int	parentJobId = `Job.kNoParentJobId`
	)

inlinestatic

Get Hierarchical information for a category

Parameters

categoryId	Category ID
parentJobId	Id of the parent job, if it applies. Optional.

Returns: Job for tracking

◆ GetCurrencyBalance()

static GetCurrencyBalanceJob Astra.Shop.GetCurrencyBalance	(	string	currencyType,
		int	parentJobId = `Job.kNoParentJobId`
	)

inlinestatic

Get Currency balance for customer

Parameters

currencyType	USD, VRC, etc.
parentJobId	Id of the parent job, if it applies. Optional.

Returns

◆ GetProductDetail()

static GetProductDetailJob Astra.Shop.GetProductDetail	(	ulong	productId,
		int	parentJobId = `Job.kNoParentJobId`
	)

inlinestatic

Get detail information for a product

Parameters

productId	Product ID to get information about
parentJobId	Id of the parent job, if it applies. Optional.

Returns

◆ GetProductsByAssets()

static GetProductsByAssetsJob Astra.Shop.GetProductsByAssets	(	List< string >	guids,
		int	parentJobId = `Job.kNoParentJobId`
	)

inlinestatic

Get Product IDs associated with assets

Parameters

guids	List of asset guids
parentJobId	Id of the parent job, if it applies. Optional.

Returns

◆ GetProductsByCategoryId()

static GetProductsByCategoryIdJob Astra.Shop.GetProductsByCategoryId	(	ulong	categoryId,
		int	parentJobId = `Job.kNoParentJobId`
	)

inlinestatic

Get products information

Parameters

categoryId	Category to get product information for
parentJobId	Id of the parent job, if it applies. Optional.

Returns

◆ GetProductSlab()

static GetProductSlabJob Astra.Shop.GetProductSlab	(	ulong	productId,
		int	parentJobId = `Job.kNoParentJobId`
	)

inlinestatic

Get slab information for a product

Parameters

productId	Product ID for slab to retrieve
parentJobId	Id of the parent job, if it applies. Optional.

Returns

◆ GetPurchasedProducts()

static GetPurchasedProductsJob Astra.Shop.GetPurchasedProducts ( int parentJobId = Job.kNoParentJobId )

inlinestatic

Get List of purchased products

Parameters

parentJobId Id of the parent job, if it applies. Optional.

Returns

◆ GetSlabsByCategoryId()

static GetSlabsByCategoryIdJob Astra.Shop.GetSlabsByCategoryId	(	ulong	categoryId,
		int	parentJobId = `Job.kNoParentJobId`
	)

inlinestatic

Get slab information

Parameters

categoryId	Category to get slab information for
parentJobId	Id of the parent job, if it applies. Optional.

Returns

◆ GetSlabsByProductIds()

static GetSlabsByProductIdsJob Astra.Shop.GetSlabsByProductIds	(	List< ulong >	ids,
		int	parentJobId = `Job.kNoParentJobId`
	)

inlinestatic

Get slab information

Parameters

ids	Product IDs to get slab information for
parentJobId	Id of the parent job, if it applies. Optional.

Returns

◆ RemoveBilling()

static RemoveBillingJob Astra.Shop.RemoveBilling	(	string	billingId,
		int	parentJobId = `Job.kNoParentJobId`
	)

inlinestatic

Remove billing address

Parameters

billingId	Id of the billing profile to remove
parentJobId	Id of the parent job, if it applies. Optional.

Returns

◆ RemoveFromCart()

static RemoveFromCartJob Astra.Shop.RemoveFromCart	(	RemoveFromCartJob.RemoveCartParameter	cart,
		int	parentJobId = `Job.kNoParentJobId`
	)

inlinestatic

Remove Product from Cart

Parameters

cart
parentJobId	Id of the parent job, if it applies. Optional.

Returns

◆ SetDefaultBilling()

static SetDefaultBillingJob Astra.Shop.SetDefaultBilling	(	string	billingId,
		int	parentJobId = `Job.kNoParentJobId`
	)

inlinestatic

Set default billing address

Parameters

billingId	Id of the billing profile to set as default
parentJobId	Id of the parent job, if it applies. Optional.

Returns

◆ SetupCart() [1/2]

static SetupCartJob Astra.Shop.SetupCart	(	ulong	cartConfigId,
		string	currency,
		int	parentJobId = `Job.kNoParentJobId`
	)

inlinestatic

Setup a cart currency

Parameters

cartConfigId	cart config id
currency	currency type
parentJobId	Id of the parent job, if it applies. Optional.

Returns

◆ SetupCart() [2/2]

static SetupCartJob Astra.Shop.SetupCart	(	ulong	cartConfigId,
		string	currency,
		string	cartQualifier,
		int	parentJobId = `Job.kNoParentJobId`
	)

inlinestatic

Setup a cart currency

Parameters

cartConfigId	cart config id
currency	currency type
cartQualifier	cart name
parentJobId	Id of the parent job, if it applies. Optional.

Returns

◆ UpdateCart()

static UpdateCartJob Astra.Shop.UpdateCart	(	UpdateCartJob.UpdateCartParameter	cart,
		int	parentJobId = `Job.kNoParentJobId`
	)

inlinestatic

Update Product in Cart

Parameters

cart
parentJobId	Id of the parent job, if it applies. Optional.

Returns

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

Assets/Astra/Networking/Shop.cs

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ AddBilling()

◆ AddToCart()

◆ CheckOut()

◆ CheckOutInit()

◆ CheckOutSuccess()

◆ ClearCart() [1/2]

◆ ClearCart() [2/2]

◆ GetAppShopInfo()

◆ GetAssetsByProducts()

◆ GetBillingList()

◆ GetCart() [1/2]

◆ GetCart() [2/2]

◆ GetCategoryDetail()

◆ GetCategoryFull()

◆ GetCurrencyBalance()

◆ GetProductDetail()

◆ GetProductsByAssets()

◆ GetProductsByCategoryId()

◆ GetProductSlab()

◆ GetPurchasedProducts()

◆ GetSlabsByCategoryId()

◆ GetSlabsByProductIds()

◆ RemoveBilling()

◆ RemoveFromCart()

◆ SetDefaultBilling()

◆ SetupCart() [1/2]

◆ SetupCart() [2/2]

◆ UpdateCart()