Merge "fixed wrong link page" into tizen_2.1
[platform/framework/native/nfc.git] / inc / FNetNfcNfcTypes.h
1 //
2 // Open Service Platform
3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
4 //
5 // Licensed under the Apache License, Version 2.0 (the License);
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
8 //
9 //     http://www.apache.org/licenses/LICENSE-2.0
10 //
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
16 //
17 /**
18 * @file     FNetNfcNfcTypes.h
19 * @brief    This is the header file for defining types in the %Nfc namespace.
20 *
21 * This header file contains the definition of common types and enumerators for the %NFC features.
22 */
23 #ifndef _FNET_NFC_NFC_TYPES_H_
24 #define _FNET_NFC_NFC_TYPES_H_
25
26 namespace Tizen { namespace Net { namespace Nfc
27 {
28
29 /**
30  * @enum    NfcTagType
31  *
32  * Defines the types of the NFC tag.
33  *
34  * @since   2.0
35  */
36 enum NfcTagType
37 {
38         NFC_TAG_TYPE_UNKNOWN = 0x00,            /**< The unknown tag type
39                                                              * @remarks     This type should not be used for the event filtering
40                                                              *              purpose as the input argument of
41                                                              *              NfcManager::AddTagDiscoveryEventListener().
42                                                              */
43         NFC_TAG_TYPE_ISO14443_3A,               /**< The ISO14443 Part 3A tag type @n
44                                                              * For example, the Mifare UL, the Mifare Classic, and the Mifare DESFire
45                                                              * tags belong to this type.
46                                                              */
47         NFC_TAG_TYPE_ISO14443_3B,               /**< The ISO14443 Part 3B tag type @n
48                                                              * For example, the Picopass 2K/32K tags belong to this type.
49                                                              */
50         NFC_TAG_TYPE_FELICA,                    /**< The FeliCa tag type */
51         NFC_TAG_TYPE_ISO15693,                  /**< The ISO15693 general RFID tag type */
52         NFC_TAG_TYPE_TOPAZ_JEWEL,               /**< The Topaz/Jewel tag type */
53         NFC_TAG_TYPE_MIFARE_UL,                 /**< The Mifare Ultralight/Ultralight C tag type */
54         NFC_TAG_TYPE_MIFARE_CLASSIC,            /**< The Mifare Classic (1K/4K) tag type */
55         NFC_TAG_TYPE_ISO14443_4,                /**< The ISO14443 Part 4 tag type @n
56                                                              * For example, the Mifare DESFire tag belongs to this type.
57                                                              */
58         NFC_TAG_TYPE_FORUM_TYPE_1,              /**< The NFC forum type 1 */
59         NFC_TAG_TYPE_FORUM_TYPE_2,              /**< The NFC forum type 2 */
60         NFC_TAG_TYPE_FORUM_TYPE_3,              /**< The NFC forum type 3 */
61         NFC_TAG_TYPE_FORUM_TYPE_4,              /**< The NFC forum type 4 */
62         NFC_TAG_TYPE_ALL_NDEF_COMPATIBLE = 0xfe, /**< The all NDEF compatible tag type
63                                                              * @remarks     This type should be used only for event filtering as the
64                                                              *              input argument of
65                                                              *              NfcManager::AddTagDiscoveryEventListener().
66                                                              */
67         NFC_TAG_TYPE_ALL = 0xff,                /**< The all tag type
68                                                              * @remarks     This type should be used only for event filtering as the
69                                                              *              input argument of
70                                                              *              NfcManager::AddTagDiscoveryEventListener().
71                                                              */
72 };
73
74 /**
75  * @enum    NdefRecordTypeNameFormat
76  *
77  * Defines the type name formats of the NDEF record.
78  *
79  * @since    2.0
80  */
81 // Refer to NFCForum-TS-NDEF_1.0
82 enum NdefRecordTypeNameFormat
83 {
84         NDEF_TNF_EMPTY = 0x00,                  /**< The empty record type */
85         NDEF_TNF_WELL_KNOWN = 0x01,             /**< The NFC forum defined record type */
86         NDEF_TNF_MIME_MEDIA = 0x02,             /**< The RFC2046 MIME media record type */
87         NDEF_TNF_ABSOLUTE_URI = 0x03,           /**< The absolute URI record type */
88         NDEF_TNF_EXTERNAL = 0x04,               /**< The user-defined record type (application specific) */
89         NDEF_TNF_UNKNOWN = 0x05,                /**< The unknown record type */
90         NDEF_TNF_ALL = 0xff,                    /**< The all record type
91                                                              * @remarks     This type should be used only for event filtering as the
92                                                              *              input argument of
93                                                              *              NfcManager::AddNdefMessageDiscoveryEventListener().
94                                                              */
95 };
96
97 } } } // Tizen::Net::Nfc
98
99 #endif // _FNET_NFC_NFC_TYPES_H_