namespace Tizen.Network.Nfc
{
/// <summary>
- /// Structure containing the information of Tag data.
+ /// This structure contains the information of the Tag data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class NfcTagInformation
}
/// <summary>
- /// Structure containing the information of Secure element Aid(Application Identifier).
+ /// This structure contains the information of the secure element AID (Application Identifier).
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class NfcRegisteredAidInformation
}
/// <summary>
- /// Secure Element Type value.
+ /// The Secure Element Type value.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public NfcSecureElementType SeType
}
/// <summary>
- /// The targeted Aid (Application Identifier) value.
+ /// The targeted AID (Application Identifier) value.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public string Aid
}
/// <summary>
- /// Read-only value. If this value is false, there are restrictions to the operation on this Aid.
+ /// 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
namespace Tizen.Network.Nfc
{
/// <summary>
- /// A class for NFC CardEmulation mode. It allows applications to handle Card Emulation informations.
+ /// A class for the 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>
private Interop.Nfc.HostCardEmulationEventCallback _hostCardEmulationEventCallback;
/// <summary>
- /// Event that is called when receiving Secure Element (SIM/UICC(Universal Integrated Circuit Card)) event.
+ /// An event that is called when receiving the Secure Element (SIM/UICC(Universal Integrated Circuit Card)) event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/nfc.cardemulation</privilege>
}
/// <summary>
- /// Event that is called when receiving Secure Element(SIM/UICC(Universal Integrated Circuit Card)) transaction event for 'ESE(SmartMX)' type.
+ /// An event that is called when receiving the Secure Element (SIM/UICC (Universal Integrated Circuit Card)) transaction event for the 'ESE(SmartMX)' type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/nfc.cardemulation</privilege>
}
/// <summary>
- /// Event that is called when receiving Secure Element(SIM/UICC(Universal Integrated Circuit Card)) transaction event for 'UICC' type.
+ /// An event that is called when receiving the Secure Element (SIM/UICC (Universal Integrated Circuit Card)) transaction event for the 'UICC' type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/nfc.cardemulation</privilege>
}
/// <summary>
- /// Event that is called when when receiving HCE(Host Card Emulation) event.
+ /// An event that is called when receiving the HCE (Host Card Emulation) event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/nfc.cardemulation</privilege>
}
/// <summary>
- /// Enable card emulation mode.
+ /// Enables the card emulation mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/nfc.cardemulation</privilege>
- /// <exception cref="NotSupportedException">Thrown when Nfc is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the NFC is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method fails due to an invalid operation.</exception>
public void EnableCardEmulation()
{
int ret = Interop.Nfc.CardEmulation.EnableCardEmulation();
}
/// <summary>
- /// Disable card emulation mode.
+ /// Disables the card emulation mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/nfc.cardemulation</privilege>
- /// <exception cref="NotSupportedException">Thrown when Nfc is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the NFC is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method fails due to an invalid operation.</exception>
public void DisableCardEmulation()
{
int ret = Interop.Nfc.CardEmulation.DisableCardEmulatiion();
}
/// <summary>
- /// Get the current card emulation mode.
+ /// Gets the current card emulation mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns>Enumeration value of NfcSecureElementCardEmulationMode.</returns>
+ /// <returns>Enumeration value for the NfcSecureElementCardEmulationMode.</returns>
/// <privilege>http://tizen.org/privilege/nfc.cardemulation</privilege>
public NfcSecureElementCardEmulationMode GetCardEmulationMode()
{
}
/// <summary>
- /// Give the priority to the foreground application when dispatching transaction event.
+ /// Gives the priority to the foreground application when dispatching the transaction event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/nfc.cardemulation</privilege>
- /// <exception cref="NotSupportedException">Thrown when Nfc is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the NFC is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method fails due to an invalid operation.</exception>
public void EnableTransactionForegroundDispatch()
{
int ret = Interop.Nfc.EnableTransactionForegroundDispatch();
}
/// <summary>
- /// Disable foreground dispatch for "EVT_TRANSACTION" to the givin application.
+ /// Disables the foreground dispatch for the "EVT_TRANSACTION" to the given application.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/nfc.cardemulation</privilege>
- /// <exception cref="NotSupportedException">Thrown when Nfc is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the NFC is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method fails due to an invalid operation.</exception>
public void DisableTransactionForegroundDispatch()
{
int ret = Interop.Nfc.DisableTransactionForegroundDispatch();
}
/// <summary>
- /// Gets the state whether an application to call this api is currently the activated handler for specific AID.
+ /// Gets the state, whether an application to call this API is currently the activated handler for the 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>
+ /// <param name="seType">The type of the Secure Element.</param>
+ /// <param name="aid">The application ID specified in the ISO/IEC 7816-4.</param>
/// <privilege>http://tizen.org/privilege/nfc.cardemulation</privilege>
- /// <exception cref="NotSupportedException">Thrown when Nfc is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the NFC is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method fails due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method fails due to an invalid operation.</exception>
public bool IsActivatedHandlerForAid(NfcSecureElementType seType, string aid)
{
bool isActivatedHandle = false;
}
/// <summary>
- /// Gets the state whether an application to call this api is currently the activated handler for category.
+ /// Gets the state, whether an application to call this API is currently the activated handler for the 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>
+ /// <param name="seType">The type of the secure element.</param>
+ /// <param name="category">Enumeration value of the category.</param>
/// <privilege>http://tizen.org/privilege/nfc.cardemulation</privilege>
- /// <exception cref="NotSupportedException">Thrown when Nfc is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the NFC is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method fails due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method fails due to an invalid operation.</exception>
public bool IsActivatedHandlerForCategory(NfcSecureElementType seType, NfcCardEmulationCategoryType category)
{
bool isActivatedHandle = false;
}
/// <summary>
- /// Registers a AID for a specific category.
+ /// Registers the 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>
+ /// <param name="seType">The type of the secure element.</param>
+ /// <param name="category">Enumeration value of the category.</param>
+ /// <param name="aid">The application ID specified in the ISO/IEC 7816-4.</param>
/// <privilege>http://tizen.org/privilege/nfc.cardemulation</privilege>
- /// <exception cref="NotSupportedException">Thrown when Nfc is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the NFC is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method fails due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method fails due to an invalid operation.</exception>
public void RegisterAid(NfcSecureElementType seType, NfcCardEmulationCategoryType category, string aid)
{
int ret = Interop.Nfc.CardEmulation.RegisterAid((int)seType, (int)category, aid);
/// 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>
+ /// <param name="seType">The type of the secure element.</param>
+ /// <param name="category">Enumeration value of the category.</param>
+ /// <param name="aid">The application ID specified in the ISO/IEC 7816-4.</param>
/// <privilege>http://tizen.org/privilege/nfc.cardemulation</privilege>
- /// <exception cref="NotSupportedException">Thrown when Nfc is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the NFC is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method fails due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method fails due to an invalid operation.</exception>
public void UnregisterAid(NfcSecureElementType seType, NfcCardEmulationCategoryType category, string aid)
{
int ret = Interop.Nfc.CardEmulation.UnregisterAid((int)seType, (int)category, aid);
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/nfc.cardemulation</privilege>
- /// <exception cref="NotSupportedException">Thrown when Nfc is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the NFC is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method fails due to an invalid operation.</exception>
public void SetPreferredApplication()
{
int ret = Interop.Nfc.CardEmulation.SetPreferredHandler();
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/nfc.cardemulation</privilege>
- /// <exception cref="NotSupportedException">Thrown when Nfc is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the NFC is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method fails due to an invalid operation.</exception>
public void UnsetPreferredApplication()
{
int ret = Interop.Nfc.CardEmulation.UnsetPreferredHandler();
}
/// <summary>
- /// Retrieves all registered AID.
+ /// Retrieves all registered AIDs.
/// </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>
+ /// <returns>The list of NfcRegisteredAidInformation objects.</returns>
+ /// <param name="seType">The type of the secure element.</param>
+ /// <param name="category">Enumeration value of the category.</param>
/// <privilege>http://tizen.org/privilege/nfc.cardemulation</privilege>
- /// <exception cref="NotSupportedException">Thrown when Nfc is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the NFC is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method fails due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method fails due to an invalid operation.</exception>
public IEnumerable<NfcRegisteredAidInformation> GetRegisteredAidInformation(NfcSecureElementType seType, NfcCardEmulationCategoryType category)
{
List<NfcRegisteredAidInformation> infoList = new List<NfcRegisteredAidInformation>();
namespace Tizen.Network.Nfc
{
/// <summary>
- /// Enumeration for Nfc record TNF (Type Name Format).
+ /// Enumeration for the NFC record TNF (Type Name Format).
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum NfcRecordTypeNameFormat
{
/// <summary>
- /// Empty
+ /// Empty.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Empty = 0,
/// <summary>
- /// RTD(Record Type Definition) type format [NFC RTD]
+ /// The 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]
+ /// MIME media types in the RFC 2046 [RFC 2046].
/// </summary>
/// <since_tizen> 3 </since_tizen>
MimeMedia = 2,
/// <summary>
- /// Absolute URI as defined in RFC 3986 [RFC 3986]
+ /// The absolute URI as defined in the RFC 3986 [RFC 3986].
/// </summary>
/// <since_tizen> 3 </since_tizen>
Uri = 3,
/// <summary>
- /// NFC Forum external type [NFC RTD]
+ /// The NFC forum external type [NFC RTD].
/// </summary>
/// <since_tizen> 3 </since_tizen>
ExternalRtd = 4,
/// <summary>
- /// The payload type is unknown
+ /// The payload type is unknown.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Unknown = 5,
/// <summary>
- /// final chunk of a chunked NDEF Record
+ /// The final chunk of a chunked NDEF record.
/// </summary>
/// <since_tizen> 3 </since_tizen>
UnChanged = 6
}
/// <summary>
- /// Enumeration for Nfc Encode type.
+ /// Enumeration for the NFC encode type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum NfcEncodeType
{
/// <summary>
- /// UTF-8
+ /// UTF-8.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Utf8 = 0,
/// <summary>
- /// UTF-16
+ /// UTF-16.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Utf16 = 1
}
/// <summary>
- /// Enumeration for Nfc Tag type.
+ /// Enumeration for the NFC tag type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum NfcTagType
{
/// <summary>
- /// Unknown target
+ /// An unknown target.
/// </summary>
/// <since_tizen> 3 </since_tizen>
UnknownTarget = 0x00,
/// <summary>
- /// Generic PICC
+ /// The generic PICC.
/// </summary>
/// <since_tizen> 3 </since_tizen>
GenericPicc,
/// <summary>
- /// ISO14443 A PICC
+ /// The ISO14443 A PICC.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Iso14443APicc,
/// <summary>
- /// ISO14443 4A PICC
+ /// The ISO14443 4A PICC.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Iso144434APicc,
/// <summary>
- /// ISO14443 4A PICC
+ /// The ISO14443 4A PICC.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Iso144433APicc,
/// <summary>
- /// Mifare Mini PICC
+ /// The Mifare Mini PICC.
/// </summary>
/// <since_tizen> 3 </since_tizen>
MifareMiniPicc,
/// <summary>
- /// Mifare 1k PICC
+ /// Mifare 1k PICC.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Mifare1kPicc,
/// <summary>
- /// Mifare 4k PICC
+ /// Mifare 4k PICC.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Mifare4kPicc,
/// <summary>
- /// Mifare Ultra PICC
+ /// The Mifare Ultra PICC.
/// </summary>
/// <since_tizen> 3 </since_tizen>
MifareUltraPicc,
/// <summary>
- /// Mifare Desfire PICC
+ /// The Mifare Desfire PICC.
/// </summary>
/// <since_tizen> 3 </since_tizen>
MifareDesfirePicc,
/// <summary>
- /// Iso14443 B PICC
+ /// The Iso14443 B PICC.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Iso14443BPicc,
/// <summary>
- /// Iso14443 4B PICC
+ /// Iso14443 4B PICC.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Iso144434BPicc,
/// <summary>
- /// ISO14443 B Prime PICC
+ /// The ISO14443 B Prime PICC.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Iso14443BPrimePicc,
/// <summary>
- /// Felica PICC
+ /// The Felica PICC.
/// </summary>
/// <since_tizen> 3 </since_tizen>
FelicaPicc,
/// <summary>
- /// Jewel PICC
+ /// The Jewel PICC.
/// </summary>
/// <since_tizen> 3 </since_tizen>
JewelPicc,
- /// <summary>
- /// ISO15693 PICC
+ /// <summary>.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Iso15693Picc,
/// <summary>
- /// Barcode 128 PICC
+ /// The Barcode 128 PICC.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Barcode128Picc,
/// <summary>
- /// Barcode 256 PICC
+ /// The Barcode 256 PICC.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Barcode256Picc,
/// <summary>
- /// NFCIP1 Target
+ /// The NFCIP1 Target.
/// </summary>
/// <since_tizen> 3 </since_tizen>
NfcIp1Target,
/// <summary>
- /// NFCIP1 Initiator
+ /// The NFCIP1 Initiator.
/// </summary>
/// <since_tizen> 3 </since_tizen>
NfcIp1Initiator
}
/// <summary>
- /// Enumeration for Nfc Tag Filter type.
+ /// Enumeration for the NFC tag filter type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum NfcTagFilterType
{
/// <summary>
- /// All disable
+ /// All disable.
/// </summary>
/// <since_tizen> 3 </since_tizen>
AllDisable = 0x0000,
/// <summary>
- /// ISO14443A enable
+ /// ISO14443A enable.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Iso14443AEnable = 0x0001,
/// <summary>
- /// ISO14443B enable
+ /// ISO14443B enable.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Iso14443BEnable = 0x0002,
/// <summary>
- /// ISO15693 enable
+ /// ISO15693 enable.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Iso15693Enable = 0x0004,
/// <summary>
- /// FELICA enable
+ /// FELICA enable.
/// </summary>
/// <since_tizen> 3 </since_tizen>
FelicaEnable = 0x0008,
/// <summary>
- /// JEWEL enable
+ /// JEWEL enable.
/// </summary>
/// <since_tizen> 3 </since_tizen>
JewelEnable = 0x0010,
/// <summary>
- /// IP enable
+ /// IP enable.
/// </summary>
/// <since_tizen> 3 </since_tizen>
IpEnable = 0x0020,
/// <summary>
- /// All enable
+ /// All enable.
/// </summary>
/// <since_tizen> 3 </since_tizen>
AllEnable = ~0
}
/// <summary>
- /// Enumeration for Nfc discovered type.
+ /// Enumeration for the NFC discovered type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum NfcDiscoveredType
{
/// <summary>
- /// Attached, discovered, activated event
+ /// Attached, discovered, and activated event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Attached,
/// <summary>
- /// Detached, disappeared, deactivated event
+ /// Detached, disappeared, and deactivated event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Detached
}
/// <summary>
- /// Enumeration for Nfc Secure Element event.
+ /// Enumeration for the NFC secure element event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum NfcSecureElementEvent
{
/// <summary>
- /// Start transaction
+ /// Start transaction.
/// </summary>
/// <since_tizen> 3 </since_tizen>
StartTransaction,
/// <summary>
- /// End transaction
+ /// End transaction.
/// </summary>
/// <since_tizen> 3 </since_tizen>
EndTransaction,
/// <summary>
- /// Ready signal
+ /// Ready signal.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Connectivity,
/// <summary>
- /// CLF(Contactless Front-end) detects a RF field
+ /// The 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
+ /// The 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
+ /// An external reader tries to access the secure element.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Transaction,
/// <summary>
- /// Changing the emulated secure element type
+ /// Changing the emulated secure element type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
TypeChanged,
/// <summary>
- /// Changing the card emulation mode
+ /// Changing the card emulation mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
CardEmulationChanged
}
/// <summary>
- /// Enumeration for Nfc Filter type.
+ /// Enumeration for the NFC filter type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum NfcSecureElementType
{
/// <summary>
- /// Disable card emulation
+ /// Disable card emulation.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Disable = 0x00,
/// <summary>
- /// SmartMX type card emulation (Embedded Secure Element)
+ /// The SmartMX type card emulation (Embedded Secure Element).
/// </summary>
/// <since_tizen> 3 </since_tizen>
EmbeddedSE = 0x01,
/// <summary>
- /// UICC type card emulation (Universal IC Card)
+ /// The UICC type card emulation (Universal IC Card).
/// </summary>
/// <since_tizen> 3 </since_tizen>
Uicc = 0x02,
/// <summary>
- /// SDCARD card emulation
+ /// The SDCARD card emulation.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Sdcard = 0x03,
/// <summary>
- /// Host based card emulation
+ /// The Host based card emulation.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Hce = 0x04
}
/// <summary>
- /// Enumeration for Nfc discovered type.
+ /// Enumeration for the NFC discovered type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum NfcSecureElementCardEmulationMode
{
/// <summary>
- /// Card Emulation mode OFF
+ /// The card emulation mode is OFF.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Off = 0x00,
/// <summary>
- /// Card Emulation mode ON
+ /// The card emulation mode is ON.
/// </summary>
/// <since_tizen> 3 </since_tizen>
On = 0x01
}
/// <summary>
- /// Enumeration for SNEP(Simple NDEF Exchange Protocol) event.
+ /// Enumeration for the SNEP (Simple NDEF Exchange Protocol) event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum NfcSnepEvent
{
/// <summary>
- /// server or client stopped
+ /// Server or client stopped.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Stop = 0x00,
/// <summary>
- /// server started or client connected
+ /// Server started or client connected.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Start = 0x01,
/// <summary>
- /// server received get request
+ /// Server received get request.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Get = 0x02,
/// <summary>
- /// server received put request
+ /// Server received put request.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Put = 0x03,
/// <summary>
- /// service registered
+ /// Service registered.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Register = 0x04,
/// <summary>
- /// service unregistered
+ /// Service unregistered.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Unregister = 0x05
}
/// <summary>
- /// Enumeration for SNEP request type.
+ /// Enumeration for the SNEP request type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum NfcSnepRequestType
{
/// <summary>
- /// get request
+ /// The get request.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Get = 0x01,
/// <summary>
- /// put request
+ /// The put request.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Put = 0x02
}
/// <summary>
- /// Enumeration for NFC Card Emulation Category type.
+ /// Enumeration for the NFC card emulation category type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum NfcCardEmulationCategoryType
{
/// <summary>
- /// NFC payment services
+ /// NFC payment services.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Payment = 0x01,
/// <summary>
- /// all other card emulation services
+ /// 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.
+ /// Enumeration for the NFC card emulation HCE (Host Card Emulation) event type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum NfcHceEvent
{
/// <summary>
- /// HCE deactivated
+ /// HCE deactivated.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Deactivated = 0x00,
/// <summary>
- /// HCE activated
+ /// HCE activated.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Activated = 0x01,
/// <summary>
- /// HCE APDU(Application Protocol Data Unit) Received
+ /// HCE APDU (Application Protocol Data Unit) received.
/// </summary>
/// <since_tizen> 3 </since_tizen>
ApduReceived = 0x02
namespace Tizen.Network.Nfc
{
/// <summary>
- /// Enumeration for Nfc Error.
+ /// Enumeration for the NFC Error.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum NfcError
namespace Tizen.Network.Nfc
{
/// <summary>
- /// An extended EventArgs class which contains changed Nfc activation state.
+ /// An extended EventArgs class which contains the changed NFC activation state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class ActivationChangedEventArgs : EventArgs
}
/// <summary>
- /// The Nfc activation state.
+ /// The NFC activation state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public bool Activated
}
/// <summary>
- /// An extended EventArgs class which contains changed Nfc tag discovered.
+ /// An extended EventArgs class which contains the changed NFC tag discovered.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class TagDiscoveredEventArgs : EventArgs
}
/// <summary>
- /// Tag object
+ /// The tag object.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public NfcTag Tag
}
/// <summary>
- /// An extended EventArgs class which contains changed Nfc p2p target discovered.
+ /// An extended EventArgs class which contains the changed NFC P2P target discovered.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class P2pTargetDiscoveredEventArgs : EventArgs
}
/// <summary>
- /// The p2p target type.
+ /// The P2P target type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public NfcDiscoveredType Type
}
/// <summary>
- /// P2p object
+ /// The P2P object.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public NfcP2p P2pTarget
}
/// <summary>
- /// An extended EventArgs class which contains changed Nfc ndef discovered.
+ /// An extended EventArgs class which contains the changed NFC NDEF discovered.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class NdefMessageDiscoveredEventArgs : EventArgs
}
/// <summary>
- /// The NdefMessage object that is most recently received via NFC p2p mode or tag mode
+ /// The NdefMessage object that is most recently received via the NFC P2P mode or the tag mode.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public NfcNdefMessage NdefMessage
}
/// <summary>
- /// An extended EventArgs class which contains changed Secure element event.
+ /// An extended EventArgs class which contains the changed secure element event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class SecureElementEventArgs : EventArgs
}
/// <summary>
- /// The Nfc secure element event.
+ /// The NFC secure element event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public NfcSecureElementEvent EventType
}
/// <summary>
- /// An extended EventArgs class which contains changed Secure element trasaction event.
+ /// An extended EventArgs class which contains the changed secure element trasaction event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class SecureElementTranscationEventArgs : EventArgs
}
/// <summary>
- /// The Nfc secure element type.
+ /// The NFC secure element type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public NfcSecureElementType SecureElementType
}
}
/// <summary>
- /// The Nfc secure element aid.
+ /// The NFC secure element AID.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public byte[] ApplicationID
}
}
/// <summary>
- /// The Nfc secure element param.
+ /// The NFC secure element param.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public byte[] Param
}
/// <summary>
- /// An extended EventArgs class which contains changed HCE(Host Card Emulation) event.
+ /// An extended EventArgs class which contains the changed HCE (Host Card Emulation) event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class HostCardEmulationEventArgs : EventArgs
}
/// <summary>
- /// The Nfc secure element.
+ /// The NFC secure element.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public NfcSecureElement SecureElement
}
}
/// <summary>
- /// The Nfc hce event.
+ /// The NFC HCE event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public NfcHceEvent HceEvent
}
}
/// <summary>
- /// The Nfc apdu(Application Protocol Data Unit)
+ /// The NFC APDU (Application Protocol Data Unit).
/// </summary>
/// <since_tizen> 3 </since_tizen>
public byte[] Apdu
}
/// <summary>
- /// An extended EventArgs class which contains changed HCE(Host Card Emulation) event.
+ /// An extended EventArgs class which contains the changed HCE (Host Card Emulation) event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class P2pDataReceivedEventArgs : EventArgs
}
/// <summary>
- /// The Nfc p2p target.
+ /// The NFC P2P target.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public NfcP2p P2pTarget
}
}
/// <summary>
- /// The Nfc ndef message.
+ /// The NFC NDEF message.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public NfcNdefMessage NdefMessage
namespace Tizen.Network.Nfc
{
/// <summary>
- /// A class for NFC management. It allows applications to use NFC service.
+ /// A class for the NFC management. It allows applications to use the NFC service.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/nfc</privilege>
static public class NfcManager
{
/// <summary>
- /// Whether NFC is supported.
+ /// Checks whether the NFC is supported.
/// </summary>
/// <since_tizen> 3 </since_tizen>
static public bool IsSupported
}
/// <summary>
- /// NFC Activation state.
+ /// The NFC Activation state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
static public bool IsActivated
}
/// <summary>
- /// Enable or disable the system handling for tag and target discovered event.
+ /// Enables or disables the system handling for the tag and target discovered event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/nfc</privilege>
}
/// <summary>
- /// The cached Ndef Message.
+ /// The cached NDEF message.
/// </summary>
/// <since_tizen> 3 </since_tizen>
static public NfcNdefMessage CachedNdefMessage
}
/// <summary>
- /// Gets Tag adapter object.
+ /// Gets the Tag adapter object.
/// </summary>
/// <since_tizen> 3 </since_tizen>
static public NfcTagAdapter GetTagAdapter()
}
/// <summary>
- /// Gets P2p adapter object.
+ /// Gets the P2P adapter object.
/// </summary>
/// <since_tizen> 3 </since_tizen>
static public NfcP2pAdapter GetP2pAdapter()
}
/// <summary>
- /// Gets Card Emulation adepter object.
+ /// Gets the Card Emulation adapter object.
/// </summary>
/// <since_tizen> 3 </since_tizen>
static public NfcCardEmulationAdapter GetCardEmulationAdapter()
}
/// <summary>
- /// Activates Nfc asynchronously.
+ /// Activates the NFC asynchronously.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <returns>A task indicates whether the Activate method is done or not.</returns>
}
/// <summary>
- /// The Ndef discovered event.
+ /// The NDEF discovered event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
static public event EventHandler<NdefMessageDiscoveredEventArgs> NdefMessageDiscovered
namespace Tizen.Network.Nfc
{
/// <summary>
- /// A class for Ndef Message information. It allows applications to use Ndef Message information.
+ /// A class for the NDEF Message information. It allows applications to use the NDEF Message information.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class NfcNdefMessage : IDisposable
private List<NfcNdefRecord> _recordList = new List<NfcNdefRecord>();
/// <summary>
- /// The number of record in NDEF message.
+ /// The number of records in the NDEF message.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public int RecordCount
}
/// <summary>
- /// Creates a object for the access point.
+ /// Creates an object for the access point.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="NotSupportedException">Thrown when Nfc is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the NFC is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method fails due to an invalid operation.</exception>
public NfcNdefMessage()
{
int ret = Interop.Nfc.NdefMessage.Create(out _messageHandle);
}
/// <summary>
- /// Appends a record into NDEF message.
+ /// Appends a record into the 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>
+ /// <returns>Whether the record is appended successfully.</returns>
+ /// <param name="record">The NfcNdefRecord object that will be appended into the NDEF message.</param>
public bool AppendRecord(NfcNdefRecord record)
{
bool isSuccess = true;
}
/// <summary>
- /// Inserts a record at index into NDEF message.
+ /// Inserts a record at the index into the 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>
+ /// <returns>Whether inserting the record succeeded.</returns>
+ /// <param name="index">The index of a record ( starts from 0 ).</param>
+ /// <param name="record">The NfcNdefRecord object that will be appended into the NDEF message.</param>
public bool InsertRecord(int index, NfcNdefRecord record)
{
bool isSuccess = true;
}
/// <summary>
- /// Inserts a record at index into NDEF message.
+ /// Removes a record at the index into the 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>
+ /// <param name="index">The index of a record ( starts from 0 ).</param>
public bool RemoveRecord(int index)
{
bool isSuccess = true;
}
/// <summary>
- /// Gets record by index.
+ /// Gets a record by the index.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <returns>The NfcNdefRecord object.</returns>
- /// <param name="index">The index of record ( starts from 0 ).</param>
+ /// <param name="index">The index of a record ( starts from 0 ).</param>
public NfcNdefRecord GetRecord(int index)
{
IntPtr recordHandle;
namespace Tizen.Network.Nfc
{
/// <summary>
- /// A class for Ndef Record information. It allows applications to use Ndef Record information.
+ /// A class for the NDEF Record information. It allows applications to use the NDEF Record information.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class NfcNdefRecord : IDisposable
}
/// <summary>
- /// The record TNF(Type Name Format) value.
+ /// The record TNF (Type Name Format) value.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public NfcRecordTypeNameFormat Tnf
}
/// <summary>
- /// The text of text type Ndef record.
+ /// The text of the text type NDEF record.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public string Text
}
/// <summary>
- /// The language code of text type Ndef record.
+ /// The language code of the text type NDEF record.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public string LanguageCode
}
/// <summary>
- /// The encoding type of text type Ndef record.
+ /// The encoding type of the text type NDEF record.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public NfcEncodeType EncodeType
}
/// <summary>
- /// The URI of uri type Ndef record.
+ /// The URI of the URI type NDEF record.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public string Uri
}
/// <summary>
- /// The mime type of mime type Ndef record.
+ /// The mime type of the mime type NDEF record.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public string MimeType
}
/// <summary>
- /// Creates a record with given parameter value.
+ /// Creates a record with a 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>
/// <param name="payload">The payload of this record.</param>
- /// <param name="paloadLength">The byte size of payload.</param>
- /// <exception cref="NotSupportedException">Thrown when Nfc is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <param name="paloadLength">The byte size of the payload.</param>
+ /// <exception cref="NotSupportedException">Thrown when the NFC is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method fails due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method fails due to an invalid operation.</exception>
public NfcNdefRecord(NfcRecordTypeNameFormat format, byte[] type, byte[] id, byte[] payload, uint paloadLength)
{
int ret = Interop.Nfc.NdefRecord.Create(out _recordHandle, (int)format, type, type.Length, id, id.Length, payload, paloadLength);
}
/// <summary>
- /// Creates a record with text type payload.
+ /// Creates a record with the 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="languageCode">The language code string value followed by the IANA [RFC 3066] (ex: en-US, ko-KR).</param>
/// <param name="encode">The encoding type.</param>
- /// <exception cref="NotSupportedException">Thrown when Nfc is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the NFC is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method fails due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method fails due to an invalid operation.</exception>
public NfcNdefRecord(string text, string languageCode, NfcEncodeType encode)
{
int ret = Interop.Nfc.NdefRecord.CreateText(out _recordHandle, text, languageCode, (int)encode);
}
/// <summary>
- /// Creates a record with text type payload.
+ /// Creates a record with the URI type payload.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="uri">The URI string that will be stored in the payload.</param>
- /// <exception cref="NotSupportedException">Thrown when Nfc is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the NFC is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method fails due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method fails due to an invalid operation.</exception>
public NfcNdefRecord(string uri)
{
int ret = Interop.Nfc.NdefRecord.CreateUri(out _recordHandle, uri);
}
/// <summary>
- /// Creates a record with text type payload.
+ /// Creates a record with the mime 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>
- /// <exception cref="NotSupportedException">Thrown when Nfc is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <param name="mimeType">The mime type [RFC 2046] (ex. text/plain, image/jpeg ). This value is stored in the type field.</param>
+ /// <param name="data">The data in the form of the bytes array.</param>
+ /// <param name="dataSize">The size of the data.</param>
+ /// <exception cref="NotSupportedException">Thrown when the NFC is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method fails due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method fails due to an invalid operation.</exception>
public NfcNdefRecord(string mimeType, byte[] data, uint dataSize)
{
int ret = Interop.Nfc.NdefRecord.CreateMime(out _recordHandle, mimeType, data, dataSize);
namespace Tizen.Network.Nfc
{
/// <summary>
- /// A class for managing the p2p target information.
+ /// The class for managing the P2P target information.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class NfcP2p : IDisposable
private Interop.Nfc.P2pDataReceivedCallback _p2pDataReceivedCallback;
/// <summary>
- /// The event for receiving data from NFC peer-to-peer target.
+ /// The event for receiving data from the NFC peer-to-peer target.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<P2pDataReceivedEventArgs> P2pDataReceived
}
/// <summary>
- /// Sends data to NFC peer-to-peer target.
+ /// Sends data to the NFC peer-to-peer target.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="ndefMessage">NfcNdefMessage object.</param>
+ /// <param name="ndefMessage">The NfcNdefMessage object.</param>
/// <privilege>http://tizen.org/privilege/nfc</privilege>
- /// <exception cref="NotSupportedException">Thrown when Nfc is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the NFC is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method fails due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method fails due to an invalid operation.</exception>
public Task<NfcError> SendNdefMessageAsync(NfcNdefMessage ndefMessage)
{
var task = new TaskCompletionSource<NfcError>();
}
/// <summary>
- /// A class for managing the snep(Simple NDEF Exchange Protocol) information.
+ /// The class for managing the SNEP (Simple NDEF Exchange Protocol) information.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class NfcSnep : IDisposable
namespace Tizen.Network.Nfc
{
/// <summary>
- /// A class for NFC P2P(Peer to Peer) mode. It allows applications to handle P2P informations.
+ /// The class for the 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>
private Interop.Nfc.P2pTargetDiscoveredCallback _p2pTargetDiscoveredCallback;
/// <summary>
- /// The event for receiving NFC peer-to-peer target discovered notification.
+ /// The event for receiving the NFC peer-to-peer target discovered notification.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<P2pTargetDiscoveredEventArgs> P2pTargetDiscovered
}
/// <summary>
- /// Gets current connected p2p target.
+ /// Gets the current connected P2P target.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns>NfcP2p object.</returns>
+ /// <returns>The NfcP2p object.</returns>
/// <privilege>http://tizen.org/privilege/nfc</privilege>
- /// <exception cref="NotSupportedException">Thrown when Nfc is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the NFC is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method fails due to an invalid operation.</exception>
public NfcP2p GetConnectedTarget()
{
IntPtr targetHandle = IntPtr.Zero;
namespace Tizen.Network.Nfc
{
/// <summary>
- /// A class for managing the Secure Element information.
+ /// The class for managing the Secure Element information.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class NfcSecureElement : IDisposable
}
/// <summary>
- /// Send APDU(Application Protocol Data Unit) response to CLF(Contactless Front-end).
+ /// Sends the APDU (Application Protocol Data Unit) response to the 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>
+ /// <param name="response">The bytes array of the response data.</param>
+ /// <param name="responseLength">The size of the response bytes array.</param>
/// <privilege>http://tizen.org/privilege/nfc.cardemulation</privilege>
- /// <exception cref="NotSupportedException">Thrown when Nfc is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the NFC is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method fails due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method fails due to an invalid operation.</exception>
public void HceSendApduResponse(byte[] response, uint responseLength)
{
int ret = Interop.Nfc.CardEmulation.HceSendApduRespondse(_secureElementHandle, response, responseLength);
namespace Tizen.Network.Nfc
{
/// <summary>
- /// A class for managing the Tag information.
+ /// The class for managing the Tag information.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class NfcTag : IDisposable
private IntPtr _tagHandle = IntPtr.Zero;
/// <summary>
- /// The type of NFC tag.
+ /// The type of the NFC tag.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public NfcTagType Type
}
/// <summary>
- /// Whether the given NFC tag supports NDEF messages.
+ /// Whether the given NFC tag supports the NDEF messages.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public bool IsSupportNdef
}
/// <summary>
- /// The maximum NDEF message size that can be stored in NFC tag.
+ /// The maximum NDEF message size that can be stored in the NFC tag.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public uint MaximumNdefSize
}
/// <summary>
- /// The size of NDEF message that stored in the tag.
+ /// The size of the NDEF message stored in the tag.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public uint NdefSize
}
/// <summary>
- /// Retrieves all tag information.
+ /// Retrieves all the tag information.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns>List of NfcTagInformation objects.</returns>
+ /// <returns>The list of the NfcTagInformation objects.</returns>
/// <privilege>http://tizen.org/privilege/nfc</privilege>
- /// <exception cref="NotSupportedException">Thrown when Nfc is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the NFC is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method fails due to an invalid operation.</exception>
public IEnumerable<NfcTagInformation> ForeachInformation()
{
List<NfcTagInformation> infoList = new List<NfcTagInformation>();
/// 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>
+ /// <param name="buffer">The binary data for a parameter or additional commands.</param>
/// <privilege>http://tizen.org/privilege/nfc</privilege>
- /// <exception cref="NotSupportedException">Thrown when Nfc is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the NFC is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method fails due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the the method fails due to an invalid operation.</exception>
public Task<byte[]> TransceiveAsync(byte[] buffer)
{
var task = new TaskCompletionSource<byte[]>();
}
/// <summary>
- /// Reads NDEF formatted data from NFC tag.
+ /// Reads the NDEF formatted data from the NFC tag.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/nfc</privilege>
- /// <exception cref="NotSupportedException">Thrown when Nfc is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the NFC is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method fails due to an invalid operation.</exception>
public Task<NfcNdefMessage> ReadNdefMessageAsync()
{
var task = new TaskCompletionSource<NfcNdefMessage>();
}
/// <summary>
- /// Writes NDEF formatted data.
+ /// Writes the NDEF formatted data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="ndefMessage">The NfcNdefMessage object.</param>
/// <privilege>http://tizen.org/privilege/nfc</privilege>
- /// <exception cref="NotSupportedException">Thrown when Nfc is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the NFC is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method fails due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method fails due to an invalid operation.</exception>
public Task<NfcError> WriteNdefMessageAsync(NfcNdefMessage ndefMessage)
{
var task = new TaskCompletionSource<NfcError>();
}
/// <summary>
- /// Formats the detected tag that can store NDEF message.
+ /// Formats the detected tag that can store the NDEF message.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="keyValue">The key value that may need to format the tag.</param>
/// <privilege>http://tizen.org/privilege/nfc</privilege>
- /// <exception cref="NotSupportedException">Thrown when Nfc is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the NFC is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when method fails due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method fails due to an invalid operation.</exception>
public Task<NfcError> FormatNdefMessageAsync(byte[] keyValue)
{
var task = new TaskCompletionSource<NfcError>();
namespace Tizen.Network.Nfc
{
/// <summary>
- /// A class for NFC Tag mode. It allows applications to handle Tag informations.
+ /// The class for the NFC tag mode. It allows applications to handle the Tag informations.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/nfc</privilege>
private Interop.Nfc.TagDiscoveredCallback _tagDiscoveredCallback;
/// <summary>
- /// The event for receiving tag discovered notification.
+ /// The event for receiving the tag discovered notification.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<TagDiscoveredEventArgs> TagDiscovered
}
/// <summary>
- /// Gets current connected tag.
+ /// Gets the current connected tag.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns>NfcTag object.</returns>
+ /// <returns>The NfcTag object.</returns>
/// <privilege>http://tizen.org/privilege/nfc</privilege>
- /// <exception cref="NotSupportedException">Thrown when Nfc is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the NFC is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method fails due to an invalid operation.</exception>
public NfcTag GetConnectedTag()
{
IntPtr tagHandle = IntPtr.Zero;
namespace Tizen.Network.Smartcard
{
/// <summary>
- /// A class for Smartcard channel informations. It allows applications to handle channel informations.
+ /// The class for Smartcard channel information. It allows applications to handle the channel information.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/secureelement</privilege>
/// Closes the given channel to the Secure Element.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="NotSupportedException">Thrown when Smartcard is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Smartcard is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
public void Close()
{
int ret = Interop.Smartcard.Channel.ChannelClose(_channelHandle);
/// Gets the response to the select command.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns>Byte array to retrieve the SELECT response.</returns>
+ /// <returns>Byte array to retrieve the select response.</returns>
public byte[] GetSelectedResponse()
{
byte[] respList;
}
/// <summary>
- /// Transmits an APDU command (as per ISO/IEC 7816-4) to the Secure Element.
+ /// Transmits the APDU command (as per ISO/IEC 7816-4) to the secure element.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <returns>Byte array for the response APDU plus status words.</returns>
- /// <param name="cmd">Command APDU to be send to the secure element.</param>
+ /// <param name="cmd">Command APDU to be sent to the secure element.</param>
public byte[] Transmit(byte[] cmd)
{
byte[] atrList;
}
/// <summary>
- /// Helper function to retrieves the response APDU of the previous transmit() call.
+ /// Helper function to retrieve the response APDU of the previous transmit() call.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <returns>Byte array for the response APDU plus status words.</returns>
}
/// <summary>
- /// Performs a selection of the next Applet on the given channel that matches to the partial Application ID(AID).
+ /// Performs a selection of the next applet on the given channel that matches to the partial application ID (AID).
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns>True or false depending whether another applet with the partial Application ID(AID).</returns>
+ /// <returns>True or false depending whether another applet with the partial application ID (AID).</returns>
public bool SelectNext()
{
bool selectNext;
namespace Tizen.Network.Smartcard
{
/// <summary>
- /// A class for Smartcard management. It allows applications to use Smartcard service.
+ /// The class for Smartcard management. It allows applications to use the Smartcard service.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/secureelement</privilege>
static public class SmartcardManager
{
/// <summary>
- /// Gets the list of available Secure Element readers.
+ /// Gets the list of available secure element readers.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <returns>List of SmartcardReader objects.</returns>
namespace Tizen.Network.Smartcard
{
/// <summary>
- /// A class for Smartcard reader informations. It allows applications to handle reader informations.
+ /// The class for Smartcard reader information. It allows applications to handle the reader information.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/secureelement</privilege>
private List<SmartcardSession> _sessionList = new List<SmartcardSession>();
/// <summary>
- /// The name of reader.
+ /// The name of the reader.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public string Name
}
/// <summary>
- /// The existence of secure element.
+ /// The existence of a secure element.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public bool IsSecureElementPresent
}
/// <summary>
- /// Connects to a Secure Element in the given reader.
+ /// Connects to a secure element in the given reader.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <returns>The SmartcardSession object.</returns>
/// Closes all the sessions opened on the given reader.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="NotSupportedException">Thrown when Smartcard is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Smartcard is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
public void CloseSessions()
{
int ret = Interop.Smartcard.Reader.ReaderCloseSessions(_readerHandle);
namespace Tizen.Network.Smartcard
{
/// <summary>
- /// A class for Smartcard session informations. It allows applications to handle session informations.
+ /// The class for the Smartcard session information. It allows applications to handle the session information.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/secureelement</privilege>
}
/// <summary>
- /// The Answer to Reset(ATR) of this Secure Element.
+ /// The Answer to Reset (ATR) of this secure element.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public byte[] Atr
}
/// <summary>
- /// Closes the connection with the Secure Element.
+ /// Closes the connection with the secure element.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="NotSupportedException">Thrown when Smartcard is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Smartcard is not supported.</exception>
/// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
public void Close()
{
/// Closes any channel opened on the given session.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <exception cref="NotSupportedException">Thrown when Smartcard is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Smartcard is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
public void CloseChannels()
{
int ret = Interop.Smartcard.Session.SessionCloseChannels(_sessionHandle);
/// Gets an access to the basic channel, as defined in the ISO/IEC 7816-4 specification (the one that has number 0).
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns>The SmartcardChannel object for basic channel.</returns>
- /// <param name="aid">Byte array containing the Application ID(AID) to be selected on the given channel.</param>
+ /// <returns>The SmartcardChannel object for the basic channel.</returns>
+ /// <param name="aid">The byte array containing the Application ID(AID) to be selected on the given channel.</param>
/// <param name="p2">P2 byte of the SELECT command if executed.</param>
- /// <exception cref="NotSupportedException">Thrown when Smartcard is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Smartcard is not supported.</exception>
/// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
public SmartcardChannel OpenBasicChannel(byte[] aid, byte p2)
{
}
/// <summary>
- /// Open a logical channel with the Secure Element, selecting the Applet represented by the given Application ID(AID).
+ /// Open a logical channel with the secure element, selecting the Applet represented by the given application ID (AID).
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns>The SmartcardChannel object for logical channel.</returns>
- /// <param name="aid">Byte array containing the Application ID(AID) to be selected on the given channel.</param>
+ /// <returns>The SmartcardChannel object for the logical channel.</returns>
+ /// <param name="aid">The byte array containing the Application ID(AID) to be selected on the given channel.</param>
/// <param name="p2">P2 byte of the SELECT command if executed.</param>
- /// <exception cref="NotSupportedException">Thrown when Smartcard is not supported.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Smartcard is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
public SmartcardChannel OpenLogicalChannel(byte[] aid, byte p2)
{
int ret = Interop.Smartcard.Session.SessionOpenLogicalChannel(_sessionHandle, aid, aid.Length, p2, out _logicalChannel);
projects / platform / core / csapi / tizenfx.git / commitdiff