Class NfcTag
Definition
- Assembly:
- Tizen.Network.Nfc.dll
The class for managing the Tag information.
public class NfcTag : IDisposable
- Inheritance
-
objectNfcTag
- Implements
-
System.IDisposable
Constructors
View SourceNfcTag()
Constructor of NfcTag
Declaration
public NfcTag()
Properties
View SourceIsSupportNdef
Whether the given NFC tag supports the NDEF messages.
Declaration
public bool IsSupportNdef { get; }
Property Value
Type | Description |
---|---|
bool |
MaximumNdefSize
The maximum NDEF message size that can be stored in the NFC tag.
Declaration
public uint MaximumNdefSize { get; }
Property Value
Type | Description |
---|---|
uint |
NdefSize
The size of the NDEF message stored in the tag.
Declaration
public uint NdefSize { get; }
Property Value
Type | Description |
---|---|
uint |
Type
The type of the NFC tag.
Declaration
public NfcTagType Type { get; }
Property Value
Type | Description |
---|---|
NfcTagType |
Methods
View SourceDispose()
Dispose
Declaration
public void Dispose()
~NfcTag()
NfcTag destructor.
Declaration
protected ~NfcTag()
ForeachInformation()
Retrieves all the tag information.
Declaration
public IEnumerable<NfcTagInformation> ForeachInformation()
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<T><NfcTagInformation> | The list of the NfcTagInformation objects. |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the NFC is not supported. |
System.InvalidOperationException | Thrown when the method fails due to an invalid operation. |
FormatNdefMessageAsync(byte[])
Formats the detected tag that can store the NDEF message.
Declaration
public Task<NfcError> FormatNdefMessageAsync(byte[] keyValue)
Parameters
Type | Name | Description |
---|---|---|
byte[] | keyValue | The key value that may need to format the tag. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TResult><NfcError> |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the NFC is not supported. |
System.ArgumentException | Thrown when method fails due to an invalid parameter. |
System.InvalidOperationException | Thrown when the method fails due to an invalid operation. |
ReadNdefMessageAsync()
Reads the NDEF formatted data from the NFC tag.
Declaration
public Task<NfcNdefMessage> ReadNdefMessageAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TResult><NfcNdefMessage> |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the NFC is not supported. |
System.InvalidOperationException | Thrown when the method fails due to an invalid operation. |
TransceiveAsync(byte[])
Transceives the data of the raw format card.
Declaration
public Task<byte[]> TransceiveAsync(byte[] buffer)
Parameters
Type | Name | Description |
---|---|---|
byte[] | buffer | The binary data for a parameter or additional commands. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TResult><byte[]> |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the NFC is not supported. |
System.ArgumentException | Thrown when the method fails due to an invalid parameter. |
System.InvalidOperationException | Thrown when the the method fails due to an invalid operation. |
WriteNdefMessageAsync(NfcNdefMessage)
Writes the NDEF formatted data.
Declaration
public Task<NfcError> WriteNdefMessageAsync(NfcNdefMessage ndefMessage)
Parameters
Type | Name | Description |
---|---|---|
NfcNdefMessage | ndefMessage | The NfcNdefMessage object. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TResult><NfcError> |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the NFC is not supported. |
System.ArgumentException | Thrown when the method fails due to an invalid parameter. |
System.InvalidOperationException | Thrown when the method fails due to an invalid operation. |