POSConnector Allows for communication with the native POS application.

Kind: global class

• POSConnector
  • static
    • .LineItem
      • new LineItem(name, quantity, unitPrice, [vatPercentage], [salesTaxPercentage], [productId], [imei], [discounts], [isExternalProduct], [userId], [contributingUsers], [productVariantId])
    • .Transaction
      • new Transaction(transactionType, amount)
    • .Discount
      • new Discount(description, [amount], [percentage])
    • .Basket
      • new Basket(id, lineItems, [transactions], [discounts], [customerId])
    • .LoginInformation
      • new LoginInformation(shopId, shopName, registerId, registerName, userId, userName)
    • .ContributingUser
      • new ContributingUser(userId, contributionPercentage)
    • .TransactionType : enum
    • .EventType : enum
    • .addEventListener(type, listener)
    • .removeEventListener(listener)
    • .isConnected() ⇒ boolean
    • .payBasket(basket, callback, validate)
    • .addBasket(basket, callback, validate, closeWebview)
    • .getLoginInformation(callback)
    • .openURL(url, callback)
    • .printDocumentAtURL(url, callback)
    • .printDocumentWithData(data, [callback])
    • .sendPOSConnectorObjectPathToPOS(objectPath, [callback])
  • inner
    • ~barcodeScannedListener : function
    • ~payBasketCallback : function
    • ~addBasketCallback : function
    • ~getLoginInformationCallback : function
    • ~openURLCallback : function
    • ~printDocumentCallback : function
    • ~sendPOSConnectorObjectPathToPOSCallback : function

Kind: static class of POSConnector

Represents a line item

Throws:

• Error Missing required fields

Kind: static class of POSConnector

Represents a payment transaction. Can be used to allow the customer to make full or partial payment through your own system, instead of the POS. Note, that after sending a basket to POS, it can still be canceled or fail because of other reasons. In that case you should refund this transaction to the customer yourself.

Kind: static class of POSConnector

Represents a discount on either a basket or a line item. Either amount or percentage must be set, but not both

Throws:

• Error Missing required parameters or incorrectly set amount/percentage

Kind: static class of POSConnector

Represents a shopping basket

Throws:

• Error Missing required parameters

Kind: static class of POSConnector

Kind: static class of POSConnector

Represents a contributing user for line item

Throws:

• Error Missing required parameters or incorrectly set contributionPercentage

Enum of possible transaction types

Kind: static enum property of POSConnector
Properties

Enum of possible event types

Kind: static enum property of POSConnector
Properties

Add an event listener

Kind: static method of POSConnector

Remove an event listener

Kind: static method of POSConnector

Check for connection toward the POS

Kind: static method of POSConnector
Returns: boolean - The connection status

Pass a basket to the POS and immediately go to payment view. Note, that this will skip some steps in POS, like showing shipping method selection, setting delivery date, adding a customer, etc. If you need any of these steps in your order, you should instead use addBasket function

Kind: static method of POSConnector

Pass a basket to the POS but don't go to payment view

Kind: static method of POSConnector

Get current login information from the native POS

Kind: static method of POSConnector

Request opening of a URL from the native application. The URL will open in which ever application the device prefers, typically Safari.

Kind: static method of POSConnector

Request printing of a document located at a URL

Kind: static method of POSConnector

Requests printing of a document with a data object

Kind: static method of POSConnector

Send an object path for the POSConnector to the native POS application. You'd do this if you're utilizing modules or similar and you don't want to depend on having the POSConnector object with that specific variable name in the global scope.

Kind: static method of POSConnector

Passed to POSConnector.addEventListener for EventType.BarcodeScanned

Kind: inner typedef of POSConnector

Passed to the payBasket function

Kind: inner typedef of POSConnector

Passed to the addBasket function

Kind: inner typedef of POSConnector

Passed to the getLoginInformation function

Kind: inner typedef of POSConnector

Passed to the openURL function

Kind: inner typedef of POSConnector

Passed to the printDocumentAtURL and printDocumentData functions

Kind: inner typedef of POSConnector

Passed to the sendPOSConnectorObjectPathToPOS function

Kind: inner typedef of POSConnector