Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration DiscoveryMethod

The possible methods for discovering a reader.

see

https://stripe.com/docs/terminal/readers/connecting

Index

Enumeration Members

BluetoothProximity: 1

If your app will be used in a busy environment with multiple iOS devices pairing to multiple available readers at the same time, we recommend using this discovery method.

After a reader has been discovered using this method, the LEDs located above the reader's power button will start flashing multiple colors. After discovering the reader, your app should prompt the user to confirm that the reader is flashing, and require a user action (e.g. tapping a button) to connect to the reader.

When discovering a reader using this method, the discoverReaders Observable will be called twice. It will be called for the first time when the reader is initially discovered. The reader's LEDs will begin flashing. After a short delay, discoverReaders will be called a second time with an updated reader object, populated with additional info about the device, like its battery level.

The Bluetooth Proximity discovery method can only discovery Chipper 2X BT readers.

BluetoothScan: 0

When discovering a reader using this method, the discoverReaders Observable will be called multiple times as the Bluetooth scan proceeds.

Both: 3

Use both BluetoothScan and Internet discovery methods

This mode is custom to the capacitor-stripe-terminal plugin and uses the native SDK for the BluetoothScan method while simultaneously using the JS SDK for the Internet method.

Internet: 2

The Internet discovery method searches for internet-connected readers, such as the Verifone P400 or the BBPOS WisePOS E.

When discovering a reader with this method, the discoverReaders Observable will only be called once with a list of readers from /v1/terminal/readers. Note that this will include readers that are both online and offline.

Because the discovery process continues if connecting to a discovered reader fails, the SDK will refresh the list of Readers and call your subscriber with the results.

see

https://stripe.com/docs/api/terminal/readers/list

Generated using TypeDoc