Package apple.corenfc.protocol

Interface NFCReaderSession

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String alertMessage()
      [@property] alertMessage Descriptive text message that is displayed on the alert action sheet once tag scanning has started.
      void beginSession()
      beginSession: Starts the session.
      void invalidateSession()
      invalidateSession Closes the reader session.
      void invalidateSessionWithErrorMessage​(java.lang.String errorMessage)
      invalidateSessionWithErrorMessage: Closes the reader session.
      boolean isReady()
      [@property] ready The RF discovery polling begins immediately when a reader session is activated successfully.
      void setAlertMessage​(java.lang.String value)
      [@property] alertMessage Descriptive text message that is displayed on the alert action sheet once tag scanning has started.

    • Method Detail

      • alertMessage

        java.lang.String alertMessage()
        [@property] alertMessage Descriptive text message that is displayed on the alert action sheet once tag scanning has started. The string can be update dynamically in any thread context as long as the session is valid. This should be set prior to calling @link beginSession @link/ to display the correct message. Use this string to provide additional context about the NFC reader mode operation.

      • beginSession

        void beginSession()
        beginSession: Starts the session. The @link [NFCReaderSessionDelegate readerSessionDidBecomeActive:] @link/ will be called when the reader session is activated successfully. @link [NFCReaderSessionDelegate readerSession:didDetectTags:] @link/ will return tag objects that are conformed to the @link NFCTag @link/ protocol. @link [NFCReaderSessionDelegate readerSession:didInvalidateWithError:] will return errors related to the session start.

      • invalidateSession

        void invalidateSession()
        invalidateSession Closes the reader session. The session cannot be re-used.

      • invalidateSessionWithErrorMessage

        void invalidateSessionWithErrorMessage​(java.lang.String errorMessage)
        invalidateSessionWithErrorMessage: Closes the reader session. The session cannot be re-used. The specified error message and an error symbol will be displayed momentarily on the action sheet before it is automatically dismissed.

      • isReady

        boolean isReady()
        [@property] ready The RF discovery polling begins immediately when a reader session is activated successfully. The @link readerSession:didDetectTags: @link/ will be called when a tag is detected.
        Returns:
        YES if the reader session is started and ready to use.

      • setAlertMessage

        void setAlertMessage​(java.lang.String value)
        [@property] alertMessage Descriptive text message that is displayed on the alert action sheet once tag scanning has started. The string can be update dynamically in any thread context as long as the session is valid. This should be set prior to calling @link beginSession @link/ to display the correct message. Use this string to provide additional context about the NFC reader mode operation.