Click or drag to resize

IIdentifierCodeHandlerCheckIdentifierCodeSupport Method (IOrder, IOrderModifierItem, IOrderProductItem, String)

Determines whether this handler can process a raw input string representing a modifier code, and returns handler-specific processing flags.

Namespace:  Resto.Front.Api.Data.Orders
Assembly:  Resto.Front.Api.V9 (in Resto.Front.Api.V9.dll)
Syntax
C#
Copy
IdentifierCodeSupportResult CheckIdentifierCodeSupport(
	IOrder order,
	IOrderModifierItem modifierItem,
	IOrderProductItem parentOrderItem,
	string code
)

Parameters

order
Type: Resto.Front.Api.Data.OrdersIOrder
The order associated with the code.
modifierItem
Type: Resto.Front.Api.Data.OrdersIOrderModifierItem
The modifier item to which the code is being assigned.
parentOrderItem
Type: Resto.Front.Api.Data.OrdersIOrderProductItem
The product item that the modifier is assigned to.
code
Type: SystemString
Raw string input representing the modifier identifier code.

Return Value

Type: IdentifierCodeSupportResult
An IdentifierCodeSupportResult containing:
  • IsSupported — whether this handler can process the code.
  • CodeHandlerFlags Handler-specific flags describing the properties of the code. Must be set if method returns true
  • Message — optional descriptive message.
Remarks
This method is called before the identifier code is added to the order, allowing handlers to indicate whether they support processing of the code. If true is returned and the returned IdentifierCodeHandlerFlags include RequiresVerification, then VerifyIdentifierCode(IOrder, IOrderModifierItem, IOrderProductItem, OrderItemIdentifierCode) will be called during the verification step.
See Also