@stripe/stripe-terminal-react-native
    Preparing search index...

    Type Alias UserCallbacks

    type UserCallbacks = {
        onDidAcceptTermsOfService?(): void;
        onDidChangeConnectionStatus?(status: Reader.ConnectionStatus): void;
        onDidChangeOfflineStatus?(status: OfflineStatus): void;
        onDidChangePaymentStatus?(status: PaymentStatus): void;
        onDidDisconnect?(reason: DisconnectReason): void;
        onDidFailReaderReconnect?(reader: Reader.Type): void;
        onDidFinishInstallingUpdate?(
            update?: SoftwareUpdate,
            error?: StripeError,
        ): void;
        onDidForwardingFailure?(error: StripeError): void;
        onDidForwardPaymentIntent?(
            paymentIntent: PaymentIntent.Type,
            error?: StripeError,
        ): void;
        onDidReportAvailableUpdate?(update: SoftwareUpdate): void;
        onDidReportLowBatteryWarning?(): void;
        onDidReportReaderEvent?(event: ReaderEvent): void;
        onDidReportReaderSoftwareUpdateProgress?(progress: number): void;
        onDidRequestReaderDisplayMessage?(message: DisplayMessage): void;
        onDidRequestReaderInput?(input: InputOptions[]): void;
        onDidStartInstallingUpdate?(
            update: SoftwareUpdate,
            reader?: Reader.Type,
        ): void;
        onDidStartReaderReconnect?(
            reader: Reader.Type,
            reason: DisconnectReason,
        ): void;
        onDidSucceedReaderReconnect?(reader: Reader.Type): void;
        onDidUpdateBatteryLevel?(result: BatteryLevel): void;
        onDidUpdateRequirementsAvailable?(
            requirements: TapToPayUpdateRequirement[],
        ): void;
        onFinishDiscoveringReaders?(error?: StripeError): void;
        onUpdateDiscoveredReaders?(readers: Reader.Type[]): void;
    }
    Index

    Methods

    onDidAcceptTermsOfService? onDidChangeConnectionStatus? onDidChangeOfflineStatus? onDidChangePaymentStatus? onDidDisconnect? onDidFailReaderReconnect? onDidFinishInstallingUpdate? onDidForwardingFailure? onDidForwardPaymentIntent? onDidReportAvailableUpdate? onDidReportLowBatteryWarning? onDidReportReaderEvent? onDidReportReaderSoftwareUpdateProgress? onDidRequestReaderDisplayMessage? onDidRequestReaderInput? onDidStartInstallingUpdate? onDidStartReaderReconnect? onDidSucceedReaderReconnect? onDidUpdateBatteryLevel? onDidUpdateRequirementsAvailable? onFinishDiscoveringReaders? onUpdateDiscoveredReaders?

    Methods

    • Parameters

      • progress: number

      Returns void

    • Called when a reader software update starts.

      On iOS, reader is the snapshot supplied by the native update callback. It can include the current software version before connectReader completes. Receiving it does not mean the reader is connected. Android currently does not supply this argument.

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods