Class NfcCardEmulationAdapter

Definition

Namespace:: Tizen.Network.Nfc

Assembly:: Tizen.Network.Nfc.dll

API Level:: 3

Privilege Level:: public

Privilege:: http://tizen.org/privilege/nfc.cardemulation

A class for the NFC CardEmulation mode. It allows applications to handle Card Emulation informations.


                C#
                
                    Copy
                    
                
            
public class NfcCardEmulationAdapter : IDisposable

Inheritance: System.Object

NfcCardEmulationAdapter

Implements: System.IDisposable

Methods

View Source

DisableCardEmulation()

Disables the card emulation mode.

Declaration


                C#
                
                    Copy
                    
                
            
public void DisableCardEmulation()

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the NFC is not supported.
System.InvalidOperationException	Thrown when the method fails due to an invalid operation.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/nfc.cardemulation

View Source

DisableTransactionForegroundDispatch()

Disables the foreground dispatch for the "EVT_TRANSACTION" to the given application.

Declaration


                C#
                
                    Copy
                    
                
            
public void DisableTransactionForegroundDispatch()

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the NFC is not supported.
System.InvalidOperationException	Thrown when the method fails due to an invalid operation.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/nfc.cardemulation

View Source

Dispose()

Dispose

Declaration


                C#
                
                    Copy
                    
                
            
public void Dispose()

API Level: 3

View Source

EnableCardEmulation()

Enables the card emulation mode.

Declaration


                C#
                
                    Copy
                    
                
            
public void EnableCardEmulation()

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the NFC is not supported.
System.InvalidOperationException	Thrown when the method fails due to an invalid operation.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/nfc.cardemulation

View Source

EnableTransactionForegroundDispatch()

Gives the priority to the foreground application when dispatching the transaction event.

Declaration


                C#
                
                    Copy
                    
                
            
public void EnableTransactionForegroundDispatch()

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the NFC is not supported.
System.InvalidOperationException	Thrown when the method fails due to an invalid operation.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/nfc.cardemulation

View Source

Finalize()

NfcCardEmulationAdpater destructor.

Declaration


                C#
                
                    Copy
                    
                
            
protected void Finalize()

View Source

GetCardEmulationMode()

Gets the current card emulation mode.

Declaration


                C#
                
                    Copy
                    
                
            
public NfcSecureElementCardEmulationMode GetCardEmulationMode()

Returns

Type	Description
NfcSecureElementCardEmulationMode	Enumeration value for the NfcSecureElementCardEmulationMode.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/nfc.cardemulation

View Source

GetRegisteredAidInformation(NfcSecureElementType, NfcCardEmulationCategoryType)

Retrieves all registered AIDs.

Declaration


                C#
                
                    Copy
                    
                
            
public IEnumerable<NfcRegisteredAidInformation> GetRegisteredAidInformation(NfcSecureElementType seType, NfcCardEmulationCategoryType category)

Parameters

Type	Name	Description
NfcSecureElementType	seType	The type of the secure element.
NfcCardEmulationCategoryType	category	Enumeration value of the category.

Returns

Type	Description
System.Collections.Generic.IEnumerable<NfcRegisteredAidInformation>	The list of NfcRegisteredAidInformation objects.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the NFC is not supported.
System.ArgumentException	Thrown when the method fails due to an invalid parameter.
System.InvalidOperationException	Thrown when the method fails due to an invalid operation.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/nfc.cardemulation

View Source

IsActivatedHandlerForAid(NfcSecureElementType, String)

Gets the state, whether an application to call this API is currently the activated handler for the specific AID.

Declaration


                C#
                
                    Copy
                    
                
            
public bool IsActivatedHandlerForAid(NfcSecureElementType seType, string aid)

Parameters

Type	Name	Description
NfcSecureElementType	seType	The type of the Secure Element.
System.String	aid	The application ID specified in the ISO/IEC 7816-4.

Returns

Type	Description
Boolean	'True' when application is currently the activated handler, otherwise 'False'.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the NFC is not supported.
System.ArgumentException	Thrown when the method fails due to an invalid parameter.
System.InvalidOperationException	Thrown when the method fails due to an invalid operation.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/nfc.cardemulation

View Source

IsActivatedHandlerForCategory(NfcSecureElementType, NfcCardEmulationCategoryType)

Gets the state, whether an application to call this API is currently the activated handler for the category.

Declaration


                C#
                
                    Copy
                    
                
            
public bool IsActivatedHandlerForCategory(NfcSecureElementType seType, NfcCardEmulationCategoryType category)

Parameters

Type	Name	Description
NfcSecureElementType	seType	The type of the secure element.
NfcCardEmulationCategoryType	category	Enumeration value of the category.

Returns

Type	Description
Boolean	'True' when application is currently the activated handler, otherwise 'False'.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the NFC is not supported.
System.ArgumentException	Thrown when the method fails due to an invalid parameter.
System.InvalidOperationException	Thrown when the method fails due to an invalid operation.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/nfc.cardemulation

View Source

RegisterAid(NfcSecureElementType, NfcCardEmulationCategoryType, String)

Registers the AID for a specific category.

Declaration


                C#
                
                    Copy
                    
                
            
public void RegisterAid(NfcSecureElementType seType, NfcCardEmulationCategoryType category, string aid)

Parameters

Type	Name	Description
NfcSecureElementType	seType	The type of the secure element.
NfcCardEmulationCategoryType	category	Enumeration value of the category.
System.String	aid	The application ID specified in the ISO/IEC 7816-4.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the NFC is not supported.
System.ArgumentException	Thrown when the method fails due to an invalid parameter.
System.InvalidOperationException	Thrown when the method fails due to an invalid operation.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/nfc.cardemulation

View Source

SetPreferredApplication()

Sets the application as a preferred handler.

Declaration


                C#
                
                    Copy
                    
                
            
public void SetPreferredApplication()

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the NFC is not supported.
System.InvalidOperationException	Thrown when the method fails due to an invalid operation.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/nfc.cardemulation

View Source

UnregisterAid(NfcSecureElementType, NfcCardEmulationCategoryType, String)

Unregisters a previously registered AID for the specified category.

Declaration


                C#
                
                    Copy
                    
                
            
public void UnregisterAid(NfcSecureElementType seType, NfcCardEmulationCategoryType category, string aid)

Parameters

Type	Name	Description
NfcSecureElementType	seType	The type of the secure element.
NfcCardEmulationCategoryType	category	Enumeration value of the category.
System.String	aid	The application ID specified in the ISO/IEC 7816-4.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the NFC is not supported.
System.ArgumentException	Thrown when the method fails due to an invalid parameter.
System.InvalidOperationException	Thrown when the method fails due to an invalid operation.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/nfc.cardemulation

View Source

UnsetPreferredApplication()

Unsets the application as a preferred handler.

Declaration


                C#
                
                    Copy
                    
                
            
public void UnsetPreferredApplication()

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the NFC is not supported.
System.InvalidOperationException	Thrown when the method fails due to an invalid operation.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/nfc.cardemulation

Events

View Source

EseSecureElementTransactionEvent

An event that is called when receiving the Secure Element (SIM/UICC (Universal Integrated Circuit Card)) transaction event for the 'ESE(SmartMX)' type.

Declaration


                C#
                
                    Copy
                    
                
            
public event EventHandler<SecureElementTranscationEventArgs> EseSecureElementTransactionEvent

Event Type

Type	Description
System.EventHandler<SecureElementTranscationEventArgs>

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/nfc.cardemulation

View Source

HostCardEmulationEvent

An event that is called when receiving the HCE (Host Card Emulation) event.

Declaration


                C#
                
                    Copy
                    
                
            
public event EventHandler<HostCardEmulationEventArgs> HostCardEmulationEvent

Event Type

Type	Description
System.EventHandler<HostCardEmulationEventArgs>

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/nfc.cardemulation

View Source

SecureElementEvent

An event that is called when receiving the Secure Element (SIM/UICC(Universal Integrated Circuit Card)) event.

Declaration


                C#
                
                    Copy
                    
                
            
public event EventHandler<SecureElementEventArgs> SecureElementEvent

Event Type

Type	Description
System.EventHandler<SecureElementEventArgs>

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/nfc.cardemulation

View Source

UiccSecureElementTransactionEvent

An event that is called when receiving the Secure Element (SIM/UICC (Universal Integrated Circuit Card)) transaction event for the 'UICC' type.

Declaration


                C#
                
                    Copy
                    
                
            
public event EventHandler<SecureElementTranscationEventArgs> UiccSecureElementTransactionEvent

Event Type

Type	Description
System.EventHandler<SecureElementTranscationEventArgs>