Nfc Config
data class NfcConfig(val titleMessage: String, val subtitleMessage: String, val buttonText: String, val sheetGesturesEnabled: Boolean = true, val shouldDismissBottomSheetOnBackPress: Boolean = false, val shouldDismissBottomSheetOnClickOutside: Boolean = false, val nfcReadTimeout: Duration = 60.seconds, val nfcUnsupportedMessage: String = "NFC is not supported on this device", val nfcDisabledMessage: String = "NFC is disabled on this device", val nfcScanTimeoutMessage: String = "NFC scan timed out", val nfcSuccessMessage: String = "Tag scanned successfully", val nfcScanningAnimationSlot: @Composable ColumnScope.() -> Unit = {
ScanningAnimationDefault.NfcScanningAnimation()
})(source)
Configuration for NFC scanning.
Note: On iOS, only subtitleMessage is used in the native NFC scanning UI.
Constructors
Link copied to clipboard
constructor(titleMessage: String, subtitleMessage: String, buttonText: String, sheetGesturesEnabled: Boolean = true, shouldDismissBottomSheetOnBackPress: Boolean = false, shouldDismissBottomSheetOnClickOutside: Boolean = false, nfcReadTimeout: Duration = 60.seconds, nfcUnsupportedMessage: String = "NFC is not supported on this device", nfcDisabledMessage: String = "NFC is disabled on this device", nfcScanTimeoutMessage: String = "NFC scan timed out", nfcSuccessMessage: String = "Tag scanned successfully", nfcScanningAnimationSlot: @Composable ColumnScope.() -> Unit = {
ScanningAnimationDefault.NfcScanningAnimation()
})
Properties
Link copied to clipboard
The text for the button in the scanning UI.
Link copied to clipboard
Error message emitted when NFC is turned off on the device.
Link copied to clipboard
The timeout for NFC reading.
Link copied to clipboard
The composable component for NFC scanning animation.
Link copied to clipboard
Error message emitted when scanning exceeds nfcReadTimeout.
Link copied to clipboard
Message shown in the native iOS scanning dialog after a successful read. Has no effect on Android.
Link copied to clipboard
Error message emitted when NFC hardware is unavailable.
Link copied to clipboard
Whether sheet gestures are enabled.
Link copied to clipboard
Whether to dismiss the bottom sheet on back press.
Link copied to clipboard
Whether to dismiss the bottom sheet on click outside.
Link copied to clipboard
The subtitle message to be displayed during NFC scanning.
Link copied to clipboard
The title message to be displayed during NFC scanning.