画面上の入力を収集する

To collect inputs using Terminal’s smart readers, call collectInputs with the Terminal SDK, the SDK communicates with the reader to display a prebuilt UI. You can specify up to 5 inputs at a time, and the reader collects them in sequence. After the customer inputs their data, the SDK returns the collected data with a promise.

const collectInputsParameters = {
  inputs: [
    {
      formType: 'signature',
      title: 'Please sign',
      description: 'Please sign if you agree to the terms and conditions',
      skipButtonText: 'skip',
      submitButtonText: 'Submit signature',
    },
    {
      formType: 'selection',
      title: 'Choose an option',
      description: 'Were you happy with our customer service?',
      required: true,
      selectionButtons: [
        {
          style: 'primary',
          text: 'Yes',
        },
        {
          style: 'secondary',
          text: 'No',
        },
      ],
      toggles: [
        {
          title: 'Sign up for promotional emails',
          defaultValue: 'enabled',
        },
      ],
    },
  ],
};

const result = await this.terminal.collectInputs(collectInputsParameters);
if ('error' in result) {
// Placeholder for handling exception
}
// Placeholder for handling collected inputs

カスタマイズ

すべての入力タイプでデザインと動作をカスタマイズすることができます。

• Set important inputs as required to ensure they’re collected. For required inputs, the Skip button is hidden.
• Provide context to your customer by specifying the text you want to display on the reader screen for each input using title and description.

• Use line breaks \n in your text for better formatting.
• Add up to 4 toggles that customers can enable or disable for Boolean options, agreements, or opt-ins.

トグルを含むメールアドレスと選択フォーム

• For selection type inputs, you can emphasize or de-emphasize choices using the style parameter.

プライマリ選択とセカンダリ選択の項目スタイル。

When the reader begins collecting inputs, it displays the first input from the list.

After the customer has completed all the inputs, the reader changes to a transitional state for 3 seconds, waiting for a subsequent request. If there is no subsequent request after 3 seconds, the reader changes back to the splash screen.

When all inputs have been collected or skipped, the Terminal SDK returns the collected data.

• 署名タイプの入力に対して返されるデータは、SVG 形式の文字列になります。
• For selection type inputs, the returned data are the selected button’s text and id fields.
• 電話、メール、テキスト、数値の各入力に対して返されるデータは、顧客のレスポンスの文字列になります。
• If an optional input is skipped by the customer, the skipped Boolean is set to true.
• トグルごとに、入力トグルリストのインデックスに対応する enabled、disabled、または skipped が返されます。

The Terminal SDK returns an error in the event of a canceled action, timed out collection, or other error.

You can test your integration by using the SDK’s simulated reader. Before you can test input collection, you must first connect to a simulated reader.

The simulated reader supports simulating the following scenarios:

• Successful input collection without skipping any inputs
• Successful input collection with skipping all non-required inputs
• Failed input collection because of a timeout

When simulating successful input collection, the SDK returns a hard-coded value for each input based on the type.

// Simulated internet reader must already be connected
collectInputsResult = {
    resultType: 'succeeded' as SimulatedCollectInputsResultType,
    skipBehavior: 'none' as SimulatedCollectInputsSkipBehavior,
} as ISimulatedCollectInputsResultSucceeded;
this.terminal.setSimulatorConfiguration({ collectInputsResult });
const collectInputsParameters = {
    inputs: // Placeholder for specifying the inputs you want to simulate collecting
};
const result = await this.terminal.collectInputs(collectInputsParameters);
if ('error' in result) {
    // Placeholder for handling exception
} else {
    // Placeholder for handling collected inputs
}