# GmsDocumentScannerOptions.Builder

public static class **GmsDocumentScannerOptions.Builder** extends [Object](https://developer.android.com/reference/java/lang/Object.html)  
Builder for `https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions`.

### Public Constructor Summary

|---|---|
|   | [Builder](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.Builder#Builder())() Builder for `https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions`. |

### Public Method Summary

|---|---|
| [GmsDocumentScannerOptions](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions) | [build](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.Builder#build())() Builds a `https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions` instance. |
| [GmsDocumentScannerOptions.Builder](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.Builder) | [setGalleryImportAllowed](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.Builder#setGalleryImportAllowed(boolean))(boolean galleryImportAllowed) Sets whether to show a UI button to allow the user to import images from photo gallery. |
| [GmsDocumentScannerOptions.Builder](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.Builder) | [setPageLimit](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.Builder#setPageLimit(int))(int pageLimit) Sets a page limit for the maximum number of pages that can be scanned in a single scanning session. |
| [GmsDocumentScannerOptions.Builder](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.Builder) | [setResultFormats](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.Builder#setResultFormats(int,%20int...))(int format, int... moreFormats) Sets scanner `https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.ResultFormat`s. |
| [GmsDocumentScannerOptions.Builder](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.Builder) | [setScannerMode](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.Builder#setScannerMode(int))(int scannerMode) Sets the scanner mode which determines what features are enabled. |

### Inherited Method Summary

From class java.lang.Object

|---|---|
| [Object](https://developer.android.com/reference/java/lang/Object.html) | clone() |
| boolean | equals([Object](https://developer.android.com/reference/java/lang/Object.html) arg0) |
| void | finalize() |
| final [Class](https://developer.android.com/reference/java/lang/Class.html)\<?\> | getClass() |
| int | hashCode() |
| final void | notify() |
| final void | notifyAll() |
| [String](https://developer.android.com/reference/java/lang/String.html) | toString() |
| final void | wait(long arg0, int arg1) |
| final void | wait(long arg0) |
| final void | wait() |

## Public Constructors

#### public **Builder** ()

Builder for `https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions`.

## Public Methods

#### public [GmsDocumentScannerOptions](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions) **build**
()

Builds a `https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions` instance.

#### public [GmsDocumentScannerOptions.Builder](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.Builder) **setGalleryImportAllowed** (boolean galleryImportAllowed)

Sets whether to show a UI button to allow the user to import images from photo
gallery.

The default value is `true`.

#### public [GmsDocumentScannerOptions.Builder](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.Builder) **setPageLimit** (int pageLimit)

Sets a page limit for the maximum number of pages that can be scanned in a single
scanning session.

The provided value should be be greater than or equal to 1.

If no page limit is set, the restriction on the number of pages that can be scanned
is determined by hardware resources, for example, memory, disk storage.

#### public [GmsDocumentScannerOptions.Builder](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.Builder) **setResultFormats** (int format, int... moreFormats)

Sets scanner `https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.ResultFormat`s.

Available formats: `https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions#RESULT_FORMAT_JPEG`, `https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions#RESULT_FORMAT_PDF`.

The default value is `https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions#RESULT_FORMAT_JPEG`.

#### public [GmsDocumentScannerOptions.Builder](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.Builder) **setScannerMode** (int scannerMode)

Sets the scanner mode which determines what features are enabled.

Available modes: `https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions#SCANNER_MODE_FULL`, `https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions#SCANNER_MODE_BASE_WITH_FILTER`, `https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions#SCANNER_MODE_BASE`.

The default value is `https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions#SCANNER_MODE_FULL`.