diff options
author | jh8801.jung <jh8801.jung@samsung.com> | 2017-07-03 15:23:18 +0900 |
---|---|---|
committer | jh8801.jung <jh8801.jung@samsung.com> | 2017-07-03 15:23:44 +0900 |
commit | 2d9cf77811cc4d8c8b364a37524d031aca783d3f (patch) | |
tree | fe8cd25911586ed4f6aa73ef6658df62801a440e | |
parent | 5f24ed5c7be1eefc9bff7da5f5dae453ad822520 (diff) | |
download | nfc-2d9cf77811cc4d8c8b364a37524d031aca783d3f.tar.gz nfc-2d9cf77811cc4d8c8b364a37524d031aca783d3f.tar.bz2 nfc-2d9cf77811cc4d8c8b364a37524d031aca783d3f.zip |
Add since_tizen Tag
Signed-off-by: jh8801.jung <jh8801.jung@samsung.com>
Change-Id: Ied82ea3ee84a9650223e21c62debea49ce20298d
13 files changed, 183 insertions, 1 deletions
diff --git a/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcCallbackData.cs b/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcCallbackData.cs index 030d18a..ba7c595 100755 --- a/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcCallbackData.cs +++ b/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcCallbackData.cs @@ -22,6 +22,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Structure containing the information of Tag data. /// </summary> + /// <since_tizen> 3 </since_tizen> public class NfcTagInformation { private string _key; @@ -36,6 +37,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Key value. /// </summary> + /// <since_tizen> 3 </since_tizen> public string Key { get @@ -46,6 +48,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Information value. /// </summary> + /// <since_tizen> 3 </since_tizen> public byte[] InformationValue { get @@ -58,6 +61,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Structure containing the information of Secure element Aid(Application Identifier). /// </summary> + /// <since_tizen> 3 </since_tizen> public class NfcRegisteredAidInformation { private NfcSecureElementType _seType; @@ -74,6 +78,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Secure Element Type value. /// </summary> + /// <since_tizen> 3 </since_tizen> public NfcSecureElementType SeType { get @@ -83,9 +88,9 @@ namespace Tizen.Network.Nfc } /// <summary> - /// /// The targeted Aid (Application Identifier) value. /// </summary> + /// <since_tizen> 3 </since_tizen> public string Aid { get @@ -97,6 +102,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Read-only value. If this value is false, there are restrictions to the operation on this Aid. /// </summary> + /// <since_tizen> 3 </since_tizen> public bool ReadOnly { get diff --git a/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcCardEmulationAdapter.cs b/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcCardEmulationAdapter.cs index c0ed2a2..06ef7cb 100755 --- a/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcCardEmulationAdapter.cs +++ b/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcCardEmulationAdapter.cs @@ -23,6 +23,7 @@ namespace Tizen.Network.Nfc /// <summary> /// A class for NFC CardEmulation mode. It allows applications to handle Card Emulation informations. /// </summary> + /// <since_tizen> 3 </since_tizen> /// <privilege>http://tizen.org/privilege/nfc.cardemulation</privilege> public class NfcCardEmulationAdapter : IDisposable { @@ -39,6 +40,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Event that is called when receiving Secure Element (SIM/UICC(Universal Integrated Circuit Card)) event. /// </summary> + /// <since_tizen> 3 </since_tizen> public event EventHandler<SecureElementEventArgs> SecureElementEvent { add @@ -62,6 +64,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Event that is called when receiving Secure Element(SIM/UICC(Universal Integrated Circuit Card)) transaction event for 'ESE(SmartMX)' type. /// </summary> + /// <since_tizen> 3 </since_tizen> public event EventHandler<SecureElementTranscationEventArgs> EseSecureElementTransactionEvent { add @@ -85,6 +88,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Event that is called when receiving Secure Element(SIM/UICC(Universal Integrated Circuit Card)) transaction event for 'UICC' type. /// </summary> + /// <since_tizen> 3 </since_tizen> public event EventHandler<SecureElementTranscationEventArgs> UiccSecureElementTransactionEvent { add @@ -108,6 +112,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Event that is called when when receiving HCE(Host Card Emulation) event. /// </summary> + /// <since_tizen> 3 </since_tizen> public event EventHandler<HostCardEmulationEventArgs> HostCardEmulationEvent { add @@ -159,6 +164,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Enable card emulation mode. /// </summary> + /// <since_tizen> 3 </since_tizen> public void EnableCardEmulation() { int ret = Interop.Nfc.CardEmulation.EnableCardEmulation(); @@ -172,6 +178,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Disable card emulation mode. /// </summary> + /// <since_tizen> 3 </since_tizen> public void DisableCardEmulation() { int ret = Interop.Nfc.CardEmulation.DisableCardEmulatiion(); @@ -185,6 +192,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Get the current card emulation mode. /// </summary> + /// <since_tizen> 3 </since_tizen> /// <returns>Enumeration value of NfcSecureElementCardEmulationMode.</returns> public NfcSecureElementCardEmulationMode GetCardEmulationMode() { @@ -201,6 +209,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Give the priority to the foreground application when dispatching transaction event. /// </summary> + /// <since_tizen> 3 </since_tizen> public void EnableTransactionForegroundDispatch() { int ret = Interop.Nfc.EnableTransactionForegroundDispatch(); @@ -214,6 +223,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Disable foreground dispatch for "EVT_TRANSACTION" to the givin application. /// </summary> + /// <since_tizen> 3 </since_tizen> public void DisableTransactionForegroundDispatch() { int ret = Interop.Nfc.DisableTransactionForegroundDispatch(); @@ -227,6 +237,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Gets the state whether an application to call this api is currently the activated handler for specific AID. /// </summary> + /// <since_tizen> 3 </since_tizen> /// <returns>'True' when application is currently the activated handler, otherwise 'False'.</returns> /// <param name="seType">The type of Secure Element.</param> /// <param name="aid">Application Id, specified in ISO/IEC 7816-4.</param> @@ -246,6 +257,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Gets the state whether an application to call this api is currently the activated handler for category. /// </summary> + /// <since_tizen> 3 </since_tizen> /// <returns>'True' when application is currently the activated handler, otherwise 'False'.</returns> /// <param name="seType">The type of Secure Element.</param> /// <param name="category">Enumeration value of category.</param> @@ -265,6 +277,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Registers a AID for a specific category. /// </summary> + /// <since_tizen> 3 </since_tizen> /// <param name="seType">The type of Secure Element.</param> /// <param name="category">Enumeration value of category.</param> /// <param name="aid">Application Id, specified in ISO/IEC 7816-4.</param> @@ -281,6 +294,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Unregisters a previously registered AID for the specified category. /// </summary> + /// <since_tizen> 3 </since_tizen> /// <param name="seType">The type of Secure Element.</param> /// <param name="category">Enumeration value of category.</param> /// <param name="aid">Application Id, specified in ISO/IEC 7816-4.</param> @@ -297,6 +311,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Sets the application as a preferred handler. /// </summary> + /// <since_tizen> 3 </since_tizen> public void SetPreferredApplication() { int ret = Interop.Nfc.CardEmulation.SetPreferredHandler(); @@ -310,6 +325,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Unsets the application as a preferred handler. /// </summary> + /// <since_tizen> 3 </since_tizen> public void UnsetPreferredApplication() { int ret = Interop.Nfc.CardEmulation.UnsetPreferredHandler(); @@ -323,6 +339,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Retrieves all registered AID. /// </summary> + /// <since_tizen> 3 </since_tizen> /// <returns>List of NfcRegisteredAidInformation objects.</returns> /// <param name="seType">The type of Secure Element.</param> /// <param name="category">Enumeration value of category.</param> diff --git a/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcEnumerations.cs b/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcEnumerations.cs index 9a11123..6a35053 100644 --- a/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcEnumerations.cs +++ b/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcEnumerations.cs @@ -21,342 +21,421 @@ namespace Tizen.Network.Nfc /// <summary> /// Enumeration for Nfc record TNF (Type Name Format). /// </summary> + /// <since_tizen> 3 </since_tizen> public enum NfcRecordTypeNameFormat { /// <summary> /// Empty /// </summary> + /// <since_tizen> 3 </since_tizen> Empty = 0, /// <summary> /// RTD(Record Type Definition) type format [NFC RTD] /// </summary> + /// <since_tizen> 3 </since_tizen> WellKnown = 1, /// <summary> /// MIME Media types in RFC 2046 [RFC 2046] /// </summary> + /// <since_tizen> 3 </since_tizen> MimeMedia = 2, /// <summary> /// Absolute URI as defined in RFC 3986 [RFC 3986] /// </summary> + /// <since_tizen> 3 </since_tizen> Uri = 3, /// <summary> /// NFC Forum external type [NFC RTD] /// </summary> + /// <since_tizen> 3 </since_tizen> ExternalRtd = 4, /// <summary> /// The payload type is unknown /// </summary> + /// <since_tizen> 3 </since_tizen> Unknown = 5, /// <summary> /// final chunk of a chunked NDEF Record /// </summary> + /// <since_tizen> 3 </since_tizen> UnChanged = 6 } /// <summary> /// Enumeration for Nfc Encode type. /// </summary> + /// <since_tizen> 3 </since_tizen> public enum NfcEncodeType { /// <summary> /// UTF-8 /// </summary> + /// <since_tizen> 3 </since_tizen> Utf8 = 0, /// <summary> /// UTF-16 /// </summary> + /// <since_tizen> 3 </since_tizen> Utf16 = 1 } /// <summary> /// Enumeration for Nfc Tag type. /// </summary> + /// <since_tizen> 3 </since_tizen> public enum NfcTagType { /// <summary> /// Unknown target /// </summary> + /// <since_tizen> 3 </since_tizen> UnknownTarget = 0x00, /// <summary> /// Generic PICC /// </summary> + /// <since_tizen> 3 </since_tizen> GenericPicc, /// <summary> /// ISO14443 A PICC /// </summary> + /// <since_tizen> 3 </since_tizen> Iso14443APicc, /// <summary> /// ISO14443 4A PICC /// </summary> + /// <since_tizen> 3 </since_tizen> Iso144434APicc, /// <summary> /// ISO14443 4A PICC /// </summary> + /// <since_tizen> 3 </since_tizen> Iso144433APicc, /// <summary> /// Mifare Mini PICC /// </summary> + /// <since_tizen> 3 </since_tizen> MifareMiniPicc, /// <summary> /// Mifare 1k PICC /// </summary> + /// <since_tizen> 3 </since_tizen> Mifare1kPicc, /// <summary> /// Mifare 4k PICC /// </summary> + /// <since_tizen> 3 </since_tizen> Mifare4kPicc, /// <summary> /// Mifare Ultra PICC /// </summary> + /// <since_tizen> 3 </since_tizen> MifareUltraPicc, /// <summary> /// Mifare Desfire PICC /// </summary> + /// <since_tizen> 3 </since_tizen> MifareDesfirePicc, /// <summary> /// Iso14443 B PICC /// </summary> + /// <since_tizen> 3 </since_tizen> Iso14443BPicc, /// <summary> /// Iso14443 4B PICC /// </summary> + /// <since_tizen> 3 </since_tizen> Iso144434BPicc, /// <summary> /// ISO14443 B Prime PICC /// </summary> + /// <since_tizen> 3 </since_tizen> Iso14443BPrimePicc, /// <summary> /// Felica PICC /// </summary> + /// <since_tizen> 3 </since_tizen> FelicaPicc, /// <summary> /// Jewel PICC /// </summary> + /// <since_tizen> 3 </since_tizen> JewelPicc, /// <summary> /// ISO15693 PICC /// </summary> + /// <since_tizen> 3 </since_tizen> Iso15693Picc, /// <summary> /// Barcode 128 PICC /// </summary> + /// <since_tizen> 3 </since_tizen> Barcode128Picc, /// <summary> /// Barcode 256 PICC /// </summary> + /// <since_tizen> 3 </since_tizen> Barcode256Picc, /// <summary> /// NFCIP1 Target /// </summary> + /// <since_tizen> 3 </since_tizen> NfcIp1Target, /// <summary> /// NFCIP1 Initiator /// </summary> + /// <since_tizen> 3 </since_tizen> NfcIp1Initiator } /// <summary> /// Enumeration for Nfc Tag Filter type. /// </summary> + /// <since_tizen> 3 </since_tizen> public enum NfcTagFilterType { /// <summary> /// All disable /// </summary> + /// <since_tizen> 3 </since_tizen> AllDisable = 0x0000, /// <summary> /// ISO14443A enable /// </summary> + /// <since_tizen> 3 </since_tizen> Iso14443AEnable = 0x0001, /// <summary> /// ISO14443B enable /// </summary> + /// <since_tizen> 3 </since_tizen> Iso14443BEnable = 0x0002, /// <summary> /// ISO15693 enable /// </summary> + /// <since_tizen> 3 </since_tizen> Iso15693Enable = 0x0004, /// <summary> /// FELICA enable /// </summary> + /// <since_tizen> 3 </since_tizen> FelicaEnable = 0x0008, /// <summary> /// JEWEL enable /// </summary> + /// <since_tizen> 3 </since_tizen> JewelEnable = 0x0010, /// <summary> /// IP enable /// </summary> + /// <since_tizen> 3 </since_tizen> IpEnable = 0x0020, /// <summary> /// All enable /// </summary> + /// <since_tizen> 3 </since_tizen> AllEnable = ~0 } /// <summary> /// Enumeration for Nfc discovered type. /// </summary> + /// <since_tizen> 3 </since_tizen> public enum NfcDiscoveredType { /// <summary> /// Attached, discovered, activated event /// </summary> + /// <since_tizen> 3 </since_tizen> Attached, /// <summary> /// Detached, disappeared, deactivated event /// </summary> + /// <since_tizen> 3 </since_tizen> Detached } /// <summary> /// Enumeration for Nfc Secure Element event. /// </summary> + /// <since_tizen> 3 </since_tizen> public enum NfcSecureElementEvent { /// <summary> /// Start transaction /// </summary> + /// <since_tizen> 3 </since_tizen> StartTransaction, /// <summary> /// End transaction /// </summary> + /// <since_tizen> 3 </since_tizen> EndTransaction, /// <summary> /// Ready signal /// </summary> + /// <since_tizen> 3 </since_tizen> Connectivity, /// <summary> /// CLF(Contactless Front-end) detects a RF field /// </summary> + /// <since_tizen> 3 </since_tizen> FieldOn, /// <summary> /// CLF(Contactless Front-end) detects that the RF field is off /// </summary> + /// <since_tizen> 3 </since_tizen> FieldOff, /// <summary> /// External reader trys to access secure element /// </summary> + /// <since_tizen> 3 </since_tizen> Transaction, /// <summary> /// Changing the emulated secure element type /// </summary> + /// <since_tizen> 3 </since_tizen> TypeChanged, /// <summary> /// Changing the card emulation mode /// </summary> + /// <since_tizen> 3 </since_tizen> CardEmulationChanged } /// <summary> /// Enumeration for Nfc Filter type. /// </summary> + /// <since_tizen> 3 </since_tizen> public enum NfcSecureElementType { /// <summary> /// Disable card emulation /// </summary> + /// <since_tizen> 3 </since_tizen> Disable = 0x00, /// <summary> /// SmartMX type card emulation (Embedded Secure Element) /// </summary> + /// <since_tizen> 3 </since_tizen> EmbeddedSE = 0x01, /// <summary> /// UICC type card emulation (Universal IC Card) /// </summary> + /// <since_tizen> 3 </since_tizen> Uicc = 0x02, /// <summary> /// SDCARD card emulation /// </summary> + /// <since_tizen> 3 </since_tizen> Sdcard = 0x03, /// <summary> /// Host based card emulation /// </summary> + /// <since_tizen> 3 </since_tizen> Hce = 0x04 } /// <summary> /// Enumeration for Nfc discovered type. /// </summary> + /// <since_tizen> 3 </since_tizen> public enum NfcSecureElementCardEmulationMode { /// <summary> /// Card Emulation mode OFF /// </summary> + /// <since_tizen> 3 </since_tizen> Off = 0x00, /// <summary> /// Card Emulation mode ON /// </summary> + /// <since_tizen> 3 </since_tizen> On = 0x01 } /// <summary> /// Enumeration for SNEP(Simple NDEF Exchange Protocol) event. /// </summary> + /// <since_tizen> 3 </since_tizen> public enum NfcSnepEvent { /// <summary> /// server or client stopped /// </summary> + /// <since_tizen> 3 </since_tizen> Stop = 0x00, /// <summary> /// server started or client connected /// </summary> + /// <since_tizen> 3 </since_tizen> Start = 0x01, /// <summary> /// server received get request /// </summary> + /// <since_tizen> 3 </since_tizen> Get = 0x02, /// <summary> /// server received put request /// </summary> + /// <since_tizen> 3 </since_tizen> Put = 0x03, /// <summary> /// service registered /// </summary> + /// <since_tizen> 3 </since_tizen> Register = 0x04, /// <summary> /// service unregistered /// </summary> + /// <since_tizen> 3 </since_tizen> Unregister = 0x05 } /// <summary> /// Enumeration for SNEP request type. /// </summary> + /// <since_tizen> 3 </since_tizen> public enum NfcSnepRequestType { /// <summary> /// get request /// </summary> + /// <since_tizen> 3 </since_tizen> Get = 0x01, /// <summary> /// put request /// </summary> + /// <since_tizen> 3 </since_tizen> Put = 0x02 } /// <summary> /// Enumeration for NFC Card Emulation Category type. /// </summary> + /// <since_tizen> 3 </since_tizen> public enum NfcCardEmulationCategoryType { /// <summary> /// NFC payment services /// </summary> + /// <since_tizen> 3 </since_tizen> Payment = 0x01, /// <summary> /// all other card emulation services /// </summary> + /// <since_tizen> 3 </since_tizen> Other = 0x02 } /// <summary> /// Enumeration for NFC Card Emulation HCE(Host Card Emulation) event type. /// </summary> + /// <since_tizen> 3 </since_tizen> public enum NfcHceEvent { /// <summary> /// HCE deactivated /// </summary> + /// <since_tizen> 3 </since_tizen> Deactivated = 0x00, /// <summary> /// HCE activated /// </summary> + /// <since_tizen> 3 </since_tizen> Activated = 0x01, /// <summary> /// HCE APDU(Application Protocol Data Unit) Received /// </summary> + /// <since_tizen> 3 </since_tizen> ApduReceived = 0x02 } } diff --git a/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcErrorFactory.cs b/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcErrorFactory.cs index 8b3f9df..7af0af5 100644 --- a/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcErrorFactory.cs +++ b/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcErrorFactory.cs @@ -22,6 +22,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Enumeration for Nfc Error. /// </summary> + /// <since_tizen> 3 </since_tizen> public enum NfcError { None = ErrorCode.None, diff --git a/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcEventArgs.cs b/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcEventArgs.cs index 81a9a75..37195ab 100644 --- a/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcEventArgs.cs +++ b/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcEventArgs.cs @@ -22,6 +22,7 @@ namespace Tizen.Network.Nfc /// <summary> /// An extended EventArgs class which contains changed Nfc activation state. /// </summary> + /// <since_tizen> 3 </since_tizen> public class ActivationChangedEventArgs : EventArgs { private bool _activated = false; @@ -34,6 +35,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The Nfc activation state. /// </summary> + /// <since_tizen> 3 </since_tizen> public bool Activated { get @@ -46,6 +48,7 @@ namespace Tizen.Network.Nfc /// <summary> /// An extended EventArgs class which contains changed Nfc tag discovered. /// </summary> + /// <since_tizen> 3 </since_tizen> public class TagDiscoveredEventArgs : EventArgs { private NfcDiscoveredType _type = NfcDiscoveredType.Detached; @@ -59,6 +62,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The tag type. /// </summary> + /// <since_tizen> 3 </since_tizen> public NfcDiscoveredType Type { get @@ -70,6 +74,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Tag object /// </summary> + /// <since_tizen> 3 </since_tizen> public NfcTag Tag { get @@ -82,6 +87,7 @@ namespace Tizen.Network.Nfc /// <summary> /// An extended EventArgs class which contains changed Nfc p2p target discovered. /// </summary> + /// <since_tizen> 3 </since_tizen> public class P2pTargetDiscoveredEventArgs : EventArgs { private NfcDiscoveredType _type = NfcDiscoveredType.Detached; @@ -95,6 +101,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The p2p target type. /// </summary> + /// <since_tizen> 3 </since_tizen> public NfcDiscoveredType Type { get @@ -106,6 +113,7 @@ namespace Tizen.Network.Nfc /// <summary> /// P2p object /// </summary> + /// <since_tizen> 3 </since_tizen> public NfcP2p P2pTarget { get @@ -118,6 +126,7 @@ namespace Tizen.Network.Nfc /// <summary> /// An extended EventArgs class which contains changed Nfc ndef discovered. /// </summary> + /// <since_tizen> 3 </since_tizen> public class NdefMessageDiscoveredEventArgs : EventArgs { private NfcNdefMessage _ndef; @@ -130,6 +139,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The NdefMessage object that is most recently received via NFC p2p mode or tag mode /// </summary> + /// <since_tizen> 3 </since_tizen> public NfcNdefMessage NdefMessage { get @@ -142,6 +152,7 @@ namespace Tizen.Network.Nfc /// <summary> /// An extended EventArgs class which contains changed Secure element event. /// </summary> + /// <since_tizen> 3 </since_tizen> public class SecureElementEventArgs : EventArgs { private NfcSecureElementEvent _eventType = NfcSecureElementEvent.StartTransaction; @@ -154,6 +165,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The Nfc secure element event. /// </summary> + /// <since_tizen> 3 </since_tizen> public NfcSecureElementEvent EventType { get @@ -166,6 +178,7 @@ namespace Tizen.Network.Nfc /// <summary> /// An extended EventArgs class which contains changed Secure element trasaction event. /// </summary> + /// <since_tizen> 3 </since_tizen> public class SecureElementTranscationEventArgs : EventArgs { private NfcSecureElementType _secureElementType = NfcSecureElementType.Disable; @@ -182,6 +195,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The Nfc secure element type. /// </summary> + /// <since_tizen> 3 </since_tizen> public NfcSecureElementType SecureElementType { get @@ -192,6 +206,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The Nfc secure element aid. /// </summary> + /// <since_tizen> 3 </since_tizen> public byte[] ApplicationID { get @@ -202,6 +217,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The Nfc secure element param. /// </summary> + /// <since_tizen> 3 </since_tizen> public byte[] Param { get @@ -214,6 +230,7 @@ namespace Tizen.Network.Nfc /// <summary> /// An extended EventArgs class which contains changed HCE(Host Card Emulation) event. /// </summary> + /// <since_tizen> 3 </since_tizen> public class HostCardEmulationEventArgs : EventArgs { private NfcSecureElement _se; @@ -230,6 +247,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The Nfc secure element. /// </summary> + /// <since_tizen> 3 </since_tizen> public NfcSecureElement SecureElement { get @@ -240,6 +258,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The Nfc hce event. /// </summary> + /// <since_tizen> 3 </since_tizen> public NfcHceEvent HceEvent { get @@ -250,6 +269,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The Nfc apdu(Application Protocol Data Unit) /// </summary> + /// <since_tizen> 3 </since_tizen> public byte[] Apdu { get @@ -262,6 +282,7 @@ namespace Tizen.Network.Nfc /// <summary> /// An extended EventArgs class which contains changed HCE(Host Card Emulation) event. /// </summary> + /// <since_tizen> 3 </since_tizen> public class P2pDataReceivedEventArgs : EventArgs { private NfcP2p _p2pTarget; @@ -276,6 +297,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The Nfc p2p target. /// </summary> + /// <since_tizen> 3 </since_tizen> public NfcP2p P2pTarget { get @@ -286,6 +308,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The Nfc ndef message. /// </summary> + /// <since_tizen> 3 </since_tizen> public NfcNdefMessage NdefMessage { get diff --git a/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcManager.cs b/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcManager.cs index 14294f7..439fec7 100755 --- a/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcManager.cs +++ b/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcManager.cs @@ -24,12 +24,14 @@ namespace Tizen.Network.Nfc /// <summary> /// A class for NFC management. It allows applications to use NFC service. /// </summary> + /// <since_tizen> 3 </since_tizen> /// <privilege>http://tizen.org/privilege/nfc</privilege> static public class NfcManager { /// <summary> /// Whether NFC is supported. /// </summary> + /// <since_tizen> 3 </since_tizen> static public bool IsSupported { get @@ -55,6 +57,7 @@ namespace Tizen.Network.Nfc /// <summary> /// NFC Activation state. /// </summary> + /// <since_tizen> 3 </since_tizen> static public bool IsActivated { get @@ -80,6 +83,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The Tag Filter type. /// </summary> + /// <since_tizen> 3 </since_tizen> static public NfcTagFilterType TagFilterType { get @@ -125,6 +129,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The Secure Element type. /// </summary> + /// <since_tizen> 3 </since_tizen> static public NfcSecureElementType SecureElementType { get @@ -170,6 +175,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Enable or disable the system handling for tag and target discovered event. /// </summary> + /// <since_tizen> 3 </since_tizen> static public bool SystemHandlerEnabled { get @@ -213,6 +219,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The cached Ndef Message. /// </summary> + /// <since_tizen> 3 </since_tizen> static public NfcNdefMessage CachedNdefMessage { get @@ -238,6 +245,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Gets Tag adapter object. /// </summary> + /// <since_tizen> 3 </since_tizen> static public NfcTagAdapter GetTagAdapter() { bool isNfcSupported = SystemInfo.TryGetValue("http://tizen.org/feature/network.nfc", out isNfcSupported); @@ -261,6 +269,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Gets P2p adapter object. /// </summary> + /// <since_tizen> 3 </since_tizen> static public NfcP2pAdapter GetP2pAdapter() { bool isNfcSupported = SystemInfo.TryGetValue("http://tizen.org/feature/network.nfc", out isNfcSupported); @@ -284,6 +293,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Gets Card Emulation adepter object. /// </summary> + /// <since_tizen> 3 </since_tizen> static public NfcCardEmulationAdapter GetCardEmulationAdapter() { bool isNfcSupported = SystemInfo.TryGetValue("http://tizen.org/feature/network.nfc", out isNfcSupported); @@ -307,6 +317,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Activates Nfc asynchronously. /// </summary> + /// <since_tizen> 3 </since_tizen> /// <returns>A task indicates whether the Activate method is done or not.</returns> static public Task SetActivationAsync(bool activation) { @@ -330,6 +341,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The Activation changed event. /// </summary> + /// <since_tizen> 3 </since_tizen> static public event EventHandler<ActivationChangedEventArgs> ActivationChanged { add @@ -373,6 +385,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The Ndef discovered event. /// </summary> + /// <since_tizen> 3 </since_tizen> static public event EventHandler<NdefMessageDiscoveredEventArgs> NdefMessageDiscovered { add diff --git a/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcNdefMessage.cs b/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcNdefMessage.cs index 0e22636..eedbecd 100755 --- a/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcNdefMessage.cs +++ b/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcNdefMessage.cs @@ -23,6 +23,7 @@ namespace Tizen.Network.Nfc /// <summary> /// A class for Ndef Message information. It allows applications to use Ndef Message information. /// </summary> + /// <since_tizen> 3 </since_tizen> public class NfcNdefMessage : IDisposable { private bool disposed = false; @@ -32,6 +33,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The number of record in NDEF message. /// </summary> + /// <since_tizen> 3 </since_tizen> public int RecordCount { get @@ -49,6 +51,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Creates a object for the access point. /// </summary> + /// <since_tizen> 3 </since_tizen> public NfcNdefMessage() { int ret = Interop.Nfc.NdefMessage.Create(out _messageHandle); @@ -98,6 +101,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Appends a record into NDEF message. /// </summary> + /// <since_tizen> 3 </since_tizen> /// <returns>Whether appending the record succeeded.</returns> /// <param name="record">The NfcNdefRecord object that will be appended into NDEF message.</param> public bool AppendRecord(NfcNdefRecord record) @@ -121,6 +125,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Inserts a record at index into NDEF message. /// </summary> + /// <since_tizen> 3 </since_tizen> /// <returns>Whether insterting the record succeeded.</returns> /// <param name="index">The index of record ( starts from 0 ).</param> /// <param name="record">The NfcNdefRecord object that will be appended into NDEF message.</param> @@ -145,6 +150,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Inserts a record at index into NDEF message. /// </summary> + /// <since_tizen> 3 </since_tizen> /// <returns>Whether removing the record succeeded.</returns> /// <param name="index">The index of record ( starts from 0 ).</param> public bool RemoveRecord(int index) @@ -164,6 +170,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Gets record by index. /// </summary> + /// <since_tizen> 3 </since_tizen> /// <returns>The NfcNdefRecord object.</returns> /// <param name="index">The index of record ( starts from 0 ).</param> public NfcNdefRecord GetRecord(int index) diff --git a/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcNdefRecord.cs b/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcNdefRecord.cs index e8815f8..00b06e1 100755 --- a/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcNdefRecord.cs +++ b/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcNdefRecord.cs @@ -23,6 +23,7 @@ namespace Tizen.Network.Nfc /// <summary> /// A class for Ndef Record information. It allows applications to use Ndef Record information. /// </summary> + /// <since_tizen> 3 </since_tizen> public class NfcNdefRecord : IDisposable { private bool disposed = false; @@ -31,6 +32,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The record ID. /// </summary> + /// <since_tizen> 3 </since_tizen> public byte[] Id { get @@ -51,6 +53,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The record payload. /// </summary> + /// <since_tizen> 3 </since_tizen> public byte[] Payload { get @@ -71,6 +74,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The record type. /// </summary> + /// <since_tizen> 3 </since_tizen> public byte[] Type { get @@ -91,6 +95,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The record TNF(Type Name Format) value. /// </summary> + /// <since_tizen> 3 </since_tizen> public NfcRecordTypeNameFormat Tnf { get @@ -108,6 +113,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The text of text type Ndef record. /// </summary> + /// <since_tizen> 3 </since_tizen> public string Text { get @@ -125,6 +131,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The language code of text type Ndef record. /// </summary> + /// <since_tizen> 3 </since_tizen> public string LanguageCode { get @@ -142,6 +149,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The encoding type of text type Ndef record. /// </summary> + /// <since_tizen> 3 </since_tizen> public NfcEncodeType EncodeType { get @@ -159,6 +167,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The URI of uri type Ndef record. /// </summary> + /// <since_tizen> 3 </since_tizen> public string Uri { get @@ -176,6 +185,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The mime type of mime type Ndef record. /// </summary> + /// <since_tizen> 3 </since_tizen> public string MimeType { get @@ -193,6 +203,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Creates a record with given parameter value. /// </summary> + /// <since_tizen> 3 </since_tizen> /// <param name="format">The type name format.</param> /// <param name="type">The specified type name.</param> /// <param name="id">The record ID.</param> @@ -212,6 +223,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Creates a record with text type payload. /// </summary> + /// <since_tizen> 3 </since_tizen> /// <param name="text">The encoded text.</param> /// <param name="languageCode">The language code string value followed by IANA[RFC 3066] (ex: en-US, ko-KR).</param> /// <param name="encode">The encoding type.</param> @@ -229,6 +241,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Creates a record with text type payload. /// </summary> + /// <since_tizen> 3 </since_tizen> /// <param name="uri">The URI string that will be stored in the payload.</param> public NfcNdefRecord(string uri) { @@ -244,6 +257,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Creates a record with text type payload. /// </summary> + /// <since_tizen> 3 </since_tizen> /// <param name="mimeType">The mime type [RFC 2046] (ex. text/plain, image/jpeg ) This value is stored in type field.</param> /// <param name="data">The data in form of bytes array.</param> /// <param name="dataSize">The size of data.</param> diff --git a/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcP2p.cs b/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcP2p.cs index 1010d81..a11e859 100755 --- a/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcP2p.cs +++ b/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcP2p.cs @@ -24,6 +24,7 @@ namespace Tizen.Network.Nfc /// <summary> /// A class for managing the p2p target information. /// </summary> + /// <since_tizen> 3 </since_tizen> public class NfcP2p : IDisposable { private IntPtr _p2pTargetHandle = IntPtr.Zero; @@ -36,6 +37,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The event for receiving data from NFC peer-to-peer target. /// </summary> + /// <since_tizen> 3 </since_tizen> public event EventHandler<P2pDataReceivedEventArgs> P2pDataReceived { add @@ -87,6 +89,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Sends data to NFC peer-to-peer target. /// </summary> + /// <since_tizen> 3 </since_tizen> /// <param name="ndefMessage">NfcNdefMessage object.</param> public Task<NfcError> SendNdefMessageAsync(NfcNdefMessage ndefMessage) { @@ -132,6 +135,7 @@ namespace Tizen.Network.Nfc /// <summary> /// A class for managing the snep(Simple NDEF Exchange Protocol) information. /// </summary> + /// <since_tizen> 3 </since_tizen> public class NfcSnep : IDisposable { private IntPtr _snepHandle = IntPtr.Zero; diff --git a/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcP2pAdapter.cs b/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcP2pAdapter.cs index 646f178..4b254b1 100755 --- a/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcP2pAdapter.cs +++ b/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcP2pAdapter.cs @@ -23,6 +23,7 @@ namespace Tizen.Network.Nfc /// <summary> /// A class for NFC P2P(Peer to Peer) mode. It allows applications to handle P2P informations. /// </summary> + /// <since_tizen> 3 </since_tizen> /// <privilege>http://tizen.org/privilege/nfc</privilege> public class NfcP2pAdapter : IDisposable { @@ -36,6 +37,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The event for receiving NFC peer-to-peer target discovered notification. /// </summary> + /// <since_tizen> 3 </since_tizen> public event EventHandler<P2pTargetDiscoveredEventArgs> P2pTargetDiscovered { add @@ -81,6 +83,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Gets current connected p2p target. /// </summary> + /// <since_tizen> 3 </since_tizen> /// <returns>NfcP2p object.</returns> public NfcP2p GetConnectedTarget() { diff --git a/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcSecureElement.cs b/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcSecureElement.cs index 02c8986..c412417 100644 --- a/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcSecureElement.cs +++ b/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcSecureElement.cs @@ -23,6 +23,7 @@ namespace Tizen.Network.Nfc /// <summary> /// A class for managing the Secure Element information. /// </summary> + /// <since_tizen> 3 </since_tizen> public class NfcSecureElement : IDisposable { private IntPtr _secureElementHandle = IntPtr.Zero; @@ -60,6 +61,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Send APDU(Application Protocol Data Unit) response to CLF(Contactless Front-end). /// </summary> + /// <since_tizen> 3 </since_tizen> /// <param name="response">The bytes array of response data.</param> /// <param name="responseLength">The size of response bytes array.</param> public void HceSendApduResponse(byte[] response, uint responseLength) diff --git a/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcTag.cs b/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcTag.cs index d1d5d65..567f52d 100755 --- a/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcTag.cs +++ b/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcTag.cs @@ -24,6 +24,7 @@ namespace Tizen.Network.Nfc /// <summary> /// A class for managing the Tag information. /// </summary> + /// <since_tizen> 3 </since_tizen> public class NfcTag : IDisposable { private bool disposed = false; @@ -32,6 +33,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The type of NFC tag. /// </summary> + /// <since_tizen> 3 </since_tizen> public NfcTagType Type { get @@ -49,6 +51,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Whether the given NFC tag supports NDEF messages. /// </summary> + /// <since_tizen> 3 </since_tizen> public bool IsSupportNdef { get @@ -67,6 +70,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The maximum NDEF message size that can be stored in NFC tag. /// </summary> + /// <since_tizen> 3 </since_tizen> public uint MaximumNdefSize { get @@ -84,6 +88,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The size of NDEF message that stored in the tag. /// </summary> + /// <since_tizen> 3 </since_tizen> public uint NdefSize { get @@ -130,6 +135,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Retrieves all tag information. /// </summary> + /// <since_tizen> 3 </since_tizen> /// <returns>List of NfcTagInformation objects.</returns> public IEnumerable<NfcTagInformation> ForeachInformation() { @@ -162,6 +168,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Transceives the data of the raw format card. /// </summary> + /// <since_tizen> 3 </since_tizen> /// <param name="buffer">The binary data for parameter or additional commands.</param> public Task<byte[]> TransceiveAsync(byte[] buffer) { @@ -192,6 +199,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Reads NDEF formatted data from NFC tag. /// </summary> + /// <since_tizen> 3 </since_tizen> public Task<NfcNdefMessage> ReadNdefMessageAsync() { var task = new TaskCompletionSource<NfcNdefMessage>(); @@ -222,6 +230,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Writes NDEF formatted data. /// </summary> + /// <since_tizen> 3 </since_tizen> /// <param name="ndefMessage">The NfcNdefMessage object.</param> public Task<NfcError> WriteNdefMessageAsync(NfcNdefMessage ndefMessage) { @@ -246,6 +255,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Formats the detected tag that can store NDEF message. /// </summary> + /// <since_tizen> 3 </since_tizen> /// <param name="keyValue">The key value that may need to format the tag.</param> public Task<NfcError> FormatNdefMessageAsync(byte[] keyValue) { diff --git a/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcTagAdapter.cs b/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcTagAdapter.cs index 97532b5..5c6d8a9 100755 --- a/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcTagAdapter.cs +++ b/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcTagAdapter.cs @@ -23,6 +23,7 @@ namespace Tizen.Network.Nfc /// <summary> /// A class for NFC Tag mode. It allows applications to handle Tag informations. /// </summary> + /// <since_tizen> 3 </since_tizen> /// <privilege>http://tizen.org/privilege/nfc</privilege> public class NfcTagAdapter : IDisposable { @@ -36,6 +37,7 @@ namespace Tizen.Network.Nfc /// <summary> /// The event for receiving tag discovered notification. /// </summary> + /// <since_tizen> 3 </since_tizen> public event EventHandler<TagDiscoveredEventArgs> TagDiscovered { add @@ -81,6 +83,7 @@ namespace Tizen.Network.Nfc /// <summary> /// Gets current connected tag. /// </summary> + /// <since_tizen> 3 </since_tizen> /// <returns>NfcTag object.</returns> public NfcTag GetConnectedTag() { |