Enumerations

Result for menuHandler in writing assistant.

See more

public enum WAResult

Result for feedbackHandler in writing assistant.

See more

public enum WAFeedbackResult

Helper action for writing assistant. This is used to trigger extra actions in the writing assistant, such as retrying an operation, updating the text directly, or navigating to a different view.

See more

public enum WAHelperAction : Equatable

Constants for AttachmentGroup and Attachment component implementations. Also available to App so that App specific customization fits into SAP design and implementation.

See more

public enum AttachmentConstants

Errors occurs during attachment upload or deletion

See more

public enum AttachmentError : Error

Undocumented

See more

public enum AccessoryType : Int, CaseIterable

It is either a String or Image

See more

public enum TextOrIcon

An enum representing the different item styles that a DataTable can have.

See more

public enum DataItemType : Int, CaseIterable

Property for object view.

See more

public enum ObjectViewProperty

Undocumented

See more

public enum RowAlignment

Accessory item type.

See more

public enum AccessoryItem : Equatable

Activity item predefined types

See more

public enum ActivityItemType

Data types for KPIItemView.

See more

public enum KPIItemData

UI control types supporeted by Sort and Filter configuration

See more

public enum SortFilterItem : Identifiable, Hashable

UI control types supporeted by Sort and Filter configuration

See more

public enum _SortFilterItem : Identifiable, Hashable

An enum for setting the segment mode in DimensionSelector

See more

@frozen
public enum SegmentWidthMode : Equatable

Place the image along the top, leading, bottom, or trailing edge of the button.

See more

public enum FioriButtonImagePosition

The color style of a Fiori button.

See more

public enum FioriButtonColorStyle

loading state of FioriButton

See more

public enum FioriButtonLoadingState

Undocumented

See more

public enum LibraryPreviewData

Enum representing the type of currency formatter to use.

See more

public enum formatType

extension formatType: currencyFormatting

Size of FUIFilterFormView button

See more

public enum FilterButtonSize

Undocumented

public enum Fiori

A custom view builder that return instance of type IndexedViewContainer.

See more

@available(iOS 13.0, macOS 10.15, tvOS 13.0, watchOS 6.0, *)
@resultBuilder
public enum IndexedViewBuilder

Describes different presentation styles in SectionHeader and SectionFooter. Determines which views are visible; affects labels’ fonts, and vertical padding.

See more

public enum SectionHeaderFooterStyle

Fiori style shadow.

See more

public enum FioriShadowStyle : CaseIterable

A custom parameter attribute that constructs views from closures.

@available(iOS 13.0, macOS 10.15, tvOS 13.0, watchOS 6.0, *)
@resultBuilder
public enum ActivityItemsBuilder

Represents the various states a barcode scanner can be in.

See more

public enum ScannerStatus : Equatable

Enumerates the types of barcode scanners supported.

See more

public enum ScannerType : Equatable, CaseIterable

Represents data to be displayed on a scanner’s screen, if supported.

See more

public enum ScannerDisplayData

Manages various barcode scanner implementations, providing a unified interface for applications.

BarcodeScannerManager is an ObservableObject that allows SwiftUI views to react to changes in scanner status, received barcodes, and pairing QR codes. It acts as a facade, delegating operations to the currently active scanner instance (e.g., VisionKitScanner, ProGloveScanner).

Overview

The manager holds instances of all supported scanner types. An application can select an active scanner type using setActiveScanner(_:). Once a scanner is active, the manager proxies calls like startMonitoring(), triggerScan(), getPairingQRCode(), etc., to that instance.

It also acts as a delegate (BarcodeScannerDelegate) for the active scanner, receiving status updates and barcode data, which it then publishes for the application to consume via its @Published properties or callback closures (onStatusChanged, onBarcodeScanned).

Usage

Initialization

Typically, you would use the shared singleton instance:

@StateObject private var scannerManager = BarcodeScannerManager.shared

Or, if you need custom configurations (e.g., for VisionKit):

@StateObject private var scannerManager = BarcodeScannerManager(
    recognizedDataTypes: [.barcode(symbologies: [.qr, .ean13])], // Specify symbologies for VisionKit
    recognizesMultipleItems: false, // For VisionKit: stop after first scan
    serviceUUID: "YOUR_CUSTOM_IPC_SERVICE_UUID" // Optional: For IPCMobile custom service
)

Setting Callbacks

Assign closures to onStatusChanged and onBarcodeScanned to receive updates:

.onAppear {
    scannerManager.onStatusChanged = { status in
        // Handle status change (e.g., update UI, show errors)
        if case .error(let error) = status {
            self.errorMessage = error.localizedDescription
        }
    }
    scannerManager.onBarcodeScanned = { barcodeValue in
        // Handle received barcode
        self.scannedValue = barcodeValue
        // If using VisionKit and it's a single scan, you might want to dismiss its view.
    }
}

Selecting and Activating a Scanner

Before using a scanner, it must be activated:

func activateMyScanner(type: ScannerType) async {
    do {
        try await scannerManager.setActiveScanner(type)
        // Scanner is now active and its startMonitoring() has been called.
        // Status should update to .idle, .ready, or an error.
    } catch {
        // Handle activation error (e.g., scanner.startMonitoring() failed)
        self.errorMessage = (error as? ScannerError)?.message ?? error.localizedDescription
    }
}

A platform-agnostic enum to represent data types for scanners, replacing VisionKit’s RecognizedDataType.

See more

public enum BarcodeDataType : Hashable

extension BarcodeDataType: CustomStringConvertible

A custom parameter attribute that constructs views from closures.

@available(iOS 13.0, macOS 10.15, tvOS 13.0, watchOS 6.0, *)
@resultBuilder
public enum AvatarsBuilder

A enum describing the state of an filter form option

See more

public enum FilterFormOptionState

A custom parameter attribute that constructs views from closures.

See more

@available(iOS 13.0, macOS 10.15, tvOS 13.0, watchOS 6.0, *)
@resultBuilder
public enum FootnoteIconsBuilder

Undocumented

See more

public enum TextPosition

Define the possible output formats for the scanned document

See more

public enum ScanOutputFormat

Define the possible output types: either an array of images or a PDF document

See more

public enum ScanOutput

A custom parameter attribute that constructs views from closures.

See more

@available(iOS 13.0, macOS 10.15, tvOS 13.0, watchOS 6.0, *)
@resultBuilder
public enum IconBuilder

Undocumented

@resultBuilder
public enum KPIHeaderBuilder

Available OptionListPickerItem layout types. Use this enum to define item layout type to present.

See more

public enum OptionListPickerItemLayoutType

Enum for FilterFeedbackBar ResetButton Type.

See more

public enum FilterFeedbackBarResetButtonType

A custom parameter attribute that constructs views from closures.

See more

@available(iOS 13.0, macOS 10.15, tvOS 13.0, watchOS 6.0, *)
@resultBuilder
public enum TagBuilder

The status of a timeline node

See more

public enum TimelineNodeType

The action type of UserConsentForm that presents the alert.

See more

public enum UserConsentAlertType

AIUserFeedback display mode

See more

public enum AIUserFeedbackDisplayMode

AIUserFeedback submit button state

See more

public enum AIUserFeedbackSubmitButtonState

AIUserFeedback vote state

See more

public enum AIUserFeedbackVoteState

Activity item layout

See more

public enum ActivityItemLayout

Banner multi message type

See more

public enum BannerMultiMessageType : Int

CardFooter button width mode

See more

public enum CardFooterButtonWidthMode : Int

Card Tests

See more

public enum CardFooterTests

Card Tests

See more

public enum CardTests

Provides reusable skeleton loading patterns for Card components. These static properties offer placeholder card layouts to display while content is loading, ensuring a consistent and visually appealing loading state across the UI.

See more

public enum CardSkeletonLoadingPattern

This file provides default fiori style for the component.

1. Uncomment the following code.
2. Implement layout and style in corresponding places.
3. Delete .generated from file name.
4. Move this file to _FioriStyles folder under FioriSwiftUICore.

See more

public enum DisplayState : Equatable

Provides skeleton loading patterns for KPIHeader component. The static properties offer placeholder KPIHeader to display while content is loading, ensuring a consistent and visually appealing loading state across the UI.

See more

public enum KPIHeaderSkeletonLoading

Different sizes of KPIItem. The default is .small

See more

public enum KPIItemSize

KPIItem takes 3 types of subitem

See more

public enum KPISubitemType

Enum to determine whether to display the large or small progress circle around the KPIContent. Default: KPIProgressItemSize.large

See more

public enum KPIProgressItemSize

ObjectHeaderSkeletonLoadingPattern provides predefined patterns for ObjectHeader skeleton loading.

See more

public enum ObjectHeaderSkeletonLoadingPattern

ObjectItemSkeletonLoadingPattern provides a set of predefined skeleton loading patterns for ObjectItem.

See more

public enum ObjectItemSkeletonLoadingPattern

This file provides default fiori style for the component.

1. Uncomment fhe following code.
2. Implement layout and style in corresponding places.
3. Delete .generated from file name.
4. Move this file to _FioriStyles folder under FioriSwiftUICore.

See more

public enum ToastMessagePosition : String, CaseIterable, Identifiable

Describes different onboarding states in onboarding process flow.

See more

public enum WelcomeScreenState

Describes different onboarding configuration options in onboarding process flow.

See more

public enum WelcomeScreenOption