Search docsIDmission.com ↗
Mobile SDKs18 pages
Mobile SDKs / IDImageOptions

IDImageOptions

← Browse native SDK reference

Imported 2026-10-21View original source ↗How updates workRead Markdown
On this page · 4 sections
IDentity-SDK/com.idmission.sdk2.client.model/IDImageOptions

IDImageOptions

public final class IDImageOptions implements Parcelable

Provides options to customize images in ID Capture, Retry and Instruction Screens.

Constructors

public IDImageOptions IDImageOptions(@DrawableRes() Integer retryScreenImage, @DrawableRes() Integer captureScreenIdFrontOverlayImage, @DrawableRes() Integer captureScreenIdBackOverlayImage, @DrawableRes() Integer idInstructionImageResId, @DrawableRes() Integer idInstructionBackImageResId, @DrawableRes() Integer documentInstructionImageResId, @DrawableRes() Integer captureBottomBarImage, @DrawableRes() Integer captureScreenCancelBtnImage, @DrawableRes() Integer previewScreenToolbarBackIcon, String previewScreenToolbarBackIconTintColor, <Error class: unknown class><Integer> idCaptureInstructionAnimationImages)
public IDImageOptions IDImageOptions(@DrawableRes() Integer retryScreenImage, @DrawableRes() Integer captureScreenIdFrontOverlayImage, @DrawableRes() Integer captureScreenIdBackOverlayImage, @DrawableRes() Integer idInstructionImageResId, @DrawableRes() Integer idInstructionBackImageResId, @DrawableRes() Integer documentInstructionImageResId, @DrawableRes() Integer captureBottomBarImage, @DrawableRes() Integer captureScreenCancelBtnImage, @DrawableRes() Integer previewScreenToolbarBackIcon, String previewScreenToolbarBackIconTintColor)
public IDImageOptions IDImageOptions(@DrawableRes() Integer retryScreenImage, @DrawableRes() Integer captureScreenIdFrontOverlayImage, @DrawableRes() Integer captureScreenIdBackOverlayImage, @DrawableRes() Integer idInstructionImageResId, @DrawableRes() Integer idInstructionBackImageResId, @DrawableRes() Integer documentInstructionImageResId, @DrawableRes() Integer captureBottomBarImage, @DrawableRes() Integer captureScreenCancelBtnImage, @DrawableRes() Integer previewScreenToolbarBackIcon)
public IDImageOptions IDImageOptions(@DrawableRes() Integer retryScreenImage, @DrawableRes() Integer captureScreenIdFrontOverlayImage, @DrawableRes() Integer captureScreenIdBackOverlayImage, @DrawableRes() Integer idInstructionImageResId, @DrawableRes() Integer idInstructionBackImageResId, @DrawableRes() Integer documentInstructionImageResId, @DrawableRes() Integer captureBottomBarImage, @DrawableRes() Integer captureScreenCancelBtnImage)
public IDImageOptions IDImageOptions(@DrawableRes() Integer retryScreenImage, @DrawableRes() Integer captureScreenIdFrontOverlayImage, @DrawableRes() Integer captureScreenIdBackOverlayImage, @DrawableRes() Integer idInstructionImageResId, @DrawableRes() Integer idInstructionBackImageResId, @DrawableRes() Integer documentInstructionImageResId, @DrawableRes() Integer captureBottomBarImage)
public IDImageOptions IDImageOptions(@DrawableRes() Integer retryScreenImage, @DrawableRes() Integer captureScreenIdFrontOverlayImage, @DrawableRes() Integer captureScreenIdBackOverlayImage, @DrawableRes() Integer idInstructionImageResId, @DrawableRes() Integer idInstructionBackImageResId, @DrawableRes() Integer documentInstructionImageResId)
public IDImageOptions IDImageOptions(@DrawableRes() Integer retryScreenImage, @DrawableRes() Integer captureScreenIdFrontOverlayImage, @DrawableRes() Integer captureScreenIdBackOverlayImage, @DrawableRes() Integer idInstructionImageResId, @DrawableRes() Integer idInstructionBackImageResId)
public IDImageOptions IDImageOptions(@DrawableRes() Integer retryScreenImage, @DrawableRes() Integer captureScreenIdFrontOverlayImage, @DrawableRes() Integer captureScreenIdBackOverlayImage, @DrawableRes() Integer idInstructionImageResId)
public IDImageOptions IDImageOptions(@DrawableRes() Integer retryScreenImage, @DrawableRes() Integer captureScreenIdFrontOverlayImage, @DrawableRes() Integer captureScreenIdBackOverlayImage)
public IDImageOptions IDImageOptions(@DrawableRes() Integer retryScreenImage, @DrawableRes() Integer captureScreenIdFrontOverlayImage)
public IDImageOptions IDImageOptions(@DrawableRes() Integer retryScreenImage)
public IDImageOptions IDImageOptions()

Properties

private Integer captureBottomBarImage

Option to set bottom image in Capture screen.

private Integer captureScreenCancelBtnImage

Option to set bottom image in Capture screen.

private Integer captureScreenIdBackOverlayImage

Option to set image in Back Overlay for ID.

private Integer captureScreenIdFrontOverlayImage

Option to set image in Front Overlay for ID.

private Integer documentInstructionImageResId

Option to set image in Instruction screen for Document Capture.

private <Error class: unknown class><Integer> idCaptureInstructionAnimationImages

Option to set image list in Instruction screen for ID.

private Integer idInstructionBackImageResId

Option to set image in Instruction screen for back button.

private Integer idInstructionImageResId

Option to set image in Instruction screen for ID.

private Integer previewScreenToolbarBackIcon

Option to set Preview screen toolbar back button image.

private String previewScreenToolbarBackIconTintColor

Option to set Preview screen toolbar back button tint color.

private Integer retryScreenImage

Option to set Retry screen image.

Functions

public final Integer getCaptureBottomBarImage()

Option to set bottom image in Capture screen.

public final Integer getCaptureScreenCancelBtnImage()

Option to set bottom image in Capture screen.

public final Integer getCaptureScreenIdBackOverlayImage()

Option to set image in Back Overlay for ID.

public final Integer getCaptureScreenIdFrontOverlayImage()

Option to set image in Front Overlay for ID.

public final Integer getDocumentInstructionImageResId()

Option to set image in Instruction screen for Document Capture.

public final <Error class: unknown class><Integer> getIdCaptureInstructionAnimationImages()

Option to set image list in Instruction screen for ID.

public final Integer getIdInstructionBackImageResId()

Option to set image in Instruction screen for back button.

public final Integer getIdInstructionImageResId()

Option to set image in Instruction screen for ID.

public final Integer getPreviewScreenToolbarBackIcon()

Option to set Preview screen toolbar back button image.

public final String getPreviewScreenToolbarBackIconTintColor()

Option to set Preview screen toolbar back button tint color.

public final Integer getRetryScreenImage()

Option to set Retry screen image.

public final Unit setCaptureBottomBarImage(Integer captureBottomBarImage)

Option to set bottom image in Capture screen.

public final Unit setCaptureScreenCancelBtnImage(Integer captureScreenCancelBtnImage)

Option to set bottom image in Capture screen.

public final Unit setCaptureScreenIdBackOverlayImage(Integer captureScreenIdBackOverlayImage)

Option to set image in Back Overlay for ID.

public final Unit setCaptureScreenIdFrontOverlayImage(Integer captureScreenIdFrontOverlayImage)

Option to set image in Front Overlay for ID.

public final Unit setDocumentInstructionImageResId(Integer documentInstructionImageResId)

Option to set image in Instruction screen for Document Capture.

public final Unit setIdCaptureInstructionAnimationImages(<Error class: unknown class><Integer> idCaptureInstructionAnimationImages)

Option to set image list in Instruction screen for ID.

public final Unit setIdInstructionBackImageResId(Integer idInstructionBackImageResId)

Option to set image in Instruction screen for back button.

public final Unit setIdInstructionImageResId(Integer idInstructionImageResId)

Option to set image in Instruction screen for ID.

public final Unit setPreviewScreenToolbarBackIcon(Integer previewScreenToolbarBackIcon)

Option to set Preview screen toolbar back button image.

public final Unit setPreviewScreenToolbarBackIconTintColor(String previewScreenToolbarBackIconTintColor)

Option to set Preview screen toolbar back button tint color.

public final Unit setRetryScreenImage(Integer retryScreenImage)

Option to set Retry screen image.

public abstract Unit writeToParcel(Parcel p0, Integer p1)
Report a docs issue

Copy this context into your team’s issue tracker or an email to support@idmission.com.