Artifacts/bin/public/Tizen.Network.Smartcard.xml

   1 <?xml version="1.0"?>\r
   2 <doc>\r
   3     <assembly>\r
   4         <name>Tizen.Network.Smartcard</name>\r
   5     </assembly>\r
   6     <members>\r
   7         <member name="T:Tizen.Network.Smartcard.SmartcardChannel">\r
   8             <summary>\r
   9             The class for Smartcard channel information. It allows applications to handle the channel information.\r
  10             </summary>\r
  11             <since_tizen> 3 </since_tizen>\r
  12             <privilege>http://tizen.org/privilege/secureelement</privilege>\r
  13         </member>\r
  14         <member name="P:Tizen.Network.Smartcard.SmartcardChannel.IsBasicChannel">\r
  15             <summary>\r
  16             Whether the kind of channel is basic.\r
  17             </summary>\r
  18             <since_tizen> 3 </since_tizen>\r
  19         </member>\r
  20         <member name="P:Tizen.Network.Smartcard.SmartcardChannel.IsLogicalChannel">\r
  21             <summary>\r
  22             Whether the kind of channel is logical.\r
  23             </summary>\r
  24             <since_tizen> 3 </since_tizen>\r
  25         </member>\r
  26         <member name="P:Tizen.Network.Smartcard.SmartcardChannel.IsClosed">\r
  27             <summary>\r
  28             Whether the channel is closed.\r
  29             </summary>\r
  30             <since_tizen> 3 </since_tizen>\r
  31         </member>\r
  32         <member name="P:Tizen.Network.Smartcard.SmartcardChannel.Session">\r
  33             <summary>\r
  34             The session that has opened the given channel.\r
  35             </summary>\r
  36             <since_tizen> 3 </since_tizen>\r
  37         </member>\r
  38         <member name="M:Tizen.Network.Smartcard.SmartcardChannel.Close">\r
  39             <summary>\r
  40             Closes the given channel to the Secure Element.\r
  41             </summary>\r
  42             <since_tizen> 3 </since_tizen>\r
  43             <exception cref="T:System.NotSupportedException">Thrown when the Smartcard is not supported.</exception>\r
  44             <exception cref="T:System.InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>\r
  45         </member>\r
  46         <member name="M:Tizen.Network.Smartcard.SmartcardChannel.GetSelectedResponse">\r
  47             <summary>\r
  48             Gets the response to the select command.\r
  49             </summary>\r
  50             <since_tizen> 3 </since_tizen>\r
  51             <returns>Byte array to retrieve the select response.</returns>\r
  52         </member>\r
  53         <member name="M:Tizen.Network.Smartcard.SmartcardChannel.Transmit(System.Byte[])">\r
  54             <summary>\r
  55             Transmits the APDU command (as per ISO/IEC 7816-4) to the secure element.\r
  56             </summary>\r
  57             <since_tizen> 3 </since_tizen>\r
  58             <returns>Byte array for the response APDU plus status words.</returns>\r
  59             <param name="cmd">Command APDU to be sent to the secure element.</param>\r
  60         </member>\r
  61         <member name="M:Tizen.Network.Smartcard.SmartcardChannel.GetTransmittedResponse">\r
  62             <summary>\r
  63             Helper function to retrieve the response APDU of the previous transmit() call.\r
  64             </summary>\r
  65             <since_tizen> 3 </since_tizen>\r
  66             <returns>Byte array for the response APDU plus status words.</returns>\r
  67         </member>\r
  68         <member name="M:Tizen.Network.Smartcard.SmartcardChannel.SelectNext">\r
  69             <summary>\r
  70             Performs a selection of the next applet on the given channel that matches to the partial application ID (AID).\r
  71             </summary>\r
  72             <since_tizen> 3 </since_tizen>\r
  73             <returns>True or false depending whether another applet with the partial application ID (AID).</returns>\r
  74         </member>\r
  75         <member name="T:Tizen.Network.Smartcard.SmartcardManager">\r
  76             <summary>\r
  77             The class for Smartcard management. It allows applications to use the Smartcard service.\r
  78             </summary>\r
  79             <since_tizen> 3 </since_tizen>\r
  80             <privilege>http://tizen.org/privilege/secureelement</privilege>\r
  81         </member>\r
  82         <member name="M:Tizen.Network.Smartcard.SmartcardManager.GetReaders">\r
  83             <summary>\r
  84             Gets the list of available secure element readers.\r
  85             </summary>\r
  86             <since_tizen> 3 </since_tizen>\r
  87             <returns>List of SmartcardReader objects.</returns>\r
  88         </member>\r
  89         <member name="T:Tizen.Network.Smartcard.SmartcardReader">\r
  90             <summary>\r
  91             The class for Smartcard reader information. It allows applications to handle the reader information.\r
  92             </summary>\r
  93             <since_tizen> 3 </since_tizen>\r
  94             <privilege>http://tizen.org/privilege/secureelement</privilege>\r
  95         </member>\r
  96         <member name="P:Tizen.Network.Smartcard.SmartcardReader.Name">\r
  97             <summary>\r
  98             The name of the reader.\r
  99             </summary>\r
 100             <since_tizen> 3 </since_tizen>\r
 101         </member>\r
 102         <member name="P:Tizen.Network.Smartcard.SmartcardReader.IsSecureElementPresent">\r
 103             <summary>\r
 104             The existence of a secure element.\r
 105             </summary>\r
 106             <since_tizen> 3 </since_tizen>\r
 107         </member>\r
 108         <member name="M:Tizen.Network.Smartcard.SmartcardReader.OpenSession">\r
 109             <summary>\r
 110             Connects to a secure element in the given reader.\r
 111             </summary>\r
 112             <since_tizen> 3 </since_tizen>\r
 113             <returns>The SmartcardSession object.</returns>\r
 114         </member>\r
 115         <member name="M:Tizen.Network.Smartcard.SmartcardReader.CloseSessions">\r
 116             <summary>\r
 117             Closes all the sessions opened on the given reader.\r
 118             </summary>\r
 119             <since_tizen> 3 </since_tizen>\r
 120             <exception cref="T:System.NotSupportedException">Thrown when the Smartcard is not supported.</exception>\r
 121             <exception cref="T:System.InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>\r
 122         </member>\r
 123         <member name="T:Tizen.Network.Smartcard.SmartcardSession">\r
 124             <summary>\r
 125             The class for the Smartcard session information. It allows applications to handle the session information.\r
 126             </summary>\r
 127             <since_tizen> 3 </since_tizen>\r
 128             <privilege>http://tizen.org/privilege/secureelement</privilege>\r
 129         </member>\r
 130         <member name="P:Tizen.Network.Smartcard.SmartcardSession.Reader">\r
 131             <summary>\r
 132             The reader object that provides the given session.\r
 133             </summary>\r
 134             <since_tizen> 3 </since_tizen>\r
 135         </member>\r
 136         <member name="P:Tizen.Network.Smartcard.SmartcardSession.Atr">\r
 137             <summary>\r
 138             The Answer to Reset (ATR) of this secure element.\r
 139             </summary>\r
 140             <since_tizen> 3 </since_tizen>\r
 141         </member>\r
 142         <member name="P:Tizen.Network.Smartcard.SmartcardSession.IsClosed">\r
 143             <summary>\r
 144             Whether the session is closed.\r
 145             </summary>\r
 146             <since_tizen> 3 </since_tizen>\r
 147         </member>\r
 148         <member name="M:Tizen.Network.Smartcard.SmartcardSession.Close">\r
 149             <summary>\r
 150             Closes the connection with the secure element.\r
 151             </summary>\r
 152             <since_tizen> 3 </since_tizen>\r
 153             <exception cref="T:System.NotSupportedException">Thrown when the Smartcard is not supported.</exception>\r
 154             <exception cref="T:System.InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>\r
 155         </member>\r
 156         <member name="M:Tizen.Network.Smartcard.SmartcardSession.CloseChannels">\r
 157             <summary>\r
 158             Closes any channel opened on the given session.\r
 159             </summary>\r
 160             <since_tizen> 3 </since_tizen>\r
 161             <exception cref="T:System.NotSupportedException">Thrown when the Smartcard is not supported.</exception>\r
 162             <exception cref="T:System.InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>\r
 163         </member>\r
 164         <member name="M:Tizen.Network.Smartcard.SmartcardSession.OpenBasicChannel(System.Byte[],System.Byte)">\r
 165             <summary>\r
 166             Gets an access to the basic channel, as defined in the ISO/IEC 7816-4 specification (the one that has number 0).\r
 167             </summary>\r
 168             <since_tizen> 3 </since_tizen>\r
 169             <returns>The SmartcardChannel object for the basic channel.</returns>\r
 170             <param name="aid">The byte array containing the Application ID(AID) to be selected on the given channel.</param>\r
 171             <param name="p2">P2 byte of the SELECT command if executed.</param>\r
 172             <exception cref="T:System.NotSupportedException">Thrown when the Smartcard is not supported.</exception>\r
 173             <exception cref="T:System.InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>\r
 174         </member>\r
 175         <member name="M:Tizen.Network.Smartcard.SmartcardSession.OpenLogicalChannel(System.Byte[],System.Byte)">\r
 176             <summary>\r
 177             Open a logical channel with the secure element, selecting the Applet represented by the given application ID (AID).\r
 178             </summary>\r
 179             <since_tizen> 3 </since_tizen>\r
 180             <returns>The SmartcardChannel object for the logical channel.</returns>\r
 181             <param name="aid">The byte array containing the Application ID(AID) to be selected on the given channel.</param>\r
 182             <param name="p2">P2 byte of the SELECT command if executed.</param>\r
 183             <exception cref="T:System.NotSupportedException">Thrown when the Smartcard is not supported.</exception>\r
 184             <exception cref="T:System.InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>\r
 185         </member>\r
 186     </members>\r
 187 </doc>\r