Release 4.0.0-preview1-00051
[platform/core/csapi/tizenfx.git] / src / Tizen.Network.Nfc / Tizen.Network.Nfc / NfcEnumerations.cs
1 /*
2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
3  *
4  * Licensed under the Apache License, Version 2.0 (the License);
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an AS IS BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 using System;
18
19 namespace Tizen.Network.Nfc
20 {
21     /// <summary>
22     /// Enumeration for Nfc record TNF (Type Name Format).
23     /// </summary>
24     /// <since_tizen> 3 </since_tizen>
25     public enum NfcRecordTypeNameFormat
26     {
27         /// <summary>
28         /// Empty
29         /// </summary>
30         /// <since_tizen> 3 </since_tizen>
31         Empty = 0,
32         /// <summary>
33         /// RTD(Record Type Definition) type format [NFC RTD]
34         /// </summary>
35         /// <since_tizen> 3 </since_tizen>
36         WellKnown = 1,
37         /// <summary>
38         /// MIME Media types in RFC 2046 [RFC 2046]
39         /// </summary>
40         /// <since_tizen> 3 </since_tizen>
41         MimeMedia = 2,
42         /// <summary>
43         /// Absolute URI as defined in RFC 3986 [RFC 3986]
44         /// </summary>
45         /// <since_tizen> 3 </since_tizen>
46         Uri = 3,
47         /// <summary>
48         /// NFC Forum external type [NFC RTD]
49         /// </summary>
50         /// <since_tizen> 3 </since_tizen>
51         ExternalRtd = 4,
52         /// <summary>
53         /// The payload type is unknown
54         /// </summary>
55         /// <since_tizen> 3 </since_tizen>
56         Unknown = 5,
57         /// <summary>
58         ///  final chunk of a chunked NDEF Record
59         /// </summary>
60         /// <since_tizen> 3 </since_tizen>
61         UnChanged = 6
62     }
63
64     /// <summary>
65     /// Enumeration for Nfc Encode type.
66     /// </summary>
67     /// <since_tizen> 3 </since_tizen>
68     public enum NfcEncodeType
69     {
70         /// <summary>
71         /// UTF-8
72         /// </summary>
73         /// <since_tizen> 3 </since_tizen>
74         Utf8 = 0,
75         /// <summary>
76         /// UTF-16
77         /// </summary>
78         /// <since_tizen> 3 </since_tizen>
79         Utf16 = 1
80     }
81     /// <summary>
82     /// Enumeration for Nfc Tag type.
83     /// </summary>
84     /// <since_tizen> 3 </since_tizen>
85     public enum NfcTagType
86     {
87         /// <summary> 
88         /// Unknown target
89         /// </summary>
90         /// <since_tizen> 3 </since_tizen>
91         UnknownTarget = 0x00,
92         /// <summary>
93         /// Generic PICC
94         /// </summary>
95         /// <since_tizen> 3 </since_tizen>
96         GenericPicc,
97         /// <summary>
98         /// ISO14443 A PICC
99         /// </summary>
100         /// <since_tizen> 3 </since_tizen>
101         Iso14443APicc,
102         /// <summary>
103         /// ISO14443 4A PICC
104         /// </summary>
105         /// <since_tizen> 3 </since_tizen>
106         Iso144434APicc,
107         /// <summary>
108         /// ISO14443 4A PICC
109         /// </summary>
110         /// <since_tizen> 3 </since_tizen>
111         Iso144433APicc,
112         /// <summary> 
113         /// Mifare Mini PICC
114         /// </summary>
115         /// <since_tizen> 3 </since_tizen>
116         MifareMiniPicc,
117         /// <summary>
118         /// Mifare 1k PICC
119         /// </summary>
120         /// <since_tizen> 3 </since_tizen>
121         Mifare1kPicc,
122         /// <summary>
123         /// Mifare 4k PICC
124         /// </summary>
125         /// <since_tizen> 3 </since_tizen>
126         Mifare4kPicc,
127         /// <summary>
128         /// Mifare Ultra PICC
129         /// </summary>
130         /// <since_tizen> 3 </since_tizen>
131         MifareUltraPicc,
132         /// <summary>
133         /// Mifare Desfire PICC
134         /// </summary>
135         /// <since_tizen> 3 </since_tizen>
136         MifareDesfirePicc,
137         /// <summary> 
138         /// Iso14443 B PICC
139         /// </summary>
140         /// <since_tizen> 3 </since_tizen>
141         Iso14443BPicc,
142         /// <summary>
143         /// Iso14443 4B PICC
144         /// </summary>
145         /// <since_tizen> 3 </since_tizen>
146         Iso144434BPicc,
147         /// <summary>
148         /// ISO14443 B Prime PICC
149         /// </summary>
150         /// <since_tizen> 3 </since_tizen>
151         Iso14443BPrimePicc,
152         /// <summary>
153         /// Felica PICC
154         /// </summary>
155         /// <since_tizen> 3 </since_tizen>
156         FelicaPicc,
157         /// <summary>
158         /// Jewel PICC
159         /// </summary>
160         /// <since_tizen> 3 </since_tizen>
161         JewelPicc,
162         /// <summary> 
163         /// ISO15693 PICC
164         /// </summary>
165         /// <since_tizen> 3 </since_tizen>
166         Iso15693Picc,
167         /// <summary>
168         /// Barcode 128 PICC
169         /// </summary>
170         /// <since_tizen> 3 </since_tizen>
171         Barcode128Picc,
172         /// <summary>
173         /// Barcode 256 PICC
174         /// </summary>
175         /// <since_tizen> 3 </since_tizen>
176         Barcode256Picc,
177         /// <summary>
178         /// NFCIP1 Target
179         /// </summary>
180         /// <since_tizen> 3 </since_tizen>
181         NfcIp1Target,
182         /// <summary>
183         /// NFCIP1 Initiator
184         /// </summary>
185         /// <since_tizen> 3 </since_tizen>
186         NfcIp1Initiator
187     }
188     /// <summary>
189     /// Enumeration for Nfc Tag Filter type.
190     /// </summary>
191     /// <since_tizen> 3 </since_tizen>
192     public enum NfcTagFilterType
193     {
194         /// <summary>
195         /// All disable
196         /// </summary>
197         /// <since_tizen> 3 </since_tizen>
198         AllDisable = 0x0000,
199         /// <summary>
200         /// ISO14443A enable
201         /// </summary>
202         /// <since_tizen> 3 </since_tizen>
203         Iso14443AEnable = 0x0001,
204         /// <summary>
205         /// ISO14443B enable
206         /// </summary>
207         /// <since_tizen> 3 </since_tizen>
208         Iso14443BEnable = 0x0002,
209         /// <summary>
210         /// ISO15693 enable
211         /// </summary>
212         /// <since_tizen> 3 </since_tizen>
213         Iso15693Enable = 0x0004,
214         /// <summary>
215         /// FELICA enable
216         /// </summary>
217         /// <since_tizen> 3 </since_tizen>
218         FelicaEnable = 0x0008,
219         /// <summary>
220         /// JEWEL enable
221         /// </summary>
222         /// <since_tizen> 3 </since_tizen>
223         JewelEnable = 0x0010,
224         /// <summary>
225         /// IP enable
226         /// </summary>
227         /// <since_tizen> 3 </since_tizen>
228         IpEnable = 0x0020,
229         /// <summary>
230         /// All enable
231         /// </summary>
232         /// <since_tizen> 3 </since_tizen>
233         AllEnable = ~0
234     }
235     /// <summary>
236     /// Enumeration for Nfc discovered type.
237     /// </summary>
238     /// <since_tizen> 3 </since_tizen>
239     public enum NfcDiscoveredType
240     {
241         /// <summary>
242         /// Attached, discovered, activated event
243         /// </summary>
244         /// <since_tizen> 3 </since_tizen>
245         Attached,
246         /// <summary>
247         /// Detached, disappeared, deactivated event
248         /// </summary>
249         /// <since_tizen> 3 </since_tizen>
250         Detached
251     }
252     /// <summary>
253     /// Enumeration for Nfc Secure Element event.
254     /// </summary>
255     /// <since_tizen> 3 </since_tizen>
256     public enum NfcSecureElementEvent
257     {
258         /// <summary>
259         /// Start transaction
260         /// </summary>
261         /// <since_tizen> 3 </since_tizen>
262         StartTransaction,
263         /// <summary>
264         /// End transaction
265         /// </summary>
266         /// <since_tizen> 3 </since_tizen>
267         EndTransaction,
268         /// <summary>
269         /// Ready signal
270         /// </summary>
271         /// <since_tizen> 3 </since_tizen>
272         Connectivity,
273         /// <summary>
274         /// CLF(Contactless Front-end) detects a RF field
275         /// </summary>
276         /// <since_tizen> 3 </since_tizen>
277         FieldOn,
278         /// <summary>
279         /// CLF(Contactless Front-end) detects that the RF field is off
280         /// </summary>
281         /// <since_tizen> 3 </since_tizen>
282         FieldOff,
283         /// <summary>
284         /// External reader trys to access secure element
285         /// </summary>
286         /// <since_tizen> 3 </since_tizen>
287         Transaction,
288         /// <summary>
289         /// Changing the emulated secure element type
290         /// </summary>
291         /// <since_tizen> 3 </since_tizen>
292         TypeChanged,
293         /// <summary>
294         /// Changing the card emulation mode
295         /// </summary>
296         /// <since_tizen> 3 </since_tizen>
297         CardEmulationChanged
298     }
299     /// <summary>
300     /// Enumeration for Nfc Filter type.
301     /// </summary>
302     /// <since_tizen> 3 </since_tizen>
303     public enum NfcSecureElementType
304     {
305         /// <summary>
306         /// Disable card emulation
307         /// </summary>
308         /// <since_tizen> 3 </since_tizen>
309         Disable = 0x00,
310         /// <summary>
311         /// SmartMX type card emulation (Embedded Secure Element)
312         /// </summary>
313         /// <since_tizen> 3 </since_tizen>
314         EmbeddedSE = 0x01,
315         /// <summary>
316         /// UICC type card emulation (Universal IC Card)
317         /// </summary>
318         /// <since_tizen> 3 </since_tizen>
319         Uicc = 0x02,
320         /// <summary>
321         /// SDCARD card emulation
322         /// </summary>
323         /// <since_tizen> 3 </since_tizen>
324         Sdcard = 0x03,
325         /// <summary>
326         /// Host based card emulation
327         /// </summary>
328         /// <since_tizen> 3 </since_tizen>
329         Hce = 0x04
330     }
331     /// <summary>
332     /// Enumeration for Nfc discovered type.
333     /// </summary>
334     /// <since_tizen> 3 </since_tizen>
335     public enum NfcSecureElementCardEmulationMode
336     {
337         /// <summary>
338         /// Card Emulation mode OFF
339         /// </summary>
340         /// <since_tizen> 3 </since_tizen>
341         Off = 0x00,
342         /// <summary>
343         /// Card Emulation mode ON
344         /// </summary>
345         /// <since_tizen> 3 </since_tizen>
346         On = 0x01
347     }
348     /// <summary>
349     /// Enumeration for SNEP(Simple NDEF Exchange Protocol) event.
350     /// </summary>
351     /// <since_tizen> 3 </since_tizen>
352     public enum NfcSnepEvent
353     {
354         /// <summary>
355         /// server or client stopped
356         /// </summary>
357         /// <since_tizen> 3 </since_tizen>
358         Stop = 0x00,
359         /// <summary>
360         /// server started or client connected
361         /// </summary>
362         /// <since_tizen> 3 </since_tizen>
363         Start = 0x01,
364         /// <summary>
365         /// server received get request
366         /// </summary>
367         /// <since_tizen> 3 </since_tizen>
368         Get = 0x02,
369         /// <summary>
370         /// server received put request
371         /// </summary>
372         /// <since_tizen> 3 </since_tizen>
373         Put = 0x03,
374         /// <summary>
375         /// service registered
376         /// </summary>
377         /// <since_tizen> 3 </since_tizen>
378         Register = 0x04,
379         /// <summary>
380         /// service unregistered
381         /// </summary>
382         /// <since_tizen> 3 </since_tizen>
383         Unregister = 0x05
384     }
385     /// <summary>
386     /// Enumeration for SNEP request type.
387     /// </summary>
388     /// <since_tizen> 3 </since_tizen>
389     public enum NfcSnepRequestType
390     {
391         /// <summary>
392         /// get request
393         /// </summary>
394         /// <since_tizen> 3 </since_tizen>
395         Get = 0x01,
396         /// <summary>
397         /// put request
398         /// </summary>
399         /// <since_tizen> 3 </since_tizen>
400         Put = 0x02
401     }
402     /// <summary>
403     /// Enumeration for NFC Card Emulation Category type.
404     /// </summary>
405     /// <since_tizen> 3 </since_tizen>
406     public enum NfcCardEmulationCategoryType
407     {
408         /// <summary>
409         /// NFC payment services
410         /// </summary>
411         /// <since_tizen> 3 </since_tizen>
412         Payment = 0x01,
413         /// <summary>
414         /// all other card emulation services
415         /// </summary>
416         /// <since_tizen> 3 </since_tizen>
417         Other = 0x02
418     }
419     /// <summary>
420     /// Enumeration for NFC Card Emulation HCE(Host Card Emulation) event type.
421     /// </summary>
422     /// <since_tizen> 3 </since_tizen>
423     public enum NfcHceEvent
424     {
425         /// <summary>
426         /// HCE deactivated
427         /// </summary>
428         /// <since_tizen> 3 </since_tizen>
429         Deactivated = 0x00,
430         /// <summary>
431         /// HCE activated
432         /// </summary>
433         /// <since_tizen> 3 </since_tizen>
434         Activated = 0x01,
435         /// <summary>
436         /// HCE APDU(Application Protocol Data Unit) Received
437         /// </summary>
438         /// <since_tizen> 3 </since_tizen>
439         ApduReceived = 0x02
440     }
441 }