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