Click or drag to resize

IOperationService Interface

Namespace:  Resto.Front.Api
Assembly:  Resto.Front.Api.V6 (in Resto.Front.Api.V6.dll)
Syntax
C#
public interface IOperationService

The IOperationService type exposes the following members.

Methods
  NameDescription
Public methodAddClientToOrder
Returns true if client is bound to the order.
Public methodAddDonation
Adds new donation to order.
Public methodAddErrorMessage(String, String)
Shows non-modal error message in the left top corner of the screen.
Public methodAddErrorMessage(String, String, NullableTimeSpan)
Shows non-modal error message in the left top corner of the screen.
Public methodAddNotificationMessage(String, String)
Shows non-modal notification message in the left top corner of the screen.
Public methodAddNotificationMessage(String, String, NullableTimeSpan)
Shows non-modal notification message in the left top corner of the screen.
Public methodAddWarningMessage(String, String)
Shows non-modal warning message in the left top corner of the screen.
Public methodAddWarningMessage(String, String, NullableTimeSpan)
Shows non-modal warning message in the left top corner of the screen.
Public methodAuthenticateByPin
Public methodBillOrder
Changes the order to Bill status and returns text of bill cheque.
Public methodCalculateDeliveryTerminalWorkload
Returns terminal workload.
Public methodCallExternalOperation
Calls an operation which is implemented in another plugin.
Public methodCancelBill
Сhanges the order to the New status and prints the bill cancellation cheque.
Public methodCancelNewDelivery
Cancels new delivery.
Public methodCancelNewDeliveryAndHideItemsFromOlap
Cancels new delivery and hides delivery order items from OLAP reports.
Public methodCancelReserve
Cancels reservation due to some reason
Public methodCanProductBePaidWithPaymentType
Function describes if the product is compatible with payment type, i.e. payment type can be used to pay for the product.
Public methodChangeDeliveryOpinion
Changes client's opinion on closed delivery.
Public methodChangePreliminaryOrder
Changes preliminary order.
Public methodCheckCanEditOrder
If current user has permissions to view order.
Public methodCheckProductsSellingRestrictions
If current user can add these products with such amounts.
Public methodCloseCafeSession
Closes cafe session.
Public methodCreateDiscountCard
Creates a new discount card.
Public methodCreateEditSession
Creates an edit session. All changes made with this session will be accumulated without affecting entities. Use SubmitChanges(ICredentials, IEditSession) method to apply all changes or do nothing to discard them.
Public methodCreatePreliminaryOrder
Create new preliminary order.
Public methodDeleteDonation
Deletes existing donation from the order.
Public methodDeleteOrder
Deletes order. Order must have no printed items. User must have rights to edit orders.
Public methodDeleteOrderAndHideItemsFromOlap
Deletes order and hides order items from OLAP reports. Order must have no printed items, no payment items and no removed with writeoff items. User must have rights to edit orders.
Public methodDeletePreliminaryOrder
Deletes preliminary order
Public methodEnablePreliminaryOrdersScreen
Enable preliminary orders screen for iikoFront user.
Public methodExecuteContinuousOperation
Executes the callback function as one continuous operation by providing temporary instance of IOperationService, which holds internal locks taken on lockable entities (such as order) until the operation ends. It's strongly recommended to avoid potentially obstructive calls in the callback, i.e network calls, heavy I/O or CPU-bound calls, thread blocking and so on, because touched entities will remain locked for a long time.
Public methodGetActivePaymentTypes
Returns active payment types bound to the specified processor.
Public methodGetActiveProducts
Public methodGetActiveRemovalTypes
Gets removal types which are allowed to use.
Public methodGetActiveStreets Obsolete.
Public methodGetAgentId
Public methodGetAllProducts
Gets all products (both active and inactive).
Public methodGetAllStreets Obsolete.
Public methodGetCafeSessionByCashRegister
Returns current open cafe session on cash register.
Public methodGetCafeSessionById
Returns cafeSession by id.
Public methodGetCashRegisterInfoById
Returns cashRegisterInfo by id.
Public methodGetCashRegisterInfos
Public methodGetChildGroupsByProductGroup
Returns childGroups of the specified productGroup.
Public methodGetChildProductsByProductGroup
Returns childProducts of the specified productGroup.
Public methodGetCities
Public methodGetCityById
Returns city by id.
Public methodGetClientById
Returns client by id.
Public methodGetCommonGroupModifiersByCompoundItemTemplate
Returns commonGroupModifiers of the specified compoundItemTemplate.
Public methodGetCommonSimpleModifiersByCompoundItemTemplate
Returns commonSimpleModifiers of the specified compoundItemTemplate.
Public methodGetCompoundItemTemplateById
Returns compoundItemTemplate by id.
Public methodGetCompoundItemTemplates
Public methodGetConceptionById
Returns conception by id.
Public methodGetConceptions
Public methodGetDeletedOrderTypes
Public methodGetDeliveryCancelCauseById
Returns deliveryCancelCause by id.
Public methodGetDeliveryCancelCauses
Public methodGetDeliveryOrderById
Returns deliveryOrder by id.
Public methodGetDeliveryOrders
Public methodGetDeliverySection
Returns section of current group where delivery orders are created. Is determined by default table of group.
Public methodGetDisabledSizesByProduct
Returns disabledSizes of the specified product.
Public methodGetDiscountCardById
Returns discountCard by id.
Public methodGetDiscountCards
Public methodGetDiscountTypeById
Returns discountType by id.
Public methodGetDiscountTypes
Public methodGetDonationTypesCompatibleWith
Gets donation types which are allowed to use with the order.
Public methodGetExternalOperations
Returns currently registered external operations grouped by service name.
Public methodGetGroupModifiersByProduct
Returns groupModifiers of the specified product.
Public methodGetHierarchicalMenu
Public methodGetHostDeliverySettings
Returns delivery settings of restaurant
Public methodGetHostRestaurant
Public methodGetHostTerminal
Returns info about the current terminal.
Public methodGetHostTerminalCultureInfo
Public methodGetHostTerminalPointsOfSale
Returns list of points of sale attached to current terminal. Empty list means that current terminal is not cash terminal.
Public methodGetHostTerminalsGroup
Public methodGetInactiveProducts Obsolete.
Public methodGetIncludedInMenuSectionsByProduct
Returns includedInMenuSections of the specified product.
Public methodGetKitchenOrderById
Returns kitchenOrder by id.
Public methodGetKitchenOrders
Public methodGetLastChangedOrderTerminal
Returns termnal that changed order last time.
Public methodGetMarketingSourceById
Returns marketingSource by id.
Public methodGetMarketingSources
Public methodGetOrderAppliedDiscounts
Public methodGetOrderById
Public methodGetOrderItemProductGroups
Returns product groups from the specified order. Products in each group are intended to be cooked together.
Public methodGetOrders
Public methodGetOrderTypeById
Returns orderType by id.
Public methodGetOrderTypes
Public methodGetOrganizationFingerprint
Returns a fingerprint which can be used to identify an iikoRMS server instance.
Public methodGetParentByProduct
Returns parent of the specified product.
Public methodGetParentByProductGroup
Returns parent of the specified productGroup.
Public methodGetPastOrder
Get closed order data from server, and returns it.
Public methodGetPaymentSystemName
Tries to return a string for matching the payment type to the payment system if it exists, elseway returns empty string.
Public methodGetPaymentTypeById
Returns paymentType by id.
Public methodGetPaymentTypes
Public methodGetPaymentTypesToPayOutOnUser
Returns payment types that can be processed “silently”, without user interface.
Public methodGetPointOfSaleById
Returns pointOfSale by id.
Public methodGetPreliminaryOrderById
Returns preliminaryOrder by id or null if preliminaryOrder with specified id doesn't exist.
Public methodGetPreliminaryOrders
Get all preliminary orders.
Public methodGetPrice
Returns price for the product according to the given client price category.
Public methodGetPriceCategories
Public methodGetPriceCategoryById
Returns priceCategory by id.
Public methodGetProductById
Returns product by id.
Public methodGetProductCategories
Public methodGetProductCategoryById
Returns productCategory by id.
Public methodGetProductGroupById
Returns productGroup by id.
Public methodGetProductGroupMenuImage
Returns a byte sequence presenting an image to be shown as a background on a menu button for the specified product group. If the product group doesn't have an image, null will be returned.
Public methodGetProductGroups
Public methodGetProductMenuImage
Returns a byte sequence presenting an image to be shown as a background on a menu button for the specified product. If the product doesn't have an image, null will be returned.
Public methodGetProducts Obsolete.
Public methodGetProductScaleById
Returns productScale by id.
Public methodGetProductScales
Public methodGetProductScaleSizes
Public methodGetProductSizeById
Returns productSize by id.
Public methodGetProductSizes
Public methodGetProductsRemainingAmounts
Gets remaining amounts of products in stop list.
Public methodGetProductStocksListById
Returns productStocksList by id.
Public methodGetProductStocksLists
Public methodGetQuickMenu
Returns quick menu for specified restaurant section and day.
Public methodGetReceiptMarkup
Get reciept markup of the payment.
Public methodGetRegionById
Returns region by id.
Public methodGetRegions
Public methodGetRelatedDeliveryOrders
Gets all deliveries that are related with argument through splitting between cash registers. Delivery itself is also returned. If delivery was not split, returns delivery passed as argument.
Public methodGetRemovalTypeById
Returns removalType by id.
Public methodGetReportPrinter
Get instance of report printer
Public methodGetReserveById
Returns reserve by id.
Public methodGetReserves
Public methodGetRestaurantSections
Gets list of restaurant sections of the current terminals group.
Public methodGetSectionSchemaById
Returns sectionSchema by id.
Public methodGetSectionSchemaByRestaurantSection
Returns sectionSchema of the specified restaurantSection.
Public methodGetSectionSchemas
Public methodGetSelectiveDiscountItemSettings
Returns order items to which the specified selective discount item is applied or null if the discount item is applied to the whole order.
Public methodGetSimpleModifiersByProduct
Returns simpleModifiers of the specified product.
Public methodGetSplittableGroupModifiersByCompoundItemTemplate
Returns splittableGroupModifiers of the specified compoundItemTemplate.
Public methodGetSplittableSimpleModifiersByCompoundItemTemplate
Returns splittableSimpleModifiers of the specified compoundItemTemplate.
Public methodGetStreetById
Returns street by id.
Public methodGetSurveyItemById
Returns surveyItem by id.
Public methodGetSurveyItems
Public methodGetTableById
Returns table by id.
Public methodGetTables
Public methodGetTaxCategories
Public methodGetTaxCategoryById
Returns taxCategory by id.
Public methodGetTemplatedModifiersParamsByProduct
Returns templatedModifiersParams of the specified product.
Public methodGetTerminalDeliveryDuration
Returns courier and self-service delivery duration time set on a delivery terminal.
Public methodGetTerminalsGroupPointsOfSale
Returns list of points of sale in group.
Public methodGetTransportSettings
Returns iikoTransport settings.
Public methodGetUpdatedDeliveryOrders
Public methodGetUser
Get user corresponding to specified credentials.
Public methodGetUserById
Returns user by id.
Public methodGetUsers
Public methodIsActiveForDeliveries
Public methodIsAllCafeSessionsOpen
Returns true if all cafe sessions is open.
Public methodIsDeliveryActive
Returns whether delivery is active.
Public methodIsDeliveryConfirmationActive
Returns whether delivery confirmation is active.
Public methodIsMultiCashRegisterConfiguration
Returns true if multi cash register configuration allowed.
Public methodIsProductSellingRestricted
Checks remaining amount of the product and determines whether selling of that product is restricted.
Public methodNeedToSplitOrderBeforePayment
Checks if order should be splitted between cash registers before payment. Method also returns estimated point of sale for order if it can be determinated at the moment.
Public methodOpenCafeSession
Opens cafe session.
Public methodPayOrder
Pay order with included processed payment items.
Public methodPayOrderAndPayOutOnUser
Pay order and pay out on user.
Public methodPrint
Print document on specified printer.
Public methodPrintBanquet
Prints preliminary document with estimated event date and time, planned menu, guests count, client contacts, prepay info, etc.
Public methodPrintBillCheque
Changes the order to Bill status if it is not Bill and prints bill cheque.
Public methodPrintOrderItems
Prints service cheque for defined order item products.
Public methodPrintReceiptCheque
Printing receipts to a printer.
Public methodPrintTableReservedCheque
Prints short “Table reserved” document with estimated event date and time, guests count and client contacts. Can be used to place onto reserved table as a hint not to occupy it.
Public methodProcessPrepay
Processes existing payment item. Payment item should be processed externally or supports silent processing.
Public methodRegisterBillChequeTaskResolver
Registers the bill cheque task resolver.
Public methodRegisterCashRegisterFactory
Registers cash register factory.
Public methodRegisterChequeTaskProcessor
Registers chequeTaskProcessor for extansion the functionality of the cash register.
Public methodRegisterExternalOperation
Exposes a custom operation to be available for call by other plugins. The registration is not permanent, it holds true until disposing the return value, or plugin shutdown.
Public methodRegisterPaymentSystem
Registers payment system.
Public methodRegisterScaleFactory
Registers scale factory.
Public methodRemoveOrderClient
Returns true if client is unbound of the order.
Public methodSearchClients
Search clients. The number of results is limited.
Public methodSearchDiscountCardByNumber
Searches a discount card by given card number.
Public methodSearchStreets
Searches streets and returns limited number of results.
Public methodSendHrsCardTransactionToServer
Sends guest data to the server.
Public methodSplitOrderBetweenCashRegisters
Split order between cash registers according to the current point of sale mapping.
Public methodStartCourseCooking
Starts cooking for all order item products of the specified course.
Public methodStartProductsCooking
Starts cooking for the specified order item products.
Public methodStartService
Starts the specified service.
Public methodStopService
Stops the specified service.
Public methodSubmitChanges
Applies all changes made with specified edit session.
Public methodTryGetBillPrinter
Try get bill printer for specified restaurant section.
Public methodTryGetCafeSessionById
Returns cafeSession by id or null if cafeSession with specified id doesn't exist.
Public methodTryGetCashRegisterInfoById
Returns cashRegisterInfo by id or null if cashRegisterInfo with specified id doesn't exist.
Public methodTryGetChildGroupsByProductGroup
Returns childGroups of the specified productGroup or null if productGroup doesn't exist.
Public methodTryGetChildProductsByProductGroup
Returns childProducts of the specified productGroup or null if productGroup doesn't exist.
Public methodTryGetCityById
Returns city by id or null if city with specified id doesn't exist.
Public methodTryGetClientById
Returns client by id or null if client with specified id doesn't exist.
Public methodTryGetClientByPhone
Returns client by phone.
Public methodTryGetCommonGroupModifiersByCompoundItemTemplate
Returns commonGroupModifiers of the specified compoundItemTemplate or null if compoundItemTemplate doesn't exist.
Public methodTryGetCommonSimpleModifiersByCompoundItemTemplate
Returns commonSimpleModifiers of the specified compoundItemTemplate or null if compoundItemTemplate doesn't exist.
Public methodTryGetCompoundItemTemplateById
Returns compoundItemTemplate by id or null if compoundItemTemplate with specified id doesn't exist.
Public methodTryGetConceptionById
Returns conception by id or null if conception with specified id doesn't exist.
Public methodTryGetDeliveryCancelCauseById
Returns deliveryCancelCause by id or null if deliveryCancelCause with specified id doesn't exist.
Public methodTryGetDeliveryOrderById
Returns deliveryOrder by id or null if deliveryOrder with specified id doesn't exist.
Public methodTryGetDisabledSizesByProduct
Returns disabledSizes of the specified product or null if product doesn't exist.
Public methodTryGetDiscountCardById
Returns discountCard by id or null if discountCard with specified id doesn't exist.
Public methodTryGetDiscountTypeById
Returns discountType by id or null if discountType with specified id doesn't exist.
Public methodTryGetDocumentPrinter
Try get document printer for specified restaurant section.
Public methodTryGetGroupModifiersByProduct
Returns groupModifiers of the specified product or null if product doesn't exist.
Public methodTryGetIncludedInMenuSectionsByProduct
Returns includedInMenuSections of the specified product or null if product doesn't exist.
Public methodTryGetKitchenOrderById
Returns kitchenOrder by id or null if kitchenOrder with specified id doesn't exist.
Public methodTryGetMarketingSourceById
Returns marketingSource by id or null if marketingSource with specified id doesn't exist.
Public methodTryGetOrderById
Public methodTryGetOrderExternalDataByKey
Public methodTryGetOrderTypeById
Returns orderType by id or null if orderType with specified id doesn't exist.
Public methodTryGetParentByProduct
Returns parent of the specified product or null if product doesn't exist.
Public methodTryGetParentByProductGroup
Returns parent of the specified productGroup or null if productGroup doesn't exist.
Public methodTryGetPaymentTypeById
Returns paymentType by id or null if paymentType with specified id doesn't exist.
Public methodTryGetPointOfSaleById
Returns pointOfSale by id or null if pointOfSale with specified id doesn't exist.
Public methodTryGetPreliminaryOrderById
Returns preliminaryOrder by id.
Public methodTryGetPriceCategoryById
Returns priceCategory by id or null if priceCategory with specified id doesn't exist.
Public methodTryGetProductById
Returns product by id or null if product with specified id doesn't exist.
Public methodTryGetProductCategoryById
Returns productCategory by id or null if productCategory with specified id doesn't exist.
Public methodTryGetProductGroupById
Returns productGroup by id or null if productGroup with specified id doesn't exist.
Public methodTryGetProductScaleById
Returns productScale by id or null if productScale with specified id doesn't exist.
Public methodTryGetProductSizeById
Returns productSize by id or null if productSize with specified id doesn't exist.
Public methodTryGetProductStocksListById
Returns productStocksList by id or null if productStocksList with specified id doesn't exist.
Public methodTryGetReceiptChequePrinter
Try get receipt cheque printer for default cash register.
Public methodTryGetRegionById
Returns region by id or null if region with specified id doesn't exist.
Public methodTryGetRemovalTypeById
Returns removalType by id or null if removalType with specified id doesn't exist.
Public methodTryGetReserveById
Returns reserve by id or null if reserve with specified id doesn't exist.
Public methodTryGetSectionSchemaById
Returns sectionSchema by id or null if sectionSchema with specified id doesn't exist.
Public methodTryGetSectionSchemaByRestaurantSection
Returns sectionSchema of the specified restaurantSection or null if restaurantSection doesn't exist.
Public methodTryGetSimpleModifiersByProduct
Returns simpleModifiers of the specified product or null if product doesn't exist.
Public methodTryGetSplittableGroupModifiersByCompoundItemTemplate
Returns splittableGroupModifiers of the specified compoundItemTemplate or null if compoundItemTemplate doesn't exist.
Public methodTryGetSplittableSimpleModifiersByCompoundItemTemplate
Returns splittableSimpleModifiers of the specified compoundItemTemplate or null if compoundItemTemplate doesn't exist.
Public methodTryGetStickerPrinter
Try get sticker printer for specified restaurant section.
Public methodTryGetStreetById
Returns street by id or null if street with specified id doesn't exist.
Public methodTryGetSurveyItemById
Returns surveyItem by id or null if surveyItem with specified id doesn't exist.
Public methodTryGetTableById
Returns table by id or null if table with specified id doesn't exist.
Public methodTryGetTaxCategoryById
Returns taxCategory by id or null if taxCategory with specified id doesn't exist.
Public methodTryGetTemplatedModifiersParamsByProduct
Returns templatedModifiersParams of the specified product or null if product doesn't exist.
Public methodTryGetUserById
Returns user by id or null if user with specified id doesn't exist.
Public methodUpdateDiscountCard
Updates an existing discount card.
Top
Extension Methods
  NameDescription
Public Extension MethodAddDiscount
Adds simple discount of known type to existing order. User must have rights to work with discounts.
(Defined by OperationServiceExtensions.)
Public Extension MethodAddDiscountByCardNumber
Add discount by card number.
(Defined by OperationServiceExtensions.)
Public Extension MethodAddExternalPaymentItem(Decimal, Boolean, IPaymentItemAdditionalData, IPaymentType, IOrder, ICredentials)Overloaded.
Add new external payment item to order.
(Defined by OperationServiceExtensions.)
Public Extension MethodAddExternalPaymentItem(Guid, Decimal, Boolean, IPaymentItemAdditionalData, IPaymentType, IOrder, ICredentials)Overloaded.
Add new external payment item to order.
(Defined by OperationServiceExtensions.)
Public Extension MethodAddFlexibleSumDiscount
Adds simple discount of known type to existing order. User must have rights to work with discounts.
(Defined by OperationServiceExtensions.)
Public Extension MethodAddFlexibleSumDiscountByCardNumber
Add discount by card number.
(Defined by OperationServiceExtensions.)
Public Extension MethodAddOrderCombo
Create order combo item. Order must contain new combo items.
(Defined by OperationServiceExtensions.)
Public Extension MethodAddOrderExternalData
Adds external data to the order. Use DeleteOrderExternalData(IOperationService, String, IOrder, ICredentials) to delete the data when it's no longer needed.
(Defined by OperationServiceExtensions.)
Public Extension MethodAddOrderGuest(String, IOrder, ICredentials)Overloaded.
Adds new guest to existing order. User must have rights to edit orders.
(Defined by OperationServiceExtensions.)
Public Extension MethodAddOrderGuest(Guid, String, IOrder, ICredentials)Overloaded.
Adds new guest with the given ID to existing order. User must have rights to edit orders.
(Defined by OperationServiceExtensions.)
Public Extension MethodAddOrderModifierItem(Int32, IProduct, IProductGroup, IOrder, IOrderProductItem, ICredentials, NullableDecimal)Overloaded.
Adds order item modifier to the order item in existing order. User must have rights to edit orders.
(Defined by OperationServiceExtensions.)
Public Extension MethodAddOrderModifierItem(Int32, IProduct, IProductGroup, IOrder, IOrderCompoundItem, ICredentials, NullableDecimal)Overloaded.
Adds order item modifier to the compound item in existing order. User must have rights to edit orders.
(Defined by OperationServiceExtensions.)
Public Extension MethodAddOrderModifierItem(Int32, IProduct, IProductGroup, IOrder, IOrderCompoundItemComponent, ICredentials, NullableDecimal)Overloaded.
Adds order item modifier to the compound item component in existing order. User must have rights to edit orders.
(Defined by OperationServiceExtensions.)
Public Extension MethodAddOrderModifierItem(Guid, Int32, IProduct, IProductGroup, IOrder, IOrderProductItem, ICredentials, NullableDecimal)Overloaded.
Adds order item modifier to the order item in existing order. User must have rights to edit orders.
(Defined by OperationServiceExtensions.)
Public Extension MethodAddOrderModifierItem(Guid, Int32, IProduct, IProductGroup, IOrder, IOrderCompoundItem, ICredentials, NullableDecimal)Overloaded.
Adds order item modifier to the compound item in existing order. User must have rights to edit orders.
(Defined by OperationServiceExtensions.)
Public Extension MethodAddOrderModifierItem(Guid, Int32, IProduct, IProductGroup, IOrder, IOrderCompoundItemComponent, ICredentials, NullableDecimal)Overloaded.
Adds order item modifier to the compound item component in existing order. User must have rights to edit orders.
(Defined by OperationServiceExtensions.)
Public Extension MethodAddOrderProductItem(Decimal, IProduct, IOrder, IOrderGuestItem, IProductSize, ICredentials, OrderItemCourse, NullableDecimal)Overloaded.
Adds assortment position to the guest in existing order. User must have rights to edit orders.
(Defined by OperationServiceExtensions.)
Public Extension MethodAddOrderProductItem(Guid, Decimal, IProduct, IOrder, IOrderGuestItem, IProductSize, ICredentials, OrderItemCourse, NullableDecimal)Overloaded.
Adds assortment position to the guest in existing order. User must have rights to edit orders.
(Defined by OperationServiceExtensions.)
Public Extension MethodAddOrderServiceItem
Adds time pay service item to the guest in existing order. User must have permission to edit orders.
(Defined by OperationServiceExtensions.)
Public Extension MethodAddPaymentItem(Decimal, IPaymentItemAdditionalData, IPaymentType, IOrder, ICredentials)Overloaded.
Add new payment item to order.
(Defined by OperationServiceExtensions.)
Public Extension MethodAddPaymentItem(Guid, Decimal, IPaymentItemAdditionalData, IPaymentType, IOrder, ICredentials)Overloaded.
Add new payment item to order.
(Defined by OperationServiceExtensions.)
Public Extension MethodAddPreliminaryPaymentItem(Decimal, IPaymentItemAdditionalData, IPaymentType, IDeliveryOrder, ICredentials)Overloaded.
Add new preliminary payment item to order.
(Defined by OperationServiceExtensions.)
Public Extension MethodAddPreliminaryPaymentItem(Guid, Decimal, IPaymentItemAdditionalData, IPaymentType, IDeliveryOrder, ICredentials)Overloaded.
Add new preliminary payment item to order.
(Defined by OperationServiceExtensions.)
Public Extension MethodBindReserveToOrder
Converts exising reserve or banquet without order to banquet with order.
(Defined by OperationServiceExtensions.)
Public Extension MethodCallExternalOperationTRequest, TResponse
Calls an operation which is implemented in another plugin.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeClientAddresses
Changes client addresses.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeClientBirthDate
Changes client's birth date.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeClientBlacklistInfo
Changes client blacklist info.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeClientCardNumber
Changes client card number.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeClientComment
Changes client comment.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeClientEmails
Changes client emails list.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeClientGender
Change client's gender.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeClientIikoBizId
Changes client's account in iiko.biz.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeClientIikoNetId
Changes client's account in Plazius.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeClientLastOrderDate
Changes client's last order date.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeClientLinkedCounteragent
Changes client linked counter agent.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeClientMainAddressIndex
Changes client main address index.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeClientMarketingSource
Changes client marketing source.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeClientName
Changes client name.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeClientNick
Changes client nickname.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeClientPersonalDataConsent
Changes whether client consented processing their personal data.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeClientPhones
Changes client phones list.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeClientReceivesNotifications
Changes whether client receives notification messages.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeClientSurname
Changes client surname.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeComboAmount
Change combo amount.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeComboPrice
Change combo price.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeCookingPriority
Changes custom cooking priority and top priority flag.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeDeliveryActualDeliverTime
Change time when the order was actually delivered.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeDeliveryAddress
Changes address of delivery
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeDeliveryComment
Change the order comment.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeDeliveryConfirmTime
Change when the order was confirmed.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeDeliveryCourier
Assign/Change the order courier. Can use this action only before the order is to be delivered.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeDeliveryCustomApiData
Change the delivery custom data from api.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeDeliveryDuration
Change duration of delivery processing.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeDeliveryEmail
Change the order e-mail.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeDeliveryExpectedDeliverTime
Change time when client wants the order to be delivered.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeDeliveryLastDefaultTerminalDeliveryDurationInMinutes
Set calculated delivery duration without overrided value on terminal.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeDeliveryLastVerifiedRestrictionsHash
Set last verified restirictions hash from server.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeDeliveryLocation
Changes delivery address location.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeDeliveryMarketingSource
Assign/change order marketing source.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeDeliveryOperator
Assign/change the order operator.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeDeliveryOrderPredictedCookingCompleteTime
Change predicted time when the order cooking should be completed. Can change property only for Unconfirmed, New or Waiting delivery.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeDeliveryPhone
Changes the order phone.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeDeliveryPredictedDeliveryTime
Change predicted time when the order should be delivered. Can change property only for Unconfirmed, New or Waiting delivery.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeDeliveryProblemComment
Change the order problem comment.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeDeliveryProblemStatus
Change the order problem status.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeDeliverySplitBetweenPersons
Changes the order property if it should be splitted between persons.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeEstimatedOrderGuestsCount
Changes estimated order guests count. Use this method to set estimated guests count when guests collection doesn't reflect actual state of affairs.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeExternalPaymentItemCustomData
Changes custom data of existing external payment item.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeOrderAppliedIikoCard5ManualConditions
Change iikoCard5 manual conditions applied for order.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeOrderCookingItemAmount
Changes the amount of the assortment position in existing order. User must have rights to edit orders.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeOrderCookingItemCourse
Changes the course of the order item.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeOrderCookingItemSize
Changes the product size of the order item.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeOrderIikoCard5Coupon
Change order iikoCard5 coupon, used in iikoCard5 system.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeOrderItemComment
Changes product order item's comment.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeOrderItemWaiter
Changes product order item's waiter.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeOrderModifierItemAmount(Int32, IOrder, IOrderProductItem, IOrderModifierItem, ICredentials)Overloaded.
Changes the amount of the product item modifier. User must have rights to edit orders.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeOrderModifierItemAmount(Int32, IOrder, IOrderCompoundItem, IOrderModifierItem, ICredentials)Overloaded.
Changes the amount of the compound item common modifier. User must have rights to edit orders.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeOrderModifierItemAmount(Int32, IOrder, IOrderCompoundItemComponent, IOrderModifierItem, ICredentials)Overloaded.
Changes the amount of the compound component modifier. User must have rights to edit orders.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeOrderOriginName
Sets order origin — name of the source this order was received from. Specifying origin allows to analyse efficiency of external order sources such as different web-sites, mobile applications and so on. Origin name can be set only once.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeOrderPricingTime
Change order pricing time, which determines the price of products. By default time taken from items print time.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeOrderTables
Changes tables of the order.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeOrderWaiter
Changes order's waiter.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangePaymentItemCustomData
Changes custom data of existing payment item.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangePaymentItemSum
Changes sum of existing payment item.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangePreliminaryPaymentItemCustomData
Changes custom data of existing preliminary payment item.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangePreliminaryPaymentItemSum
Changes sum of existing preliminary payment item.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangePriceCategory
Changes price category of the order.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeReserveComment
Changes reserve comment. Use empty string to clear comment.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeReserveDuration
Changes estimated reserve duration (amount of time betwen visit's start and end). Default reserve duration is 2 hours, banquet duration is 3 hours.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeReserveEstimatedStartTime
Changes estimated reserve start time.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeReserveGuestsCount
Changes estimated guests count for reserve. Default value is 2.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeReserveReminder
Changes reserve reminder flag.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeReserveTable
Changes reserving tables.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeReserveTables
Changes reserving tables.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeSelectiveDiscount
Change discount item selective application settings. Set both products and modifiers to null if you want the discount item to be applied to the whole order (including future order items), otherwise provide order item products and modifiers for selective discount item application.
(Defined by OperationServiceExtensions.)
Public Extension MethodChangeStreetName
Changes street's name.
(Defined by OperationServiceExtensions.)
Public Extension MethodCreateBanquet(DateTime, IClient, ITable, ICredentials)Overloaded.
Creates reservation for planned event in future. Table will be marked as reserved to prevent collision with other events at the same time.
(Defined by OperationServiceExtensions.)
Public Extension MethodCreateBanquet(DateTime, IClient, IReadOnlyListITable, ICredentials)Overloaded.
Creates reservation for planned event in future. Table will be marked as reserved to prevent collision with other events at the same time.
(Defined by OperationServiceExtensions.)
Public Extension MethodCreateBanquet(DateTime, IClient, IOrder, ICredentials)Overloaded.
Creates reservation for planned event in future. Order's table will be marked as reserved to prevent collision with other events at the same time.
(Defined by OperationServiceExtensions.)
Public Extension MethodCreateClient
Creates new client. The client must have a card number or at least one phone number.
(Defined by OperationServiceExtensions.)
Public Extension MethodCreateReserve(DateTime, IClient, ITable, ICredentials)Overloaded.
Creates reservation for planned visit in future. Table will be marked as reserved to prevent collision with other guests at the same time.
(Defined by OperationServiceExtensions.)
Public Extension MethodCreateReserve(DateTime, IClient, IReadOnlyListITable, ICredentials)Overloaded.
Creates reservation for planned visit in future. Table will be marked as reserved to prevent collision with other guests at the same time.
(Defined by OperationServiceExtensions.)
Public Extension MethodCreateStreet(String, ICredentials)Overloaded.
Creates new street.
(Defined by OperationServiceExtensions.)
Public Extension MethodCreateStreet(Guid, String, ICity, ICredentials)Overloaded.
Creates new street.
(Defined by OperationServiceExtensions.)
Public Extension MethodDeleteDiscount
Removes discount of known type from existing order. User must have rights to work with discounts.
(Defined by OperationServiceExtensions.)
Public Extension MethodDeleteExternalPaymentItem
Delete existing external payment item from order.
(Defined by OperationServiceExtensions.)
Public Extension MethodDeleteOrderCombo
Delete order combo item.
(Defined by OperationServiceExtensions.)
Public Extension MethodDeleteOrderExternalData
Deletes external data from the order.
(Defined by OperationServiceExtensions.)
Public Extension MethodDeleteOrderGuest
Deletes guest without any products from order.
(Defined by OperationServiceExtensions.)
Public Extension MethodDeleteOrderItem
Deletes order item from order that represents the assortment position. User must have rights to edit orders.
(Defined by OperationServiceExtensions.)
Public Extension MethodDeleteOrderItemComment
Deletes product order item's comment.
(Defined by OperationServiceExtensions.)
Public Extension MethodDeleteOrderModifierItem(IOrder, IOrderProductItem, IOrderModifierItem, ICredentials)Overloaded.
Deletes order item modifier from order item that represents the assortment position. User must have rights to edit orders.
(Defined by OperationServiceExtensions.)
Public Extension MethodDeleteOrderModifierItem(IOrder, IOrderCompoundItem, IOrderModifierItem, ICredentials)Overloaded.
Deletes order item modifier from order item that represents the assortment position. User must have rights to edit orders.
(Defined by OperationServiceExtensions.)
Public Extension MethodDeleteOrderModifierItem(IOrder, IOrderCompoundItemComponent, IOrderModifierItem, ICredentials)Overloaded.
Deletes order item modifier from order item that represents the assortment position. User must have rights to edit orders.
(Defined by OperationServiceExtensions.)
Public Extension MethodDeleteOrRestoreStreet
Deletes street.
(Defined by OperationServiceExtensions.)
Public Extension MethodDeletePaymentItem
Delete existing payment item from order.
(Defined by OperationServiceExtensions.)
Public Extension MethodDeletePreliminaryPaymentItem
Delete existing preliminary payment item from order.
(Defined by OperationServiceExtensions.)
Public Extension MethodDeletePrintedOrderItem
Deletes order item that is already printed. User must have rights to edit orders.
(Defined by OperationServiceExtensions.)
Public Extension MethodDeletePrintedOrderModifierItem
Deletes order item modifier that is already printed. User must have rights to edit orders.
(Defined by OperationServiceExtensions.)
Public Extension MethodExecuteContinuousOperation(ActionIOperationService)Overloaded.
Executes the callback function as one continuous operation by providing temporary instance of IOperationService, which holds internal locks taken on lockable entities (such as order) until the operation ends. It's strongly recommended to avoid potentially obstructive calls in the callback, i.e network calls, heavy I/O or CPU-bound calls, thread blocking and so on, because touched entities will remain locked for a long time.
(Defined by OperationServiceExtensions.)
Public Extension MethodExecuteContinuousOperationT(FuncIOperationService, T)Overloaded.
Executes the callback function as one continuous operation by providing temporary instance of IOperationService, which holds internal locks taken on lockable entities (such as order) until the operation ends. It's strongly recommended to avoid potentially obstructive calls in the callback, i.e network calls, heavy I/O or CPU-bound calls, thread blocking and so on, because touched entities will remain locked for a long time.
(Defined by OperationServiceExtensions.)
Public Extension MethodGroupOrderCookingItems
Combines the order item products into mix group so that they will be cooked together. Only consecutive products of the same guest can be combined into mix group.
(Defined by OperationServiceExtensions.)
Public Extension MethodMoveOrderItemToAnotherGuest
Moves product item between guests of the same order.
(Defined by OperationServiceExtensions.)
Public Extension MethodMoveOrderItemToAnotherOrder
Moves product item between orders.
(Defined by OperationServiceExtensions.)
Public Extension MethodRegisterBillChequeTaskResolver
Registers the bill cheque task resolver.
(Defined by OperationServiceExtensions.)
Public Extension MethodRegisterExternalOperationTRequest, TResponse
Exposes a custom operation to be available for call by other plugins. The registration is not permanent, it holds true until disposing the return value, or plugin shutdown.
(Defined by OperationServiceExtensions.)
Public Extension MethodRenameOrderGuest
Renames order's guest.
(Defined by OperationServiceExtensions.)
Public Extension MethodReopenReserve
Reopens previously closed or canceled reserve.
(Defined by OperationServiceExtensions.)
Public Extension MethodResetIsPrintedDeliveryBillActual
Resets whether latest printed bill is actual to 'false' value. Use when you want delivery bill to be print again according to settings. For example, if you changed courier and wish to have actual name on the bill, call this action and delivery will automatically printed according to settings. On the contrary, if you don't want bill to be printed again (for example, courier is written to the bill later by hands), you have no need to call this action.
(Defined by OperationServiceExtensions.)
Public Extension MethodResetPriceCategory
Resets price category of the order.
(Defined by OperationServiceExtensions.)
Public Extension MethodServeOrderCookingItem
Mark order item product as served.
(Defined by OperationServiceExtensions.)
Public Extension MethodSetDeliveryConfirmed
Change delivery status to confirmed.
(Defined by OperationServiceExtensions.)
Public Extension MethodSetDeliveryCustomerAuthorizedInIikoBiz
Changes whether the client is already authorized in iiko.biz. WARNING: use with caution! Illegal value can lead to unsuccessful iiko.biz operations. Do NOT set this property to 'true' if you are not sure that all authorization properties are correct and customer is registered in iiko.biz; that will cause iiko.biz payment failure.
(Defined by OperationServiceExtensions.)
Public Extension MethodSetDeliveryCustomerAuthorizedInIikoNet
Changes whether the client is already authorized in Plazius. WARNING: use with caution! Illegal value can lead to unsuccessful Plazius operations. Do NOT set this property to 'true' if you are not sure that all authorization properties are correct and customer is registered in Plazius; that will cause Plazius payment failure.
(Defined by OperationServiceExtensions.)
Public Extension MethodSetDeliveryDelivered
Change delivery status to delivered.
(Defined by OperationServiceExtensions.)
Public Extension MethodSetDeliveryUnconfirmed
Change delivery status to unconfirmed.
(Defined by OperationServiceExtensions.)
Public Extension MethodSetDeliveryUndelivered
Change delivery status to OnWay from status delivered.
(Defined by OperationServiceExtensions.)
Public Extension MethodSetOpenPrice
Changes order item open price.
(Defined by OperationServiceExtensions.)
Public Extension MethodSetOrderType
Sets order type for order.
(Defined by OperationServiceExtensions.)
Public Extension MethodSplitOrderCookingItem
Cut off specified amount from product to new one.
(Defined by OperationServiceExtensions.)
Public Extension MethodStartBanquet
Transits banquet to the started status.
(Defined by OperationServiceExtensions.)
Public Extension MethodUngroupOrderCookingItems
Separates the order item products from mix group so that they will be cooked independently.
(Defined by OperationServiceExtensions.)
Public Extension MethodUnserveOrderCookingItem
Mark order item product as unserved.
(Defined by OperationServiceExtensions.)
Public Extension MethodUpdateOrderComboItems
Update existing order combo items. Order must contain new combo items.
(Defined by OperationServiceExtensions.)
Top
See Also