Class CustomerProductListProduct
- Namespace
- Dynamicweb.Ecommerce.CustomerCenter
- Assembly
- Dynamicweb.Ecommerce.dll
CustomerProductListProduct class.
public class CustomerProductListProduct : DbObject
- Inheritance
-
CustomerProductListProduct
- Inherited Members
Constructors
CustomerProductListProduct()
Initializes a new instance of the CustomerProductListProduct class.
public CustomerProductListProduct()
- See Also
Properties
ListId
Gets or sets the list identifier.
public int ListId { get; set; }
Property Value
- int
- The list identifier.
- See Also
Note
Gets or sets the note.
public string Note { get; set; }
Property Value
- string
- The note.
- See Also
ProductId
Gets or sets the product identifier.
public string ProductId { get; set; }
Property Value
- string
- The product identifier.
- See Also
ProductLanguageId
Gets or sets the product language identifier.
[Obsolete("Not used")]
public string ProductLanguageId { get; set; }
Property Value
- string
- The product language identifier.
- See Also
ProductReferenceUrl
Gets or sets the product reference URL.
public string ProductReferenceUrl { get; set; }
Property Value
- string
- The product reference URL.
- See Also
ProductVariantId
Gets or sets the product variant identifier.
public string ProductVariantId { get; set; }
Property Value
- string
- The product variant identifier.
- See Also
Quantity
Gets or sets the quantity.
public int Quantity { get; set; }
Property Value
- int
- The quantity.
- See Also
SortOrder
Gets or sets the sort order.
public int SortOrder { get; set; }
Property Value
- int
- The sort order.
- See Also
Methods
ClearCache(int, string, string)
Clears the cache.
public static void ClearCache(int favoriteListId, string productId, string variantId)
Parameters
favoriteListId
int- The favorite list identifier.
productId
string- The product identifier.
variantId
string- The product variant identifier.
- See Also
ClearCache(int, string, string, string)
[Obsolete("Use the overload without Language ID")]
public static void ClearCache(int favoriteListId, string productId, string variantId, string languageId)
Parameters
- See Also
Delete(int)
Deletes the object with specified Id.
public override void Delete(int id)
Parameters
id
int- Specified Id.
- See Also
Fill(IDataReader)
Fills the specified reader.
public override void Fill(IDataReader reader)
Parameters
reader
IDataReader- The reader.
- See Also
FillRow(DataRow)
Fills the row.
protected override void FillRow(DataRow row)
Parameters
row
DataRow- The row.
- See Also
GetPagedProductsByListId(int, int, int)
Gets range of products by favorites list id.
public static IEnumerable<CustomerProductListProduct> GetPagedProductsByListId(int id, int startIndex, int pageSize)
Parameters
id
int- The id of favorites list.
startIndex
int- The start index of range.
pageSize
int- The ammount of items.
Returns
- IEnumerable<CustomerProductListProduct>
- The range of products in favorites list
- See Also
GetProductById(int)
Gets product by id.
public static CustomerProductListProduct GetProductById(int favoriteProductId)
Parameters
favoriteProductId
int- The id of the favorite product.
Returns
- See Also
GetProductById(string, string)
Gets product by id.
public static CustomerProductListProduct GetProductById(string productId, string productVariantId)
Parameters
Returns
- See Also
GetProductById(string, string, string)
[Obsolete("Use the overload without Language ID")]
public static CustomerProductListProduct GetProductById(string productId, string productLanguageId, string productVariantId)
Parameters
Returns
- See Also
GetProductByIdAndList(int, string, string)
Gets product by id and favorite list Id.
public static CustomerProductListProduct GetProductByIdAndList(int listId, string productId, string productVariantId)
Parameters
listId
int- The favorite list Id.
productId
string- The id of the product.
productVariantId
string- The variant id of the product.
Returns
- CustomerProductListProduct
- The favorite product
- See Also
GetProductByIdAndList(int, string, string, string)
[Obsolete("Use the overload without Language ID")]
public static CustomerProductListProduct GetProductByIdAndList(int listId, string productId, string productLanguageId, string productVariantId)
Parameters
Returns
- See Also
GetProductsByIds(IEnumerable<string>)
Gets products by ids.
public static IEnumerable<CustomerProductListProduct> GetProductsByIds(IEnumerable<string> productIds)
Parameters
productIds
IEnumerable<string>- The ids of the favorite products.
Returns
- See Also
GetProductsByIds(IEnumerable<string>, string)
[Obsolete("Use the overload without Language ID")]
public static IEnumerable<CustomerProductListProduct> GetProductsByIds(IEnumerable<string> productIds, string languageId)
Parameters
productIds
IEnumerable<string>languageId
string
Returns
- See Also
GetProductsByListId(int)
Gets products by favorites list id.
public static IEnumerable<CustomerProductListProduct> GetProductsByListId(int id)
Parameters
id
int- The id of favorites list.
Returns
- IEnumerable<CustomerProductListProduct>
- The products in favorites list
- See Also
GetProductsByListPublishedId(string)
Gets products by favorites list published id.
public static IEnumerable<CustomerProductListProduct> GetProductsByListPublishedId(string publishedId)
Parameters
publishedId
string- The published id of favorites list.
Returns
- IEnumerable<CustomerProductListProduct>
- The products in favorites list
- See Also
GetProductsByUserId(int)
Gets favorites products by user id.
public static IEnumerable<CustomerProductListProduct> GetProductsByUserId(int userId)
Parameters
userId
int- The id of user.
Returns
- IEnumerable<CustomerProductListProduct>
- The products in favorites list
- See Also
GetProductsByUserId(int, bool)
Gets favorites products by user id.
public static IEnumerable<CustomerProductListProduct> GetProductsByUserId(int UserId, bool useCustomerNumberToRetrieveListsProducts)
Parameters
UserId
int- The id of user.
useCustomerNumberToRetrieveListsProducts
bool- If True returns products for all all users with with current user customer number
Returns
- IEnumerable<CustomerProductListProduct>
- The products in favorites list
- See Also
IsProductInFavorites(Product)
Gets value which indicate whether product is in any favorite list.
public static bool IsProductInFavorites(Product product)
Parameters
product
Product- The product.
Returns
- bool
true
if product is in any favorite list; otherwise,false
.
- See Also
IsProductInFavorites(Product, int)
Gets value which indicate whether product is in the favorite list.
public static bool IsProductInFavorites(Product product, int listId)
Parameters
Returns
- bool
true
if product is in the favorite list; otherwise,false
.
- See Also
Save()
Saves current data to the database.
public override void Save()
- See Also
UpdateQuantity(string, string, int, int)
Updates the quantity.
public static void UpdateQuantity(string productId, string variantId, int favoriteListId, int quantity)
Parameters
productId
string- The product identifier.
variantId
string- The product variant identifier.
favoriteListId
int- The favorite list identifier.
quantity
int- The quantity.
- See Also
UpdateQuantity(string, string, string, int, int)
[Obsolete("Use the overload without Language ID")]
public static void UpdateQuantity(string productId, string variantId, string languageId, int favoriteListId, int quantity)
Parameters
- See Also
UpdateSortOrder(ref string, int, int)
Updates the sort order.
public static void UpdateSortOrder(ref string productId, int favoriteListId, int sortOrder)
Parameters
productId
string- The product identifier.
favoriteListId
int- The favorite list identifier.
sortOrder
int- The sort order.
- See Also