Package

## Class MultiPageImageCaptureScenario.Builder

-     public final class MultiPageImageCaptureScenario.Builder

  Creates an instance of MultiPageImageCaptureScenario and manages the settings of the scenario, represented by this instance.

- - ### Constructor Summary

    Constructors
    Constructor | Description
    --- | ---
    `Builder(Engine engine, Context context)` |
    `Builder(Engine engine, String path)` |
    `Builder(Engine engine, MultiPageImageCaptureScenario.PageStorage pageStorage)` |

  - ### Method Summary

    Modifier and Type | Method | Description
    --- | --- | ---
    `final MultiPageImageCaptureScenario.Builder` | `setRequiredPageCount(Integer requiredPageCount)` | Sets total number of pages to be captured.
    `final MultiPageImageCaptureScenario.Builder` | `setUISettings(MultiPageImageCaptureScenario.UISettings uiSettings)` | Sets appearance settings to the pages.
    `final MultiPageImageCaptureScenario.Builder` | `setCaptureSettings(MultiPageImageCaptureScenario.CaptureSettings captureSettings)` | Sets additional multipage image capture scenario processing settings.
    `final MultiPageImageCaptureScenario.Builder` | `setStartAsEditorAtPage(String pageId)` | Sets one of the previously captured images as a start page by its identifier.
    `final MultiPageImageCaptureScenario.Builder` | `setShowPreviewEnabled(Boolean isShowPreviewEnabled)` | Enables or disables image preview after capture.
    `final MultiPageImageCaptureScenario.Builder` | `setShouldShowPageViewer(Boolean shouldShowPageViewer)` | Enables or disables page viewer after capture
    `final MultiPageImageCaptureScenario` | `build()` | Returns an instance of a MultiPageImageCaptureScenario.

    - ### Methods inherited from class com.abbyy.mobile.uicomponents.scenario.MultiPageImageCaptureScenario.Builder

      `equals, hashCode, toString`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### Builder

          Builder(Engine engine, Context context)

      Parameters:
        `engine` - Engine object via which image processing is performed.
        `context` - Default storage located in the default folder.

    - #### Builder

          Builder(Engine engine, String path)

      Parameters:
        `engine` - Engine object via which image processing is performed.
        `path` - Custom folder with a default storage.

    - #### Builder

          Builder(Engine engine, MultiPageImageCaptureScenario.PageStorage pageStorage)

  - ### Method Detail

    - #### setRequiredPageCount

          @MainThread() final MultiPageImageCaptureScenario.Builder setRequiredPageCount(Integer requiredPageCount)

      Sets total number of pages to be captured.

      In case the total number of pages is set to 0, there is no limit on the pages number, the result images set can be saved or edited at any time. If the total number of pages is set to a positive value, only the exact number of images can be saved.

      Parameters:
        `requiredPageCount` - The total number of pages to be captured.

    - #### setUISettings

          @MainThread() final MultiPageImageCaptureScenario.Builder setUISettings(MultiPageImageCaptureScenario.UISettings uiSettings)

      Sets appearance settings to the pages.

      Parameters:
        `uiSettings` - A UISettings object, storing the settings for pages appearance.

    - #### setCaptureSettings

          @MainThread() final MultiPageImageCaptureScenario.Builder setCaptureSettings(MultiPageImageCaptureScenario.CaptureSettings captureSettings)

      Sets additional multipage image capture scenario processing settings.

      Parameters:
        `captureSettings` - A CaptureSettings object for managing processing setting of the multipage image capture scenario.

    - #### setStartAsEditorAtPage

          @MainThread() final MultiPageImageCaptureScenario.Builder setStartAsEditorAtPage(String pageId)

      Sets one of the previously captured images as a start page by its identifier. The image with this identifier will be displayed at the scenario beginning. In order to show the camera view at the beginning of the scenario, skip this method or pass null.

      Parameters:
        `pageId` - Identifier of a page to be shown as a start page at the scenario beginning.

    - #### setShowPreviewEnabled

          @MainThread() final MultiPageImageCaptureScenario.Builder setShowPreviewEnabled(Boolean isShowPreviewEnabled)

      Enables or disables image preview after capture.

      Parameters:
        `isShowPreviewEnabled` - This parameter defines if a preview of an image should be shown after capture.

    - #### setShouldShowPageViewer

          @MainThread() final MultiPageImageCaptureScenario.Builder setShouldShowPageViewer(Boolean shouldShowPageViewer)

      Enables or disables page viewer after capture

      Parameters:
        `shouldShowPageViewer` - This parameter defines if a page viewer should be shown after capture.

    - #### build

          @MainThread() final MultiPageImageCaptureScenario build()

      Returns an instance of a MultiPageImageCaptureScenario. This instance will have the settings predefined by Builder class methods.