apple.corenfc.protocol

Interface NFCReaderSession

All Known Implementing Classes:

NFCISO15693ReaderSession, NFCNDEFReaderSession, NFCReaderSession, NFCTagReaderSession, NFCVASReaderSession

public interface NFCReaderSession

[@protocol] NFCReaderSession

General reader session functions

Method Summary

Modifier and Type	Method and Description
java.lang.String	alertMessage() [@property] alertMessage
void	beginSession() beginSession:
void	invalidateSession() invalidateSession
void	invalidateSessionWithErrorMessage(java.lang.String errorMessage) invalidateSessionWithErrorMessage:
boolean	isReady() [@property] ready
void	setAlertMessage(java.lang.String value) [@property] alertMessage

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.