GmsDocumentScannerOptions.Builder

AI-generated Key Takeaways

The GmsDocumentScannerOptions.Builder class is used to build GmsDocumentScannerOptions instances.
It provides methods to configure options such as allowing gallery import, setting a page limit, specifying result formats (JPEG and PDF), and setting the scanner mode.
The build() method finalizes the configuration and creates the GmsDocumentScannerOptions object.

public static class GmsDocumentScannerOptions.Builder extends Object

Builder for GmsDocumentScannerOptions.

Public Constructor Summary

Builder()

Builder for


                    GmsDocumentScannerOptions

Public Method Summary

GmsDocumentScannerOptions	build() Builds a `GmsDocumentScannerOptions` instance.
GmsDocumentScannerOptions.Builder	setGalleryImportAllowed(boolean galleryImportAllowed) Sets whether to show a UI button to allow the user to import images from photo gallery.
GmsDocumentScannerOptions.Builder	setPageLimit(int pageLimit) Sets a page limit for the maximum number of pages that can be scanned in a single scanning session.
GmsDocumentScannerOptions.Builder	setResultFormats(int format, int... moreFormats) Sets scanner `GmsDocumentScannerOptions.ResultFormat`s.
GmsDocumentScannerOptions.Builder	setScannerMode(int scannerMode) Sets the scanner mode which determines what features are enabled.

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Public Constructors

public Builder ()

Builder for GmsDocumentScannerOptions.

Public Methods

public GmsDocumentScannerOptions build ()

Builds a GmsDocumentScannerOptions instance.

public 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 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.