PaymentOptionInfoProviderExtensions.GetBySite Method

Returns query for of all payment options matching the specified parameters.

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

Syntax

public static ObjectQuery<PaymentOptionInfo> GetBySite(
	this IPaymentOptionInfoProvider paymentOptionInfoProvider,
	int siteId,
	bool onlyEnabled = false
)

Parameters

paymentOptionInfoProvider

Type: CMS.Ecommerce.IPaymentOptionInfoProvider
Provider for PaymentOptionInfo management.

siteId

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

onlyEnabled (Optional)

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

Return Value

Type: ObjectQuery<PaymentOptionInfo>

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IPaymentOptionInfoProvider. 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 paymentOptionInfoProvider is null.