### OnboardingDialog

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.components/index.html

A composable function that displays an onboarding dialog. It guides users through a series of screens for initial setup or feature introduction.

```APIDOC
## OnboardingDialog

### Description
A composable function that displays an onboarding dialog. It guides users through a series of screens for initial setup or feature introduction.

### Parameters
* `onboardingDialogPage` (HelpScreenPage) - Required - The current page of the onboarding dialog.
* `onDismissOnboardingDialog` - Required - Callback to be invoked when the onboarding dialog is dismissed.
```

--------------------------------

### startForegroundService

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Starts a foreground service. This is a convenience method for starting a service that should be run in the foreground.

```APIDOC
## startForegroundService

### Description
Starts a foreground service. This method is used to start a service that should be run in the foreground.

### Method
`startForegroundService`

### Parameters
#### Path Parameters
- **p0** (Intent) - Required - The intent describing the service to start.

### Returns
- **ComponentName?** - The ComponentName of the service that was started, or null if the service could not be started.
```

--------------------------------

### startActivities

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Starts a new activity or activities. This method has overloads to start activities with or without additional options.

```APIDOC
## startActivities

### Description
Starts a sequence of activities. This method can be invoked with an array of Intents, optionally accompanied by a Bundle of options.

### Method
Overloaded methods exist for different parameter combinations.

### Parameters
#### startActivities(p0: Array<Intent>)
- **p0** (Array<Intent>) - An array of Intents to start.

#### startActivities(p0: Array<Intent>, p1: Bundle?)
- **p0** (Array<Intent>) - An array of Intents to start.
- **p1** (Bundle?) - Optional Bundle of options.
```

--------------------------------

### startInstrumentation

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Starts instrumentation. This method is used to start an instrumentation test.

```APIDOC
## startInstrumentation

### Description
Starts instrumentation. This method is used to start an instrumentation test.

### Method
`startInstrumentation`

### Parameters
#### Path Parameters
- **p0** (ComponentName) - Required - The component name of the instrumentation.
- **p1** (String?) - Optional - The argument string to pass to the instrumentation.
- **p2** (Bundle?) - Optional - A Bundle of options to pass to the instrumentation.

### Returns
- **Boolean** - True if the instrumentation was started, false otherwise.
```

--------------------------------

### SdkInitStart

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-core/com.microblink.blinkcard.core.ping.pinglets/index.html

Records the start of the SDK initialization process, including product, platform, and package details.

```APIDOC
## SdkInitStart

### Description
Records the start of the SDK initialization process, including product, platform, and package details.

### Class
`SdkInitStart`

### Properties
- **product** (`SdkInitStart.Product`) - The product being initialized.
- **platform** (`SdkInitStart.Platform`) - The platform on which the SDK is running.
- **platformDetails** (`SdkInitStart.PlatformDetails?`) - Additional details about the platform, if available.
- **packageName** (`String`) - The name of the package.
- **userId** (`String`) - The identifier for the user.
```

--------------------------------

### startService

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Starts a service. This method is an override and returns a ComponentName or null.

```APIDOC
## startService

### Description
Starts a service.

### Method
`startService(p0: Intent): ComponentName?`

### Parameters
* **p0** (Intent) - The Intent describing the service to be started.
```

--------------------------------

### startActivity

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Starts an activity. This method can be called with an Intent, and optionally with a Bundle for options.

```APIDOC
## startActivity

### Description
Starts a new activity. This method can be invoked with an Intent, optionally accompanied by a Bundle of options.

### Method
Overloaded methods exist for different parameter combinations.

### Parameters
#### startActivity(p0: Intent)
- **p0** (Intent) - The Intent to start.

#### startActivity(p0: Intent, p1: Bundle?)
- **p0** (Intent) - The Intent to start.
- **p1** (Bundle?) - Optional Bundle of options.
```

--------------------------------

### Configuring BlinkCard UI and UX Settings

Source: https://github.com/blinkcard/blinkcard-android/blob/master/Transition_guide.md

Example of how to instantiate and configure UiSettings, BlinkCardUxSettings, and CameraSettings for the BlinkCard SDK.

```kotlin
val blinkCardUiSettings = UiSettings(
    typography = ..., // override if necessary
    colorScheme = ...,  // override if necessary
    uiColors = ...,  // override if necessary
    sdkStrings = ...,  // override if necessary
    showOnboardingDialog = ...,  // default: true; override if necessary
    showHelpButton = ...,  // default: true; override if necessary
)

val blinkCardUxSettings = BlinkCardUxSettings(
   stepTimeoutDurationMs = ... // default: [Duration] 15000.milliseconds,
   allowHapticFeedback = ... // default: [Boolean] true
)

val blinkCardCameraSettings = data class CameraSettings(
    lensFacing = ... // default: [CameraLensFacing] CameraLensFacing.LensFacingBack,
    desiredResolution = ... // default: [Resolution] Resolution.Resolution2160p
)

fun BlinkCardCameraScanningScreen(
    sdkInstance,
    blinkCardUxSettings,
    blinkCardUiSettings,
    blinkCardCameraSettings
)
```

--------------------------------

### startLocalVoiceInteraction

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Starts a local voice interaction.

```APIDOC
## startLocalVoiceInteraction

### Description
Starts a local voice interaction.

### Method
open fun

### Parameters
#### Path Parameters
- **p0** (Bundle) - A Bundle of options for the interaction.

### Response
This method does not return a value directly.
```

--------------------------------

### getLaunchedFromPackage

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Returns the package name of the application that started this activity.

```APIDOC
## getLaunchedFromPackage

### Description
Returns the package name of the application that started this activity.

### Method
open fun

### Endpoint
getLaunchedFromPackage()

### Returns
[String]?
```

--------------------------------

### onCreatePanelMenu

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Called by the framework to install the menu items for a specific panel.

```APIDOC
## onCreatePanelMenu

### Description
Called by the framework to install the menu items for a specific panel.

### Method
`open override fun`

### Parameters
#### Path Parameters
- **featureId** (`Int`) - Description not available
- **menu** (`Menu`) - Description not available

### Returns
- `Boolean` - Description not available
```

--------------------------------

### Old BlinkCard v2 Initialization

Source: https://github.com/blinkcard/blinkcard-android/blob/master/Transition_guide.md

Example of the old initialization process for BlinkCard v2, including setting the license file and creating a RecognizerBundle.

```java
// old initialization
MicroblinkSDK.setLicenseFile("license-key", context);

// creating recognizer
mRecognizer = new BlinkCardRecognizer();
// bundle recognizers into RecognizerBundle
mRecognizerBundle = new RecognizerBundle(mRecognizer);
```

--------------------------------

### Initialize Color Scheme

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux/-ui-settings/color-scheme.html

Example of how to initialize and apply a custom ColorScheme to UiSettings. This allows for theming the BlinkCard UI.

```kotlin
val uiSettings = UiSettings()
uiSettings.colorScheme = myCustomColorScheme
```

--------------------------------

### trackSdkInitStart

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-core/com.microblink.blinkcard.core.ping.util/-pinglet-tracker/-sdk-init/track-sdk-init-start.html

Tracks the start of SDK initialization process. This method creates and queues a Pinglet to record when SDK initialization begins.

```APIDOC
## trackSdkInitStart

### Description
Tracks the start of SDK initialization process. This method creates and queues a Pinglet to record when SDK initialization begins.

### Method
fun

### Parameters
#### Path Parameters
- **context** (Context) - Required - Application context for PingManager initialization and package info
- **product** (SdkInitStart.Product) - Required - The specific SDK product being initialized
- **userId** (String) - Required - Unique identifier for the user/installation
```

--------------------------------

### startNextMatchingActivity

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Starts the next activity that matches the given intent.

```APIDOC
## startNextMatchingActivity

### Description
Starts the next activity that matches the given intent.

### Method
open fun

### Parameters
#### Path Parameters
- **intent** (Intent) - The Intent to match.

### Response
This method returns a boolean indicating whether an activity was started.
```

--------------------------------

### onPostCreate

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Called after [onStart] has been called. This method is intended for initialization that must occur after the activity has been started.

```APIDOC
## onPostCreate

### Description
Called after [onStart] has been called. This method is intended for initialization that must occur after the activity has been started.

### Method
`open fun onPostCreate(p0: Bundle?)`

### Parameters
#### Path Parameters
- **p0** (Bundle?) - Saved state information.
```

--------------------------------

### startSupportActionMode

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Starts support action mode. This method is annotated with @Nullable and returns an ActionMode or null.

```APIDOC
## startSupportActionMode

### Description
Starts support action mode.

### Method
`startSupportActionMode(p0: ActionMode.Callback): ActionMode?`

### Parameters
* **p0** (ActionMode.Callback) - The callback that will
  handle the user interface events for the action mode.
```

--------------------------------

### onCameraPreviewStarted

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.utils/on-camera-preview-started.html

This function is called when the camera preview has started. It takes a session number as an integer argument.

```APIDOC
## onCameraPreviewStarted

### Description
This function is called when the camera preview has started. It takes a session number as an integer argument.

### Signature
`fun onCameraPreviewStarted(sessionNumber: Int)`

### Parameters
#### Path Parameters
- **sessionNumber** (Int) - Description not available in source.
```

--------------------------------

### startActivityForResult

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Starts an activity and expects a result back. This method can be called with an Intent, a request code, and optionally a Bundle for options.

```APIDOC
## startActivityForResult

### Description
Starts an activity and expects a result back. This method can be invoked with an Intent, a request code, and optionally a Bundle of options.

### Method
Overloaded methods exist for different parameter combinations.

### Parameters
#### startActivityForResult(intent: Intent, requestCode: Int)
- **intent** (Intent) - The Intent to start.
- **requestCode** (Int) - The integer request code originally supplied to startActivity.

#### startActivityForResult(intent: Intent, requestCode: Int, options: Bundle?)
- **intent** (Intent) - The Intent to start.
- **requestCode** (Int) - The integer request code originally supplied to startActivity.
- **options** (Bundle?) - Optional Bundle of options.
```

--------------------------------

### onWindowStartingSupportActionMode

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Called when the activity is about to start a support action mode. This method is part of the Android Activity lifecycle.

```APIDOC
## onWindowStartingSupportActionMode

### Description
Called when the activity is about to start a support action mode.

### Method
`@Nullable open override fun onWindowStartingSupportActionMode`

### Parameters
* `p0` (ActionMode.Callback) - The callback to be used for the action mode.
```

--------------------------------

### SdkInitStart Constructor

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-core/com.microblink.blinkcard.core.ping.pinglets/-sdk-init-start/-sdk-init-start.html

Initializes the SdkInitStart with product, platform, optional platform details, package name, and user ID.

```APIDOC
## SdkInitStart constructor

### Description
Initializes the SdkInitStart with product, platform, optional platform details, package name, and user ID.

### Parameters
#### Path Parameters
- **product** ([SdkInitStart.Product](../-product/index.html)) - Description not available
- **platform** ([SdkInitStart.Platform](../-platform/index.html)) - Description not available
- **platformDetails** ([SdkInitStart.PlatformDetails](../-platform-details/index.html)?) - Optional - Description not available
- **packageName** (String) - Description not available
- **userId** (String) - Description not available
```

--------------------------------

### startNextMatchingActivity

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Starts the next activity that matches the given Intent. This is an overloaded method that can be called with or without a Bundle.

```APIDOC
## startNextMatchingActivity

### Description
Starts the next activity that matches the given Intent.

### Method
`startNextMatchingActivity(p0: Intent): Boolean`

### Parameters
* **p0** (Intent) - The Intent to match against.

### Method
`startNextMatchingActivity(p0: Intent, p1: Bundle?): Boolean`

### Parameters
* **p0** (Intent) - The Intent to match against.
* **p1** (Bundle?) - Optional Bundle of options for the activity.
```

--------------------------------

### startIntentSender

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Starts an IntentSender. This method is used to start an activity or service that is specified by an IntentSender.

```APIDOC
## startIntentSender

### Description
Starts an IntentSender. This method is used to start an activity or service that is specified by an IntentSender.

### Method
`startIntentSender`

### Parameters
#### Path Parameters
- **p0** (IntentSender) - Required - The IntentSender to start.
- **p1** (Intent?) - Optional - An Intent that will be sent with the IntentSender.
- **p2** (Int) - Required - The fillInIntent to be used when sending the IntentSender.
- **p3** (Int) - Required - The flags to be used when sending the IntentSender.
- **p4** (Int) - Required - The extra flags to be used when sending the IntentSender.
- **p5** (Bundle?) - Optional - A Bundle of options to pass to the IntentSender.

### Method Overloads
This method has overloads that accept an optional Bundle parameter.
```

--------------------------------

### Configure and Launch BlinkCardScanActivity

Source: https://github.com/blinkcard/blinkcard-android/blob/master/README.md

Define BlinkCardSdkSettings and BlinkCardScanActivitySettings, including the license key, to launch the scanning activity. This is part of the Java integration setup.

```java
String licenseKey = "your_license_key";
BlinkCardSdkSettings sdkSettings = new BlinkCardSdkSettings(licenseKey);
BlinkCardScanActivitySettings activitySettings = new BlinkCardScanActivitySettings(sdkSettings);

resultLauncher.launch(activitySettings);
```

--------------------------------

### CameraHardwareInfo Constructor

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-core/com.microblink.blinkcard.core.ping.pinglets/-camera-hardware-info/-camera-hardware-info.html

Initializes a new instance of the CameraHardwareInfo class with a list of available cameras.

```APIDOC
## CameraHardwareInfo

### Description
Initializes a new instance of the CameraHardwareInfo class.

### Constructor
`constructor(availableCameras: List<CameraHardwareInfo.AvailableCamerasItem>)`

### Parameters
#### Path Parameters
- **availableCameras** (List<CameraHardwareInfo.AvailableCamerasItem>) - Required - A list of available cameras, each represented by `CameraHardwareInfo.AvailableCamerasItem`.
```

--------------------------------

### Old BlinkCard Implementation Steps

Source: https://github.com/blinkcard/blinkcard-android/blob/master/Transition_guide.md

Demonstrates the traditional multi-step implementation of BlinkCard using Activities and Recognizers.

```kotlin
// STEP #1
class MyApplication : Application() {
    @Override
    fun onCreate() {
        MicroblinkSDK.setLicenseFile("path/to/license/file/within/assets/dir", this)
    }
}
```

```kotlin
// STEP #2
class MyActivity : Activity() {
    private var mRecognizer: BlinkCardRecognizer? = null
    private var mRecognizerBundle: RecognizerBundle? = null

    @Override
    protected fun onCreate(bundle: Bundle?) {
        super.onCreate(bundle)
        // create BlinkCardRecognizer
        mRecognizer = BlinkCardRecognizer()
        // bundle recognizers into RecognizerBundle
        mRecognizerBundle = RecognizerBundle(mRecognizer)
    }
}
```

```kotlin
// STEP #3
// method within MyActivity from previous step
fun startScanning() {
    // Settings for BlinkCardActivity
    val settings: UISettings = BlinkCardUISettings(mRecognizerBundle)
    ActivityRunner.startActivityForResult(this, MY_REQUEST_CODE, settings)
}
```

```kotlin
// STEP #4
@Override
protected fun onActivityResult(requestCode: kotlin.Int, resultCode: kotlin.Int, data: Intent?) {
    super.onActivityResult(requestCode, resultCode, data)
    if (requestCode == MY_REQUEST_CODE) {
        if (resultCode == Activity.RESULT_OK && data != null) {
            // load the data into all recognizers bundled within your RecognizerBundle
            mRecognizerBundle.loadFromIntent(data)
            // you can get the result by invoking getResult on recognizer
            val result: BlinkCardRecognizer.Result = mRecognizer.getResult()
            if (result.getResultState() === Recognizer.Result.State.Valid) {
                // result is valid, you can use it however you wish
            }
        }
    }
}
```

--------------------------------

### startIntentSenderForResult

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Starts an IntentSender and returns the result to the caller. This method is used to start an activity that is specified by an IntentSender and to receive the result of that activity.

```APIDOC
## startIntentSenderForResult

### Description
Starts an IntentSender and returns the result to the caller. This method is used to start an activity that is specified by an IntentSender and to receive the result of that activity.

### Method
`startIntentSenderForResult`

### Parameters
#### Path Parameters
- **p0** (IntentSender) - Required - The IntentSender to start.
- **p1** (Intent?) - Optional - An Intent that will be sent with the IntentSender.
- **p2** (Int) - Required - The request code for the activity.
- **p3** (Int) - Required - The fillInIntent to be used when sending the IntentSender.
- **p4** (Int) - Required - The flags to be used when sending the IntentSender.
- **p5** (Int) - Required - The extra flags to be used when sending the IntentSender.
- **p6** (Bundle?) - Optional - A Bundle of options to pass to the IntentSender.
```

--------------------------------

### Initialize Local SDK

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity-view-model/initialize-local-sdk.html

Initializes the BlinkCard SDK locally with provided settings and a callback for initialization failures. This function is essential for setting up the SDK before starting any scanning operations.

```kotlin
suspend fun initializeLocalSdk(context: Context, blinkCardSdkSettings: BlinkCardSdkSettings, onInitFailed: (exception: Throwable?) -> Unit)
```

--------------------------------

### onCreate

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Initialize the activity.

```APIDOC
## onCreate

### Description
Called when the activity is first created. This is where you can perform all of your normal static initialization.

### Method
`onCreate`

### Parameters
* `p0` (Bundle?) - Optional - If the activity is being re-initialized after previously being shut down then this Bundle contains the data it most recently supplied in onSaveInstanceState(Bundle).
* `p1` (PersistableBundle?) - Optional - Additional data for the activity's creation.
```

--------------------------------

### onPreparePanel

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Called to prepare a panel that is being shown. This is called after the panel has been created and before it is shown.

```APIDOC
## onPreparePanel

### Description
Called to prepare a panel that is being shown. This is called after the panel has been created and before it is shown.

### Method
open override fun

### Parameters
* **featureId** (Int) - The panel feature ID.
* **view** (View?) - The view associated with the panel.
* **menu** (Menu) - The menu to prepare.
```

--------------------------------

### onSearchRequested

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Called when the user is about to start a search.

```APIDOC
## onSearchRequested

### Description
Called when the user is about to start a search.

### Method
open override fun

### Endpoint
onSearchRequested()

### Returns
Boolean - True if the search was handled, false otherwise.
```

```APIDOC
## onSearchRequested

### Description
Called when the user is about to start a search.

### Method
open override fun

### Endpoint
onSearchRequested(p0: SearchEvent?)

### Parameters
#### Path Parameters
- **p0** (SearchEvent?) - Optional - The search event that triggered the request.
```

--------------------------------

### onActionModeStarted

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Called when the action mode is started.

```APIDOC
## onActionModeStarted

### Description
Callback method that is invoked when an action mode is started. This is part of the Android Activity lifecycle.

### Method
`onActionModeStarted`

### Parameters
* `p0` (ActionMode) - Required - The ActionMode that has started.
```

--------------------------------

### getIntent

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Retrieves the intent that started this activity.

```APIDOC
## getIntent

### Description
Retrieves the intent that started this activity.

### Method
open fun

### Endpoint
getIntent()

### Returns
[Intent]
```

--------------------------------

### getFileStreamPath

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Gets the path to a file stream.

```APIDOC
## getFileStreamPath

### Description
Returns the absolute path to a file that has been opened with `openFileInput()` or created with `openFileOutput()`.

### Method
`getFileStreamPath(p0: String): File`

### Parameters
#### Path Parameters
- **p0** (String) - Required - The name of the file stream.

### Returns
- `File` - A `File` object representing the file stream path.
```

--------------------------------

### Initialize BlinkCard SDK

Source: https://github.com/blinkcard/blinkcard-android/blob/master/Release_notes.md

Use this method to initialize the SDK with your license key. Ensure this is done before any other SDK operations.

```kotlin
BlinkCardSdk.initializeSdk(BlinkCardSdkSettings(licenseKey))
```

--------------------------------

### startIntentSenderFromFragment

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Starts a sender for an activity result from a fragment.

```APIDOC
## startIntentSenderFromFragment

### Description
Starts a sender for an activity result from a fragment.

### Method
open fun

### Parameters
#### Path Parameters
- **p0** (Fragment) - The parent fragment.
- **p1** (IntentSender) - The IntentSender to start.
- **p2** (Int) - The request code for the activity.
- **p3** (Intent) - An optional Intent to fill in.
- **p4** (Int) - Mask for flags.
- **p5** (Int) - Values for flags.
- **p6** (Int) - Extra flags.
- **p7** (Bundle) - Optional Bundle for starting options.

### Response
This method does not return a value directly, but it starts an activity for a result.
```

--------------------------------

### onPrepareOptionsMenu

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Called to prepare the Screen's standard options menu to be displayed. The menu will be displayed in the far left of the action bar. This may be called every time a menu is shown.

```APIDOC
## onPrepareOptionsMenu

### Description
Called to prepare the Screen's standard options menu to be displayed. The menu will be displayed in the far left of the action bar. This may be called every time a menu is shown.

### Method
open fun

### Parameters
* **p0** (Menu) - The options menu to prepare.
```

--------------------------------

### supportStartPostponedEnterTransition

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Starts the postponed enter transition for the activity. This is used in shared element transitions to delay the transition until the shared elements are ready.

```APIDOC
## supportStartPostponedEnterTransition

### Description
Initiates the postponed enter transition for the activity. This method is typically called after shared elements have been laid out and are ready for the transition.

### Method
open fun

### Parameters
None

### Returns
None
```

--------------------------------

### onSupportActionModeStarted

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

This hook is called whenever an action mode is started.

```APIDOC
## onSupportActionModeStarted

### Description
This hook is called whenever an action mode is started.

### Method
open override fun

### Endpoint
onSupportActionModeStarted(p0: ActionMode)

### Parameters
#### Path Parameters
- **p0** (ActionMode) - Required - The ActionMode that was started.
```

--------------------------------

### startActivityFromFragment

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Starts an activity from a fragment. This method has multiple overloads to accommodate different parameter combinations, including optional Bundles for additional data.

```APIDOC
## startActivityFromFragment

### Description
Starts an activity from a fragment, with options for passing a request code and a Bundle.

### Method
`startActivityFromFragment`

### Parameters
#### Path Parameters
- **p0** (Fragment) - Required - The fragment from which to start the activity.
- **p1** (Intent) - Required - The intent describing the activity to start.
- **p2** (Int) - Required - The request code for the activity.
- **p3** (Bundle?) - Optional - A Bundle of options to pass to the activity, or null.

### Method Overloads
This method has multiple overloads to handle different parameter requirements, including the optional Bundle parameter.
```

--------------------------------

### getLaunchedFromUid

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Returns the unique identifier of the application that started this activity.

```APIDOC
## getLaunchedFromUid

### Description
Returns the unique identifier of the application that started this activity.

### Method
open fun

### Endpoint
getLaunchedFromUid()

### Returns
[Int]
```

--------------------------------

### HelpScreens Constructor

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.components/-help-screens/-help-screens.html

Initializes the HelpScreens component with an onboarding dialog page and a list of help dialog pages.

```APIDOC
## HelpScreens Constructor

### Description
Initializes the HelpScreens component with an onboarding dialog page and a list of help dialog pages.

### Parameters
#### Path Parameters
- **onboardingDialogPage** ([HelpScreenPage](../-help-screen-page/index.html)) - The first page to display in the help screen flow.
- **helpDialogPages** ([List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)<[HelpScreenPage](../-help-screen-page/index.html)">) - A list of subsequent help pages to display after the onboarding page.
```

--------------------------------

### New BlinkCard v3000 Initialization with Camera Scanning

Source: https://github.com/blinkcard/blinkcard-android/blob/master/Transition_guide.md

Demonstrates the new initialization process for BlinkCard v3000 SDK using BlinkCardSdk.initializeSdk and setting up the BlinkCardCameraScanningScreen.

```kotlin
// New initialization
val instance = BlinkCardSdk.initializeSdk(
    context = context,
    BlinkCardSdkSettings(
        licenseKey = "licenseKey",
        downloadResources = downloadResources, // true by default
        resourceLocalFolder = "microblink/blinkcard"
    )
)

when {
    instance.isSuccess -> {
        BlinkCardCameraScanningScreen(
            blinkCardSdk = instance,
            uxSettings = blinkCardUxSettings,
            uiSettings = uiSettings,
            cameraSettings = cameraSettings,
            sessionSettings = blinkCardSessionSettings,
            onScanningSuccess = { blinkCardScanningResult ->  },
            onScanningCanceled = { },
        )
    }

    instance.isFailure -> {
        val exception = instance.exceptionOrNull()
        Log.e(TAG, "Initialization failed", exception)
    }
}
```

--------------------------------

### getFilesDir

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Gets the directory for the application's internal files.

```APIDOC
## getFilesDir

### Description
Returns the absolute path to the directory on the filesystem where the application's private files are stored. These files are not accessible by other applications.

### Method
`getFilesDir(): File`

### Returns
- `File` - A `File` object representing the internal files directory.
```

--------------------------------

### PingletTracker.SdkInit

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-core/com.microblink.blinkcard.core.ping.util/-pinglet-tracker/index.html

Utilities for tracking SDK initialization events within the PingletTracker.

```APIDOC
## PingletTracker.SdkInit

### Description
Utilities for tracking SDK initialization events.

### Object
`PingletTracker.SdkInit`
```

--------------------------------

### getExternalFilesDirs

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Gets all directories for the application's external files.

```APIDOC
## getExternalFilesDirs

### Description
Returns an array of absolute paths to directories on the filesystem where files specific to this application can be placed. This can include multiple external storage locations.

### Method
`getExternalFilesDirs(p0: String): Array<File>`

### Parameters
#### Path Parameters
- **p0** (String) - Required - A type for the directory, e.g. "images" or "files".

### Returns
- `Array<File>` - An array of `File` objects representing the external files directories.
```

--------------------------------

### UiSettings Constructor

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux/-ui-settings/-ui-settings.html

Initializes UiSettings with optional parameters for typography, color scheme, UI colors, SDK strings, and onboarding/help button visibility.

```APIDOC
## UiSettings constructor

### Description
Initializes the UiSettings object with customizable UI elements and behaviors.

### Parameters
#### Constructor Parameters
- **typography** ([UiTypography](../../com.microblink.blinkcard.ux.theme/-ui-typography/index.html)) - Optional - Custom typography settings for the UI.
- **colorScheme** ([ColorScheme](https://developer.android.com/reference/kotlin/androidx/compose/material3/ColorScheme.html)) - Optional - Material Design 3 ColorScheme to use.
- **uiColors** ([UiColors](../../com.microblink.blinkcard.ux.theme/-ui-colors/index.html)) - Optional - Custom UI colors.
- **sdkStrings** ([SdkStrings](../../com.microblink.blinkcard.ux.theme/-sdk-strings/index.html)) - Optional - Custom strings for SDK elements.
- **showOnboardingDialog** ([Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)) - Optional - Defaults to `DefaultShowOnboardingDialog`. Determines if the onboarding dialog should be shown.
- **showHelpButton** ([Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)) - Optional - Defaults to `DefaultShowHelpButton`. Determines if the help button should be shown.
```

--------------------------------

### getExternalFilesDir

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Gets a directory for the application's external files.

```APIDOC
## getExternalFilesDir

### Description
Returns the absolute path to a directory on the filesystem where files specific to this application can be placed. This directory is unique to the application and is not automatically pruned by the system.

### Method
`getExternalFilesDir(p0: String?): File?`

### Parameters
#### Path Parameters
- **p0** (String?) - Optional - A type for the directory, e.g. "images" or "files". Can be null.

### Returns
- `File?` - A `File` object representing the external files directory, or null if it is not available.
```

--------------------------------

### lensFacing Property

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.camera/-camera-settings/index.html

Gets the preferred camera lens facing.

```APIDOC
## lensFacing Property

### Description
Represents the preferred camera lens facing (front or back). This property allows you to specify which camera should be used for scanning.

### Type
[CameraLensFacing](../-camera-lens-facing/index.html)

### Default Value
[CameraLensFacing.LensFacingBack](../-camera-lens-facing/-lens-facing-back/index.html)
```

--------------------------------

### HelpScreens Constructor

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.components/-help-screens/index.html

Constructs a new HelpScreens object with specified onboarding and help dialog pages.

```APIDOC
## HelpScreens Constructor

### Description
Initializes a new instance of the HelpScreens class.

### Parameters
* **onboardingDialogPage** ([HelpScreenPage]) - Required - The page configuration for the onboarding dialog.
* **helpDialogPages** ([List<HelpScreenPage>]) - Required - A list of page configurations for the help dialogs.
```

--------------------------------

### Initialize SdkTheme with Dark Mode Logic

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.theme/-sdk-theme/sdk-theme.html

This snippet demonstrates how to initialize the SdkTheme, which includes logic for applying dark mode based on operating system preferences or local storage settings. It's typically used at the root of your application's UI.

```javascript
var pathToRoot = "../../../"
document.documentElement.classList.replace("no-js","js")
const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
    const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
    if (osDarkSchemePreferred === true) {
        document.getElementsByTagName("html")[0].classList.add("theme-dark")
    }
} else {
    const savedDarkMode = JSON.parse(storage)
    if(savedDarkMode === true) {
        document.getElementsByTagName("html")[0].classList.add("theme-dark")
    }
}
```

--------------------------------

### schemaVersion Property

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-core/com.microblink.blinkcard.core.ping.pinglets/-camera-hardware-info/index.html

Gets the version identifier for the Pinglet schema.

```APIDOC
## schemaVersion Property

### Description
Returns the version identifier for this Pinglet's schema.

### Type
String
```

--------------------------------

### CameraDevicesDetails Constructor

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.camera/-camera-devices-details/-camera-devices-details.html

Initializes a new instance of the CameraDevicesDetails class with the specified number of devices and their details.

```APIDOC
## CameraDevicesDetails Constructor

### Description
Initializes a new instance of the CameraDevicesDetails class.

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Parameters
* **numberOfDevices** (Int) - The total number of camera devices available.
* **devicesDetails** (List<CameraDetails>) - A list containing details for each camera device.
```

--------------------------------

### BlinkCardSdkSettings Constructor

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-core/com.microblink.blinkcard.core/-blink-card-sdk-settings/-blink-card-sdk-settings.html

Initializes the BlinkCard SDK with provided settings. Allows configuration of license key, licensee, resource download behavior, custom URLs, proxy, and timeouts.

```APIDOC
## BlinkCardSdkSettings constructor

### Description
Initializes the BlinkCard SDK with provided settings. Allows configuration of license key, licensee, resource download behavior, custom URLs, proxy, and timeouts.

### Constructor Signature
`BlinkCardSdkSettings(@JvmOverloads constructor(licenseKey: String, licensee: String? = null, downloadResources: Boolean = true, resourceDownloadUrl: String = defaultResourceDownloadUrl, resourceLocalFolder: String = defaultResourcesLocalFolder, resourceRequestTimeout: RequestTimeout = RequestTimeout.DEFAULT, microblinkProxyUrl: String? = null))`

### Parameters
#### Constructor Parameters
- **licenseKey** (String) - Required - The license key for the BlinkCard SDK.
- **licensee** (String?) - Optional - The licensee name.
- **downloadResources** (Boolean) - Optional - Whether to download SDK resources. Defaults to true.
- **resourceDownloadUrl** (String) - Optional - The URL to download SDK resources from. Defaults to `defaultResourceDownloadUrl`.
- **resourceLocalFolder** (String) - Optional - The local folder to store SDK resources. Defaults to `defaultResourcesLocalFolder`.
- **resourceRequestTimeout** (RequestTimeout) - Optional - The timeout configuration for resource requests. Defaults to `RequestTimeout.DEFAULT`.
- **microblinkProxyUrl** (String?) - Optional - The URL for the Microblink proxy.
```

--------------------------------

### startManagingCursor

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Starts managing a cursor, which will be automatically closed when the activity is destroyed.

```APIDOC
## startManagingCursor

### Description
Starts managing a cursor, which will be automatically closed when the activity is destroyed.

### Method
open fun

### Parameters
#### Path Parameters
- **p0** (Cursor) - The Cursor to manage.

### Response
This method does not return a value directly.
```

--------------------------------

### getExternalMediaDirs

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Gets all directories for the application's external media files.

```APIDOC
## getExternalMediaDirs

### Description
Returns an array of absolute paths to directories on the filesystem where application-specific media files can be stored. These directories are typically associated with external storage volumes.

### Method
`getExternalMediaDirs(): Array<File>`

### Returns
- `Array<File>` - An array of `File` objects representing the external media directories.
```

--------------------------------

### getExternalCacheDirs

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Gets all directories for the application's external cache files.

```APIDOC
## getExternalCacheDirs

### Description
Returns an array of absolute paths to directories on the filesystem where the application's cache files can be stored. This can include multiple external storage locations.

### Method
`getExternalCacheDirs(): Array<File>`

### Returns
- `Array<File>` - An array of `File` objects representing the external cache directories.
```

--------------------------------

### SdkInitStart Constructor

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-core/com.microblink.blinkcard.core.ping.pinglets/-sdk-init-start/index.html

Constructs a new SdkInitStart object. This is the primary way to create an instance of the SDK initialization event.

```APIDOC
## SdkInitStart Constructor

### Description
Initializes a new SdkInitStart object with essential details about the SDK's startup.

### Parameters
* **product** (SdkInitStart.Product) - Required - The product for which the SDK is initializing.
* **platform** (SdkInitStart.Platform) - Required - The platform on which the SDK is running.
* **platformDetails** (SdkInitStart.PlatformDetails?) - Optional - Additional details about the platform.
* **packageName** (String) - Required - The package name of the application using the SDK.
* **userId** (String) - Required - The unique identifier for the user.
```

--------------------------------

### getExternalCacheDir

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Gets the directory for the application's external cache files.

```APIDOC
## getExternalCacheDir

### Description
Returns the absolute path to the directory on the filesystem where the application's cache files are stored. This directory may be automatically pruned by the system when storage is low.

### Method
`getExternalCacheDir(): File?`

### Returns
- `File?` - A `File` object representing the external cache directory, or null if it is not available.
```

--------------------------------

### schemaName Property

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-core/com.microblink.blinkcard.core.ping.pinglets/-camera-hardware-info/index.html

Gets the unique identifier for the Pinglet schema type.

```APIDOC
## schemaName Property

### Description
Returns a unique string identifier for this Pinglet's schema.

### Type
String
```

--------------------------------

### SdkInitStart.product

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-core/com.microblink.blinkcard.core.ping.pinglets/-sdk-init-start/product.html

The 'product' property of the SdkInitStart class. It is annotated with @SerialName("product") and returns an SdkInitStart.Product type.

```APIDOC
## SdkInitStart.product

### Description
Represents the product information associated with the SDK initialization start.

### Property
- **product** (SdkInitStart.Product) - The product details.
```

--------------------------------

### startLockTask

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Starts lock task mode, which locks the device to a single app.

```APIDOC
## startLockTask

### Description
Starts lock task mode, which locks the device to a single app.

### Method
open fun

### Parameters
This method takes no parameters.

### Response
This method does not return a value directly.
```

--------------------------------

### HelpDialogsStrings Constructor

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.theme/-help-dialogs-strings/-help-dialogs-strings.html

Constructs an instance of HelpDialogsStrings with specified string resource IDs for onboarding and help dialogs.

```APIDOC
## HelpDialogsStrings Constructor

### Description
Constructs an instance of HelpDialogsStrings with specified string resource IDs for onboarding and help dialogs.

### Parameters
#### Constructor Parameters
- **onboardingTitle** (Int) - @StringRes - The resource ID for the onboarding dialog title.
- **onboardingMessage** (Int) - @StringRes - The resource ID for the onboarding dialog message.
- **helpTitles** (List<Int>) - @StringRes - A list of resource IDs for the help dialog titles.
- **helpMessages** (List<Int>) - @StringRes - A list of resource IDs for the help dialog messages.
```

--------------------------------

### overridePendingTransition

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Controls the animations that are played when the activity is finishing or starting a new one.

```APIDOC
## overridePendingTransition

### Description
Controls the animations that are played when the activity is finishing or starting a new one.

### Method
open fun

### Parameters
* `p0` (Int) - Description not available.
* `p1` (Int) - Description not available.
```

```APIDOC
## overridePendingTransition

### Description
Controls the animations that are played when the activity is finishing or starting a new one.

### Method
open fun

### Parameters
* `p0` (Int) - Description not available.
* `p1` (Int) - Description not available.
* `p2` (Int) - Description not available.
```

--------------------------------

### CameraInputDetails Constructor

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.camera/-camera-input-details/-camera-input-details.html

Initializes a new instance of the CameraInputDetails class with specified camera and view parameters.

```APIDOC
## CameraInputDetails Constructor

### Description
Initializes a new instance of the CameraInputDetails class with specified camera and view parameters.

### Parameters
#### Constructor Parameters
- **cameraId** (String) - The unique identifier for the camera.
- **cameraFacing** (CameraLensFacing) - Specifies which lens of the camera to use (front or back).
- **cameraFrameWidth** (Int) - The width of the camera frame in pixels.
- **cameraFrameHeight** (Int) - The height of the camera frame in pixels.
- **viewPortAspectRatio** (Double) - The aspect ratio of the camera's viewport.
- **roiWidth** (Int) - The width of the Region of Interest (ROI) in pixels.
- **roiHeight** (Int) - The height of the Region of Interest (ROI) in pixels.
```

--------------------------------

### onLocalVoiceInteractionStarted

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Called when local voice interaction has started. This is an override of the superclass method.

```APIDOC
## onLocalVoiceInteractionStarted

### Description
Called when local voice interaction has started. This is an override of the superclass method.

### Method
open

### Endpoint
onLocalVoiceInteractionStarted()
```

--------------------------------

### createIntent

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.contract/-mb-blink-card-scan/index.html

Creates an Intent to start the BlinkCard scanning activity with the specified settings.

```APIDOC
## createIntent

### Description
Creates an Intent to start the BlinkCard scanning activity with the specified settings.

### Method
`open override fun createIntent(context: Context, input: BlinkCardScanActivitySettings): Intent`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None provided in source.

### Response
#### Success Response
Returns an `Intent` to launch the BlinkCard scan activity.

#### Response Example
None provided in source.
```

--------------------------------

### onCreateDescription

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Initialize the contents of the Activity's standard options menu.

```APIDOC
## onCreateDescription

### Description
Initialize the contents of the Activity's standard options menu.

### Method
`open fun`

### Returns
- `CharSequence?` - Description not available
```

--------------------------------

### getDir

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Gets a directory for the application's cache or files, with options for creation.

```APIDOC
## getDir

### Description
Retrieves a directory on the filesystem. This can be used for storing application-specific files or cache data.

### Method
`getDir(p0: String, p1: Int): File`

### Parameters
#### Path Parameters
- **p0** (String) - Required - The name of the directory to get.
- **p1** (Int) - Required - A mode indicating whether the directory should be created if it doesn't exist.

### Returns
- `File` - The File object representing the directory.
```

--------------------------------

### showOnboardingDialog

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.contract/-blink-card-scan-activity-settings/index.html

Determines whether an onboarding dialog should be displayed to the user when the activity is first launched. Defaults to DefaultShowOnboardingDialog.

```APIDOC
## showOnboardingDialog

### Description
Determines whether an onboarding dialog should be displayed to the user when the activity is first launched. Defaults to [DefaultShowOnboardingDialog](../../com.microblink.blinkcard.ux/-default-show-onboarding-dialog.html).

### Property
`showOnboardingDialog`: Boolean
```

--------------------------------

### startActivityFromFragment

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Starts an activity from a fragment. This method is called with a Fragment, an Intent, and a request code.

```APIDOC
## startActivityFromFragment

### Description
Starts an activity from a fragment. This method is invoked with a Fragment, an Intent, and a request code.

### Method

### Parameters
#### startActivityFromFragment(p0: Fragment, p1: Intent, p2: Int)
- **p0** (Fragment) - The Fragment from which to start the activity.
- **p1** (Intent) - The Intent to start.
- **p2** (Int) - The request code.
```

--------------------------------

### postponeEnterTransition

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Postpones the enter transition for the activity, allowing for asynchronous operations before starting the transition.

```APIDOC
## postponeEnterTransition

### Description
Postpones the enter transition for the activity, allowing for asynchronous operations before starting the transition.

### Method
open fun

### Parameters
None.
```

--------------------------------

### onCreateOptionsMenu

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Initialize the contents of the Activity's standard options menu.

```APIDOC
## onCreateOptionsMenu

### Description
Initialize the contents of the Activity's standard options menu.

### Method
`open fun`

### Parameters
#### Path Parameters
- **p0** (`Menu`) - Description not available

### Returns
- `Boolean` - Description not available
```

--------------------------------

### BlinkCardUxSettings Constructor

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.settings/-blink-card-ux-settings/index.html

Initializes BlinkCardUxSettings with customizable scanning session timeout and haptic feedback preferences.

```APIDOC
## BlinkCardUxSettings Constructor

### Description
Initializes BlinkCardUxSettings with customizable scanning session timeout and haptic feedback preferences.

### Parameters

- **stepTimeoutDuration** (Duration) - The duration of the scanning session before a timeout is triggered. Defaults to 15 seconds.
- **allowHapticFeedback** (Boolean) - Whether haptic feedback is allowed during the scanning process. Defaults to true.
```

--------------------------------

### finishActivity

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Finishes a particular activity in the current task that was started with startActivityForResult(Intent, int).

```APIDOC
## finishActivity

### Description
Finishes a particular activity in the current task that was started with startActivityForResult(Intent, int).

### Method
open fun

### Endpoint
finishActivity(p0: Int)
```

--------------------------------

### getSystemService (String)

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Returns the system service with the given name.

```APIDOC
## getSystemService (String)

### Description
Returns the system service with the given name.

### Method
`open override fun getSystemService(p0: String): Any`

### Parameters
* **p0** (`String`) - The name of the system service.

### Returns
- `Any`: The system service object.
```

--------------------------------

### supportPostponeEnterTransition

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Postpones the enter transition for the activity. This method is used to delay the start of an activity transition.

```APIDOC
## supportPostponeEnterTransition

### Description
Postpones the enter transition for the activity.

### Method
`supportPostponeEnterTransition(): Unit`
```

--------------------------------

### AvailableResolutionsItem Constructor

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-core/com.microblink.blinkcard.core.ping.pinglets/-camera-hardware-info/-available-resolutions-item/-available-resolutions-item.html

Constructs an AvailableResolutionsItem with the specified width and height.

```APIDOC
## AvailableResolutionsItem

### Description
Constructs an AvailableResolutionsItem with the specified width and height.

### Constructor
`AvailableResolutionsItem(width: Long, height: Long)`

### Parameters
#### Path Parameters
- **width** (Long) - The width of the resolution.
- **height** (Long) - The height of the resolution.
```

--------------------------------

### onCreateContextMenu

Source: https://github.com/blinkcard/blinkcard-android/blob/master/docs/blinkcard-ux/com.microblink.blinkcard.ux.activity/-blink-card-scan-activity/index.html

Called to create a context menu.

```APIDOC
## onCreateContextMenu

### Description
Called to create a context menu for the activity. This method is called when a view that has an item-based context menu is long-pressed.

### Method
`onCreateContextMenu`

### Parameters
* `p0` (Menu) - Required - The context menu to create.
* `p1` (View) - Required - The view for which the context menu is being created.
* `p2` (ContextMenuInfo?) - Optional - Extra information about the item that was long-pressed.
```