ShippingOptionInfoProviderExtensions.GetBySite Method

Returns query for all shipping options matching the specified parameters.

Namespace: CMS.Ecommerce
Assembly: CMS.Ecommerce (in CMS.Ecommerce.dll) Version: 13.0.131

Syntax

public static ObjectQuery<ShippingOptionInfo> GetBySite(
	this IShippingOptionInfoProvider shippingOptionInfoProvider,
	int siteId,
	bool onlyEnabled = false
)

Parameters

shippingOptionInfoProvider

Type: CMS.Ecommerce.IShippingOptionInfoProvider
Provider for ShippingOptionInfo management.

siteId

Type: System.Int32
ID of the site the options should be retrieved from. If set to 0, global shipping options are retrieved

onlyEnabled (Optional)

Type: System.Boolean
True - only enabled shipping options from the specified site are returned. False - all site options are returned

Return Value

Type: ObjectQuery<ShippingOptionInfo>

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IShippingOptionInfoProvider. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

Exception	Condition
ArgumentNullException	Thrown when shippingOptionInfoProvider is null.