FuelingDocumentation/data/documentation/fueling/nfcreader.json

{"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"identifier":{"url":"doc:\/\/rpm.com.production.Scanner\/documentation\/Fueling\/NFCReader","interfaceLanguage":"swift"},"metadata":{"fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"NFCReader"}],"modules":[{"name":"Fueling"}],"title":"NFCReader","navigatorTitle":[{"text":"NFCReader","kind":"identifier"}],"symbolKind":"class","role":"symbol","roleHeading":"Class","externalID":"c:@M@Fueling@objc(cs)NFCReader"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/rpm.com.production.Scanner\/documentation\/Fueling"]]},"abstract":[{"text":"A class that handles NFC reading operations and notifies observers about the results.","type":"text"}],"topicSections":[{"anchor":"Instance-Properties","generated":true,"title":"Instance Properties","identifiers":["doc:\/\/rpm.com.production.Scanner\/documentation\/Fueling\/NFCReader\/onTagRead","doc:\/\/rpm.com.production.Scanner\/documentation\/Fueling\/NFCReader\/result"]},{"title":"Instance Methods","generated":true,"identifiers":["doc:\/\/rpm.com.production.Scanner\/documentation\/Fueling\/NFCReader\/readerSession(_:didDetectNDEFs:)","doc:\/\/rpm.com.production.Scanner\/documentation\/Fueling\/NFCReader\/readerSession(_:didInvalidateWithError:)","doc:\/\/rpm.com.production.Scanner\/documentation\/Fueling\/NFCReader\/startScanning(message:)"],"anchor":"Instance-Methods"},{"title":"Default Implementations","anchor":"Default-Implementations","identifiers":["doc:\/\/rpm.com.production.Scanner\/documentation\/Fueling\/NFCReader\/ObservableObject-Implementations"],"generated":true}],"relationshipsSections":[{"type":"inheritsFrom","kind":"relationships","identifiers":["doc:\/\/rpm.com.production.Scanner\/objc(cs)NSObject"],"title":"Inherits From"},{"identifiers":["doc:\/\/rpm.com.production.Scanner\/7Combine16ObservableObjectP","doc:\/\/rpm.com.production.Scanner\/objc(pl)NFCNDEFReaderSessionDelegate","doc:\/\/rpm.com.production.Scanner\/objc(pl)NSObject","doc:\/\/rpm.com.production.Scanner\/s7CVarArgP","doc:\/\/rpm.com.production.Scanner\/s28CustomDebugStringConvertibleP","doc:\/\/rpm.com.production.Scanner\/s23CustomStringConvertibleP","doc:\/\/rpm.com.production.Scanner\/SQ","doc:\/\/rpm.com.production.Scanner\/SH"],"kind":"relationships","type":"conformsTo","title":"Conforms To"}],"seeAlsoSections":[{"identifiers":["doc:\/\/rpm.com.production.Scanner\/documentation\/Fueling\/ConfigurationViewModel","doc:\/\/rpm.com.production.Scanner\/documentation\/Fueling\/WebSocketViewModel","doc:\/\/rpm.com.production.Scanner\/documentation\/Fueling\/NetworkMonitor","doc:\/\/rpm.com.production.Scanner\/documentation\/Fueling\/NotificationManager","doc:\/\/rpm.com.production.Scanner\/documentation\/Fueling\/CoreDataManager","doc:\/\/rpm.com.production.Scanner\/documentation\/Fueling\/LocationManager"],"anchor":"ViewModels","generated":true,"title":"ViewModels"}],"variants":[{"paths":["\/documentation\/fueling\/nfcreader"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"NFCReader"}]}],"kind":"declarations"}],"references":{"doc://rpm.com.production.Scanner/documentation/Fueling/NFCReader":{"navigatorTitle":[{"kind":"identifier","text":"NFCReader"}],"abstract":[{"text":"A class that handles NFC reading operations and notifies observers about the results.","type":"text"}],"kind":"symbol","title":"NFCReader","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"NFCReader","kind":"identifier"}],"identifier":"doc:\/\/rpm.com.production.Scanner\/documentation\/Fueling\/NFCReader","role":"symbol","type":"topic","url":"\/documentation\/fueling\/nfcreader"},"doc://rpm.com.production.Scanner/documentation/Fueling/NFCReader/ObservableObject-Implementations":{"identifier":"doc:\/\/rpm.com.production.Scanner\/documentation\/Fueling\/NFCReader\/ObservableObject-Implementations","abstract":[],"url":"\/documentation\/fueling\/nfcreader\/observableobject-implementations","title":"ObservableObject Implementations","type":"topic","kind":"article","role":"collectionGroup"},"doc://rpm.com.production.Scanner/documentation/Fueling/NFCReader/onTagRead":{"identifier":"doc:\/\/rpm.com.production.Scanner\/documentation\/Fueling\/NFCReader\/onTagRead","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"Callback to handle the tag read operation."}],"title":"onTagRead","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"onTagRead"},{"text":": ((","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")?"}],"url":"\/documentation\/fueling\/nfcreader\/ontagread"},"doc://rpm.com.production.Scanner/SH":{"title":"Swift.Hashable","type":"unresolvable","identifier":"doc:\/\/rpm.com.production.Scanner\/SH"},"doc://rpm.com.production.Scanner/documentation/Fueling/CoreDataManager":{"fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"CoreDataManager","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/rpm.com.production.Scanner\/documentation\/Fueling\/CoreDataManager","kind":"symbol","title":"CoreDataManager","abstract":[],"navigatorTitle":[{"text":"CoreDataManager","kind":"identifier"}],"url":"\/documentation\/fueling\/coredatamanager","role":"symbol"},"doc://rpm.com.production.Scanner/objc(pl)NFCNDEFReaderSessionDelegate":{"title":"CoreNFC.NFCNDEFReaderSessionDelegate","type":"unresolvable","identifier":"doc:\/\/rpm.com.production.Scanner\/objc(pl)NFCNDEFReaderSessionDelegate"},"doc://rpm.com.production.Scanner/s23CustomStringConvertibleP":{"title":"Swift.CustomStringConvertible","type":"unresolvable","identifier":"doc:\/\/rpm.com.production.Scanner\/s23CustomStringConvertibleP"},"doc://rpm.com.production.Scanner/documentation/Fueling/LocationManager":{"identifier":"doc:\/\/rpm.com.production.Scanner\/documentation\/Fueling\/LocationManager","kind":"symbol","role":"symbol","abstract":[{"text":"A class that manages location services and provides updates on the device’s location and authorization status.","type":"text"}],"title":"LocationManager","type":"topic","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"LocationManager","kind":"identifier"}],"navigatorTitle":[{"text":"LocationManager","kind":"identifier"}],"url":"\/documentation\/fueling\/locationmanager"},"doc://rpm.com.production.Scanner/SQ":{"identifier":"doc:\/\/rpm.com.production.Scanner\/SQ","type":"unresolvable","title":"Swift.Equatable"},"doc://rpm.com.production.Scanner/7Combine16ObservableObjectP":{"identifier":"doc:\/\/rpm.com.production.Scanner\/7Combine16ObservableObjectP","type":"unresolvable","title":"Combine.ObservableObject"},"doc://rpm.com.production.Scanner/documentation/Fueling/ConfigurationViewModel":{"kind":"symbol","identifier":"doc:\/\/rpm.com.production.Scanner\/documentation\/Fueling\/ConfigurationViewModel","type":"topic","abstract":[],"url":"\/documentation\/fueling\/configurationviewmodel","title":"ConfigurationViewModel","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"ConfigurationViewModel"}],"fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ConfigurationViewModel"}]},"doc://rpm.com.production.Scanner/objc(pl)NSObject":{"identifier":"doc:\/\/rpm.com.production.Scanner\/objc(pl)NSObject","type":"unresolvable","title":"ObjectiveC.NSObjectProtocol"},"doc://rpm.com.production.Scanner/documentation/Fueling/WebSocketViewModel":{"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebSocketViewModel"}],"navigatorTitle":[{"kind":"identifier","text":"WebSocketViewModel"}],"abstract":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"WebSocketViewModel"},{"type":"text","text":" class is responsible for managing WebSocket connections, handling messages, and updating application state based on WebSocket events."}],"url":"\/documentation\/fueling\/websocketviewmodel","type":"topic","identifier":"doc:\/\/rpm.com.production.Scanner\/documentation\/Fueling\/WebSocketViewModel","title":"WebSocketViewModel"},"doc://rpm.com.production.Scanner/documentation/Fueling/NFCReader/readerSession(_:didDetectNDEFs:)":{"identifier":"doc:\/\/rpm.com.production.Scanner\/documentation\/Fueling\/NFCReader\/readerSession(_:didDetectNDEFs:)","kind":"symbol","role":"symbol","abstract":[{"text":"Called when the NFC reader session detects NDEF messages.","type":"text"}],"title":"readerSession(_:didDetectNDEFs:)","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"readerSession"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"NFCNDEFReaderSession","preciseIdentifier":"c:objc(cs)NFCNDEFReaderSession"},{"kind":"text","text":", "},{"kind":"externalParam","text":"didDetectNDEFs"},{"text":": [","kind":"text"},{"preciseIdentifier":"c:objc(cs)NFCNDEFMessage","kind":"typeIdentifier","text":"NFCNDEFMessage"},{"text":"])","kind":"text"}],"url":"\/documentation\/fueling\/nfcreader\/readersession(_:diddetectndefs:)"},"doc://rpm.com.production.Scanner/documentation/Fueling":{"kind":"symbol","url":"\/documentation\/fueling","title":"Fueling","identifier":"doc:\/\/rpm.com.production.Scanner\/documentation\/Fueling","abstract":[{"type":"text","text":"The Scanner app is designed to facilitate secure and efficient fuel management operations, primarily focusing on user authentication, fuel data collection, and network communication. The app includes several key features to ensure seamless and reliable interactions between users and the backend systems, leveraging technologies like WebSockets, Core Data, and biometric authentication."}],"type":"topic","role":"collection"},"doc://rpm.com.production.Scanner/documentation/Fueling/NFCReader/result":{"identifier":"doc:\/\/rpm.com.production.Scanner\/documentation\/Fueling\/NFCReader\/result","abstract":[{"type":"text","text":"Published property to store the result of the NFC read operation."}],"url":"\/documentation\/fueling\/nfcreader\/result","title":"result","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"result"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s6ResultO","text":"Result"},{"text":"<(","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"), "},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"kind":"text","text":">?"}],"role":"symbol"},"doc://rpm.com.production.Scanner/documentation/Fueling/NetworkMonitor":{"navigatorTitle":[{"text":"NetworkMonitor","kind":"identifier"}],"url":"\/documentation\/fueling\/networkmonitor","identifier":"doc:\/\/rpm.com.production.Scanner\/documentation\/Fueling\/NetworkMonitor","kind":"symbol","title":"NetworkMonitor","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"NetworkMonitor"}],"type":"topic","abstract":[{"type":"text","text":"A class that monitors network connectivity, particularly WiFi."}]},"doc://rpm.com.production.Scanner/s28CustomDebugStringConvertibleP":{"identifier":"doc:\/\/rpm.com.production.Scanner\/s28CustomDebugStringConvertibleP","title":"Swift.CustomDebugStringConvertible","type":"unresolvable"},"doc://rpm.com.production.Scanner/documentation/Fueling/NotificationManager":{"url":"\/documentation\/fueling\/notificationmanager","role":"symbol","type":"topic","title":"NotificationManager","kind":"symbol","abstract":[{"type":"text","text":"A class that manages notifications for the application."}],"fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"NotificationManager","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"NotificationManager"}],"identifier":"doc:\/\/rpm.com.production.Scanner\/documentation\/Fueling\/NotificationManager"},"doc://rpm.com.production.Scanner/documentation/Fueling/NFCReader/startScanning(message:)":{"identifier":"doc:\/\/rpm.com.production.Scanner\/documentation\/Fueling\/NFCReader\/startScanning(message:)","role":"symbol","url":"\/documentation\/fueling\/nfcreader\/startscanning(message:)","kind":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"startScanning","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"message"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":")","kind":"text"}],"abstract":[{"text":"Starts the NFC scanning session with a specified alert message.","type":"text"}],"title":"startScanning(message:)"},"doc://rpm.com.production.Scanner/s7CVarArgP":{"identifier":"doc:\/\/rpm.com.production.Scanner\/s7CVarArgP","title":"Swift.CVarArg","type":"unresolvable"},"doc://rpm.com.production.Scanner/objc(cs)NSObject":{"identifier":"doc:\/\/rpm.com.production.Scanner\/objc(cs)NSObject","title":"ObjectiveC.NSObject","type":"unresolvable"},"doc://rpm.com.production.Scanner/documentation/Fueling/NFCReader/readerSession(_:didInvalidateWithError:)":{"kind":"symbol","title":"readerSession(_:didInvalidateWithError:)","abstract":[{"text":"Called when the NFC reader session is invalidated with an error.","type":"text"}],"identifier":"doc:\/\/rpm.com.production.Scanner\/documentation\/Fueling\/NFCReader\/readerSession(_:didInvalidateWithError:)","url":"\/documentation\/fueling\/nfcreader\/readersession(_:didinvalidatewitherror:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"readerSession"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"NFCNDEFReaderSession","preciseIdentifier":"c:objc(cs)NFCNDEFReaderSession"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"didInvalidateWithError"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":")","kind":"text"}],"type":"topic"}}}