* @brief This file contains the NFC API.
*/
-#define NFC_ERROR_CLASS TIZEN_ERROR_NFC
+/**
+ * @brief NFC base error codes.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ */
+#define NFC_ERROR_CLASS TIZEN_ERROR_NFC /**< Tizen NFC base error code */
/**
* @brief Error codes reported by the NFC API.
} nfc_error_e;
/**
- * @brief Enumerations for record TNF (Type Name Format)
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @brief Enumerations for record TNF (Type Name Format).
* @details It is indicate format of type field
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_RECORD_MODULE
*/
typedef enum {
/**
- * @brief Enumerations for NFC encode types
+ * @brief Enumerations for NFC encode types.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_RECORD_MODULE
*/
} nfc_encode_type_e;
/**
- * @brief Enumerations for NFC tag types
+ * @brief Enumerations for NFC tag types.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_TAG_MODULE
*/
} nfc_tag_type_e;
/**
- * @brief Enumerations for NFC Tag filter
+ * @brief Enumerations for NFC Tag filter.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*/
} nfc_tag_filter_e;
/**
- * @brief Enumerations for NFC discovered type
+ * @brief Enumerations for NFC discovered type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*/
} nfc_discovered_type_e;
/**
- * @brief Enumerations for NFC Secure Element (SIM/UICC(Universal Integrated Circuit Card)) event
+ * @brief Enumerations for NFC Secure Element (SIM/UICC (Universal Integrated Circuit Card)) event.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*/
} nfc_se_event_e;
/**
- * @brief Enumerations for NFC Secure Element (SIM/UICC(Universal Integrated Circuit Card)) type
+ * @brief Enumerations for NFC Secure Element (SIM/UICC (Universal Integrated Circuit Card)) type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*/
} nfc_se_type_e;
/**
- * @brief Enumerations for NFC Card Emulation Mode type
+ * @brief Enumerations for NFC Card Emulation Mode type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*/
} nfc_se_card_emulation_mode_type_e;
/**
- * @brief Enumerations for SNEP event
+ * @brief Enumerations for SNEP event.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_P2P_MODULE
*/
} nfc_snep_event_e;
/**
- * @brief Enumerations for SNEP request type
+ * @brief Enumerations for SNEP request type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_P2P_MODULE
*/
} nfc_snep_type_e;
/**
- * @brief Enumerations for NFC Card Emulation Category type
+ * @brief Enumerations for NFC Card Emulation Category type.
* @since_tizen 2.3.1
* @ingroup CAPI_NETWORK_NFC_SE_MODULE
*/
} nfc_card_emulation_category_type_e;
/**
- * @brief Enumerations for NFC Card Emulation HCE event type
+ * @brief Enumerations for NFC Card Emulation HCE event type.
* @since_tizen 2.3.1
* @ingroup CAPI_NETWORK_NFC_SE_MODULE
*/
} nfc_hce_event_type_e;
/**
- * @brief The handle to the NDEF record
+ * @brief The handle to the NDEF record.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_RECORD_MODULE
*/
typedef struct _ndef_record_s *nfc_ndef_record_h;
/**
- * @brief The handle to the NDEF message
+ * @brief The handle to the NDEF message.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_MESSAGE_MODULE
*/
typedef struct _ndef_message_s *nfc_ndef_message_h;
/**
- * @brief The handle to the NFC tag
+ * @brief The handle to the NFC tag.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_TAG_MODULE
*/
typedef struct _net_nfc_target_info_s *nfc_tag_h;
/**
- * @brief The handle to NFC p2p target
+ * @brief The handle to NFC p2p target.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_P2P_MODULE
*/
typedef void *nfc_p2p_target_h;
/**
- * @brief The handle to NFC p2p snep instance
+ * @brief The handle to NFC p2p snep instance.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_P2P_MODULE
*/
typedef struct _nfc_p2p_snep_s *nfc_p2p_snep_h;
/**
- * @brief The handle to NFC secure element instance
+ * @brief The handle to NFC secure element instance.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_SE_MODULE
*/
/**
* @brief The default factory key.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @details The key is 0xff, 0xff, 0xff, 0xff, 0xff, 0xff
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_TAG_MIFARE_MODULE
*/
extern const unsigned char NFC_TAG_MIFARE_KEY_DEFAULT[6];
/**
* @brief The well-known key for tags formatted according to the MIFARE Application Directory (MAD) specification.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @details The key is 0xA0, 0xA1, 0xA2, 0xA3, 0xA4, 0xA5
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_TAG_MIFARE_MODULE
*/
extern const unsigned char NFC_TAG_MIFARE_KEY_APPLICATION_DIRECTORY[6];
/**
* @brief The well-known key for tags formatted according to the NDEF on Mifare Classic specification.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @details The key is 0xD3, 0xF7, 0xD3, 0xF7, 0xD3, 0xF7
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_TAG_MIFARE_MODULE
*/
extern const unsigned char NFC_TAG_MIFARE_KEY_NFC_FORUM[6];
/**
- * @brief RTD(Record type definition) Type - Smart Poster type.
+ * @brief RTD (Record type definition) Type - Smart Poster type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_RECORD_MODULE
*/
extern const unsigned char NFC_RECORD_SMART_POSTER_TYPE[2];
/**
- * @brief RTD(Record type definition) Type - Text type.
+ * @brief RTD (Record type definition) Type - Text type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_RECORD_MODULE
*/
extern const unsigned char NFC_RECORD_TEXT_TYPE[1];
/**
- * @brief RTD(Record type definition) Type - URI type.
+ * @brief RTD (Record type definition) Type - URI type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_RECORD_MODULE
*/
extern const unsigned char NFC_RECORD_URI_TYPE[1];
/**
- * @brief RTD(Record type definition) Type - Alternative Carrier type.
+ * @brief RTD (Record type definition) Type - Alternative Carrier type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_RECORD_MODULE
*/
extern const unsigned char NFC_RECORD_ALTERNATIVE_CARRIER_TYPE[2];
/**
- * @brief RTD(Record type definition) Type - Handover Carrier type.
+ * @brief RTD (Record type definition) Type - Handover Carrier type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_RECORD_MODULE
*/
extern const unsigned char NFC_RECORD_HANDOVER_CARRIER_TYPE[2];
/**
- * @brief RTD(Record type definition) Type - Handover Request type.
+ * @brief RTD (Record type definition) Type - Handover Request type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_RECORD_MODULE
*/
extern const unsigned char NFC_RECORD_HANDOVER_REQUEST_TYPE[2];
/**
- * @brief RTD(Record type definition) Type - Handover Select type.
+ * @brief RTD (Record type definition) Type - Handover Select type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_RECORD_MODULE
*/
extern const unsigned char NFC_RECORD_HANDOVER_SELECT_TYPE[2];
/**
+ * @platform
* @brief Called after nfc_manager_set_activation() has completed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @platform
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*
- * @param [in] error The result
- * @param [in] user_data The user data passed from the callback registration function
+ * @param[in] error The result
+ * @param[in] user_data The user data passed from the callback registration function
+ *
+ * @return 0 on success, otherwise a negative error value.
+ * @retval #NFC_ERROR_NONE Successful
*
* @see nfc_manager_set_activation()
+ * @see #nfc_tag_transceive
*/
typedef void (*nfc_activation_completed_cb)(nfc_error_e error, void *user_data);
/**
- * @brief Called when nfc activation state is changed.
+ * @brief Called when NFC activation state is changed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*
- * @param [in] activated The activation state
- * @param [in] user_data The user data passed from the callback registration function
+ * @param[in] activated The activation state
+ * @param[in] user_data The user data passed from the callback registration function
+ *
+ * @return 0 on success, otherwise a negative error value.
+ * @retval #NFC_ERROR_NONE Successful
+ * @retval #NFC_ERROR_ALREADY_ACTIVATED Already activated
+ * @retval #NFC_ERROR_ALREADY_DEACTIVATED Already deactivated
*
* @see nfc_manager_set_activation_changed_cb()
*/
typedef void (*nfc_activation_changed_cb)(bool activated , void *user_data);
/**
- * @brief Called when an NFC tag appears or disappears
+ * @brief Called when an NFC tag appears or disappears.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*
- * @remarks The tag handle does not have detail target info when an NFC tag disappeared.\n
- * So then do not use tag functions which use tag handle.
+ * @remarks The @a tag should not be released.
+ * @remarts The @a tag is managed by the platform and will be released when NFC service stops.
+ * @remarks The tag handle does not have detail target info when an NFC tag disappeared.\n
+ * So then do not use tag functions which use tag handle.
*
- * @param [in] type The discovered type attached or detached
- * @param [in] tag The handle to NFC tag
- * @param [in] user_data The user data passed from the callback registration function
+ * @param[in] type The discovered type attached or detached
+ * @param[in] tag The handle to NFC tag
+ * @param[in] user_data The user data passed from the callback registration function
*
* @see nfc_manager_set_tag_discovered_cb()
* @see nfc_manager_unset_tag_discovered_cb()
typedef void (*nfc_tag_discovered_cb)(nfc_discovered_type_e type, nfc_tag_h tag, void *user_data);
/**
- * @brief Called when an NDEF Message is discovered
+ * @brief Called when an NDEF Message is discovered.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*
+ * @remarks The @a message should not be released.
+ * @remarks The @a message can be used only in the callback. To use outside, make a copy.
* @remarks @a message will be automatically destroyed when the callback function returns. (Do not release @a message.)
*
- * @param [in] message The handle to NDEF message
- * @param [in] user_data The user data passed from the callback registration function
+ * @param[in] message The handle to NDEF message
+ * @param[in] user_data The user data passed from the callback registration function
*
* @see nfc_manager_set_ndef_discovered_cb()
* @see nfc_manager_unset_ndef_discovered_cb()
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_TAG_MODULE
*
+ * @remarks The @a key should not be released.
+ * @remarks The @a key can be used only in the callback. To use outside, make a copy.
+ * @remarks The @a value should not be released.
+ * @remarks The @a value can be used only in the callback. To use outside, make a copy.
* @remarks @a key and value will be automatically destroyed when the callback function returns. (Do not release @a key and value.)
*
* @param[in] key The key of information
* @return @c true to continue with the next iteration of the loop, \n @c false to break out of the loop.
* @pre nfc_tag_foreach_information() invokes this callback.
*
- * @see nfc_tag_foreach_information()
+ * @see nfc_tag_foreach_information()
*/
typedef bool (*nfc_tag_information_cb)(const char *key, const unsigned char *value, int value_size, void *user_data);
*
* @remarks @a buffer will be automatically destroyed when the callback function returns. (Do not release @a buffer.)
*
- * @param [in] result The result of function call
- * @param [in] buffer The result data
- * @param [in] buffer_size The size of buffer in bytes
- * @param [in] user_data The user data passed from nfc_tag_transceive()
+ * @param[in] result The result of function call #NFC_ERROR_NONE Success \n
+ * otherwise negative values \n
+ * @param[in] buffer The result data
+ * @param[in] buffer_size The size of buffer in bytes
+ * @param[in] user_data The user data passed from nfc_tag_transceive()
*
* @see nfc_tag_transceive()
*/
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_TAG_MODULE
*
- * @param [in] result The result of function call
- * @param [in] user_data The user data passed from nfc_manager_initialize()
+ * @param[in] result The result of function call #NFC_ERROR_NONE Success \n
+ * otherwise negative values \n
+ * @param[in] user_data The user data passed from nfc_manager_initialize()
*
* @see nfc_tag_write_ndef()
*/
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_TAG_MODULE
*
+ * @remarks The @a message should not be released.
+ * @remarks The @a message can be used only in the callback. To use outside, make a copy.
* @remarks @a message will be automatically destroyed when the callback function returns. (Do not release @a message.)
*
- * @param [in] result The result of function call
- * @param [in] message The NDEF message
- * @param [in] user_data The user data passed from nfc_tag_read_ndef()
+ * @param[in] result The result of function call #NFC_ERROR_NONE Success \n
+ * otherwise negative values \n
+ * @param[in] message The NDEF message
+ * @param[in] user_data The user data passed from nfc_tag_read_ndef()
*
* @see nfc_tag_read_ndef()
*/
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_TAG_MODULE
*
- * @param [in] result The result of function call
- * @param [in] user_data The user data passed from nfc_tag_format_ndef()
+ * @param[in] result The result of function call #NFC_ERROR_NONE Success \n
+ * otherwise negative values \n
+ * @param[in] user_data The user data passed from nfc_tag_format_ndef()
*
* @see nfc_tag_format_ndef()
*/
/**
- * @brief Called after nfc_mifare_authenticate_with_keyA() has completed
+ * @brief Called after nfc_mifare_authenticate_with_keyA() has completed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_TAG_MIFARE_MODULE
*
- * @param [in] result The result of nfc_mifare_authenticate_with_keyA()
- * @param [in] user_data The user data passed from nfc_mifare_authenticate_with_keyA()
+ * @param[in] result The result of nfc_mifare_authenticate_with_keyA()
+ * @param[in] user_data The user data passed from nfc_mifare_authenticate_with_keyA()
*
* @see nfc_mifare_authenticate_with_keyA()
*/
typedef void (*nfc_mifare_authenticate_with_keyA_completed_cb)(nfc_error_e result, void *user_data);
/**
- * @brief Called after nfc_mifare_authenticate_with_keyB() has completed
+ * @brief Called after nfc_mifare_authenticate_with_keyB() has completed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_TAG_MIFARE_MODULE
*
- * @param [in] result The result of function call
- * @param [in] user_data The user data passed from nfc_mifare_authenticate_with_keyB()
+ * @param[in] result The result of function call #NFC_ERROR_NONE Success \n
+ * otherwise negative values \n
+ * @param[in] user_data The user data passed from nfc_mifare_authenticate_with_keyB()
*
* @see nfc_mifare_authenticate_with_keyB()
*/
typedef void (*nfc_mifare_authenticate_with_keyB_completed_cb)(nfc_error_e result, void *user_data);
/**
- * @brief Called after nfc_mifare_write_block() has completed
+ * @brief Called after nfc_mifare_write_block() has completed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_TAG_MIFARE_MODULE
*
- * @param [in] result The result of nfc_mifare_write_block()
- * @param [in] user_data The user data passed from nfc_mifare_write_block()
+ * @param[in] result The result of nfc_mifare_write_block() #NFC_ERROR_NONE Success \n
+ * otherwise negative values \n
+ * @param[in] user_data The user data passed from nfc_mifare_write_block()
*
* @see nfc_mifare_write_block()
*/
typedef void (*nfc_mifare_write_block_completed_cb)(nfc_error_e result, void *user_data);
/**
- * @brief Called after nfc_mifare_write_page() has completed
+ * @brief Called after nfc_mifare_write_page() has completed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_TAG_MIFARE_MODULE
*
- * @param [in] result The result of function call
- * @param [in] user_data The user data passed from nfc_mifare_write_page()
+ * @param[in] result The result of function call #NFC_ERROR_NONE Success \n
+ * otherwise negative values \n
+ * @param[in] user_data The user data passed from nfc_mifare_write_page()
*
* @see nfc_mifare_write_page()
*/
typedef void (*nfc_mifare_write_page_completed_cb)(nfc_error_e result, void *user_data);
/**
- * @brief Called after nfc_mifare_read_block() has completed
+ * @brief Called after nfc_mifare_read_block() has completed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_TAG_MIFARE_MODULE
*
+ * @remarks The @a buffer should not be released.
+ * @remarks The @a buffer can be used only in the callback. To use outside, make a copy.
* @remarks @a buffer will be automatically destroyed when the callback function returns. (Do not release @a buffer.)
*
- * @param [in] result The result of function call
- * @param [in] buffer The read buffer
- * @param [in] size The size of buffer in bytes
- * @param [in] user_data The user data passed from nfc_mifare_read_block()
+ * @param[in] result The result of function call #NFC_ERROR_NONE Success \n
+ * otherwise negative values \n
+ * @param[in] buffer The read buffer
+ * @param[in] buffer_size The size of buffer in bytes
+ * @param[in] user_data The user data passed from nfc_mifare_read_block()
*
* @see nfc_mifare_read_block()
*/
-typedef void (*nfc_mifare_read_block_completed_cb)(nfc_error_e result, unsigned char *buffer, int bufer_size, void *user_data);
+typedef void (*nfc_mifare_read_block_completed_cb)(nfc_error_e result, unsigned char *buffer, int buffer_size, void *user_data);
/**
- * @brief Called after nfc_mifare_read_page() has completed
+ * @brief Called after nfc_mifare_read_page() has completed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_TAG_MIFARE_MODULE
*
+ * @remarks The @a buffer should not be released.
+ * @remarks The @a buffer can be used only in the callback. To use outside, make a copy.
* @remarks @a buffer will be automatically destroyed when the callback function returns. (Do not release @a buffer.)
*
- * @param [in] result The result of nfc_mifare_read_page()
- * @param [in] buffer The read buffer
- * @param [in] size The size of read buffer in bytes
- * @param [in] user_data The user data passed from nfc_mifare_read_page()
+ * @param[in] result The result of nfc_mifare_read_page() #NFC_ERROR_NONE Success \n
+ * otherwise negative values \n
+ * @param[in] buffer The read buffer
+ * @param[in] buffer_size The size of read buffer in bytes
+ * @param[in] user_data The user data passed from nfc_mifare_read_page()
*
* @see nfc_mifare_read_page()
*/
-typedef void (*nfc_mifare_read_page_completed_cb)(nfc_error_e result, unsigned char *buffer, int bufer_size, void *user_data);
+typedef void (*nfc_mifare_read_page_completed_cb)(nfc_error_e result, unsigned char *buffer, int buffer_size, void *user_data);
/**
- * @brief Called after nfc_mifare_increment() has completed
+ * @brief Called after nfc_mifare_increment() has completed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_TAG_MIFARE_MODULE
*
- * @param [in] result The result of nfc_mifare_increment()
- * @param [in] user_data The user data passed from nfc_mifare_increment()
+ * @param[in] result The result of nfc_mifare_increment() #NFC_ERROR_NONE Success \n
+ * otherwise negative values \n
+ * @param[in] user_data The user data passed from nfc_mifare_increment()
*
* @see nfc_mifare_increment()
*/
typedef void (*nfc_mifare_increment_completed_cb)(nfc_error_e result, void *user_data);
/**
- * @brief Called after nfc_mifare_decrement() has completed
+ * @brief Called after nfc_mifare_decrement() has completed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_TAG_MIFARE_MODULE
*
- * @param [in] result The result of nfc_mifare_decrement()
- * @param [in] user_data The user data passed from nfc_mifare_decrement()
+ * @param[in] result The result of nfc_mifare_decrement() #NFC_ERROR_NONE Success \n
+ * otherwise negative values \n
+ * @param[in] user_data The user data passed from nfc_mifare_decrement()
*
* @see nfc_mifare_decrement()
*/
typedef void (*nfc_mifare_decrement_completed_cb)(nfc_error_e result, void *user_data);
/**
- * @brief Called after nfc_mifare_transfer() has completed
+ * @brief Called after nfc_mifare_transfer() has completed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_TAG_MIFARE_MODULE
*
- * @param [in] result The result of nfc_mifare_transfer()
- * @param [in] user_data The user data passed from nfc_mifare_transfer()
+ * @param[in] result The result of nfc_mifare_transfer() #NFC_ERROR_NONE Success \n
+ * otherwise negative values \n
+ * @param[in] user_data The user data passed from nfc_mifare_transfer()
*
* @see nfc_mifare_transfer()
*/
typedef void (*nfc_mifare_transfer_completed_cb)(nfc_error_e result, void *user_data);
/**
- * @brief Called after nfc_mifare_restore() has completed
+ * @brief Called after nfc_mifare_restore() has completed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_TAG_MIFARE_MODULE
*
- * @param [in] result The result of nfc_mifare_restore()
- * @param [in] user_data The user data passed from nfc_mifare_restore()
+ * @param[in] result The result of nfc_mifare_restore() #NFC_ERROR_NONE Success \n
+ * otherwise negative values \n
+ * @param[in] user_data The user data passed from nfc_mifare_restore()
*
* @see nfc_mifare_restore()
*/
/**
- * @brief Called when NFC peer-to-peer target appeared or disappeared
+ * @brief Called when NFC peer-to-peer target appeared or disappeared.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*
- * @param [in] type The discovered type attached or detached
- * @param [in] target The handle to p2p target
- * @param [in] user_data The user data passed from nfc_manager_set_p2p_target_discovered_cb()
+ * @remarks The @a target should not be released.
+ * @remarks The @a target can be used only in the callback. To use outside, make a copy.
+ *
+ * @param[in] type The discovered type attached or detached
+ * @param[in] target The handle to p2p target
+ * @param[in] user_data The user data passed from nfc_manager_set_p2p_target_discovered_cb()
*
* @see nfc_manager_set_p2p_target_discovered_cb()
* @see nfc_manager_unset_p2p_target_discovered_cb()
typedef void (*nfc_p2p_target_discovered_cb)(nfc_discovered_type_e type, nfc_p2p_target_h target, void *user_data);
/**
- * @brief Called when receiving Secure Element (SIM/UICC(Universal Integrated Circuit Card)) event.
+ * @brief Called when receiving Secure Element (SIM/UICC (Universal Integrated Circuit Card)) event.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*
- * @param [in] event The Secure Element event
- * @param [in] user_data The user data passed from nfc_manager_set_se_event_cb()
+ * @param[in] event The Secure Element event @see #nfc_se_event_e
+ * @param[in] user_data The user data passed from nfc_manager_set_se_event_cb()
*
* @see nfc_manager_set_se_event_cb()
* @see nfc_manager_unset_se_event_cb()
/**
- * @brief Called when receiving Secure Element(SIM/UICC(Universal Integrated Circuit Card)) transaction event data
+ * @brief Called when receiving Secure Element(SIM/UICC (Universal Integrated Circuit Card)) transaction event data.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks This event notifies , external reader tries to access secure element.
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*
- * @param [in] se type
- * @param [in] aid Application Id, specified in ISO/IEC 7816-4
- * @param [in] aid_size The size of aid (5~16)
- * @param [in] param The parameter list, specified in ISO/IEC 8825-1
- * @param [in] param The size of param (0~65535)
- * @param [in] user_data The user data passed from nfc_manager_set_se_transaction_event_cb()
+ * @remarks The @a aid should not be released.
+ * @remarks The @a aid can be used only in the callback. To use outside, make a copy.
+ * @remarks The @a param should not be released.
+ * @remarks The @a param can be used only in the callback. To use outside, make a copy.
+ *
+ * @param[in] se_type Secure Element type
+ * @param[in] aid Application Id, specified in ISO/IEC 7816-4
+ * @param[in] aid_size The size of aid (5~16)
+ * @param[in] param The parameter list, specified in ISO/IEC 8825-1
+ * @param[in] param_size The size of param (0~65535)
+ * @param[in] user_data The user data passed from nfc_manager_set_se_transaction_event_cb()
*
* @see nfc_manager_set_se_transaction_event_cb()
* @see nfc_manager_unset_se_transaction_event_cb()
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_P2P_MODULE
*
- * @param [in] result The result of function call
- * @param [in] user_data The user data passed from nfc_p2p_send()
+ * @param[in] result The result of function call #NFC_ERROR_NONE Success \n
+ * otherwise negative values \n
+ * @param[in] user_data The user data passed from nfc_p2p_send()
*
* @see nfc_p2p_send()
*/
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_P2P_MODULE
*
+ * @remarks The @a target should not be released.
+ * @remarks The @a target can be used only in the callback. To use outside, make a copy.
+ * @remarks The @a message should not be released.
+ * @remarks The @a message can be used only in the callback. To use outside, make a copy.
* @remarks @a message will be automatically destroyed when the callback function returns. (Do not release @a message.)
*
- * @param [in] target The handle to p2p target
- * @param [in] message The received message
- * @param [in] user_data The user data passed from nfc_p2p_set_recv_cb()
+ * @param[in] target The handle to p2p target
+ * @param[in] message The received message
+ * @param[in] user_data The user data passed from nfc_p2p_set_recv_cb()
*
* @see nfc_p2p_set_data_received_cb()
* @see nfc_p2p_unset_data_received_cb()
typedef void (*nfc_p2p_data_received_cb)(nfc_p2p_target_h target, nfc_ndef_message_h message, void *user_data);
/**
- * @brief Called when SNEP event is raised
+ * @brief Called when SNEP event is raised.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_P2P_MODULE
*
- * @param [in] handle The handle of current snep instance
- * @param [in] event The kind of snep event
- * @param [in] result The result of snep event
- * @param [in] msg The ndef message which received from client or result of get request
- * @param [in] user_data The user data passed from snep apis.
+ * @remarks The @a handle should not be released.
+ * @remarks The @a handle can be used only in the callback. To use outside, make a copy.
+ * @remarks The @a msg should not be released.
+ * @remarks The @a msg can be used only in the callback. To use outside, make a copy.
+ *
+ * @param[in] handle The handle of current snep instance
+ * @param[in] event The kind of snep event
+ * @param[in] result The result of snep event #NFC_ERROR_NONE Success \n
+ * otherwise negative values \n
+ * @param[in] msg The NDEF message which received from client or result of get request
+ * @param[in] user_data The user data passed from snep functions.
*
* @see nfc_snep_start_server()
* @see nfc_snep_send_client_request()
nfc_ndef_message_h msg, void *user_data);
/**
- * @brief Called when receiving HCE(Host Card Emulation) event.
+ * @brief Called when receiving HCE (Host Card Emulation) event.
* @since_tizen 2.3.1
* @ingroup CAPI_NETWORK_NFC_SE_MODULE
- * @remarks If the event type is NFC_HCE_EVENT_DEACTIVATED or NFC_HCE_EVENT_ACTIVATED, then apdu and apdu_len is NULL and 0.
*
- * @param [in] handle The handle of connected secure element
- * @param [in] event The HCE event type
- * @param [in] apdu The bytes array of apdu command data
- * @param [in] apdu_len The size of apdu command bytes array
- * @param [in] user_data The user data passed from nfc_manager_set_hce_event_cb()
+ * @remarks The @a handle can be used only in the callback. To use outside, make a copy.
+ * @remarks The @a apdu should not be released.
+ * @remarks The @a apdu can be used only in the callback. To use outside, make a copy.
+ * @remarks If the event type is #NFC_HCE_EVENT_DEACTIVATED or #NFC_HCE_EVENT_ACTIVATED, then apdu and apdu_len is NULL and 0.
+ *
+ * @param[in] handle The handle of connected secure element
+ * @param[in] event The HCE event type
+ * @param[in] apdu The bytes array of apdu command data
+ * @param[in] apdu_len The size of apdu command bytes array
+ * @param[in] user_data The user data passed from nfc_manager_set_hce_event_cb()
*
* @see nfc_manager_set_hce_event_cb()
* @see nfc_manager_unset_hce_event_cb()
* @since_tizen 2.3.1
* @ingroup CAPI_NETWORK_NFC_SE_MODULE
*
- * @param [in] se_type The type of Secure Element
- * @param [in] aid Application Id, specified in ISO/IEC 7816-4
- * @param [in] read_only @c true an aid is on read only mode, otherwise @c false
- * @param [in] user_data The user data passed from the foreach function
+ * @remarks The @a aid can be used only in the callback. To use outside, make a copy.
+ *
+ * @param[in] se_type The type of Secure Element
+ * @param[in] aid Application Id, specified in ISO/IEC 7816-4
+ * @param[in] read_only @c true an aid is on read only mode, otherwise @c false
+ * @param[in] user_data The user data passed from the foreach function
*
* @see nfc_se_foreach_registered_aids()
*/
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*
* @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- * @remarks This function can executed Regardless of nfc_manager_initialize state.
+ * @remarks This function can executed Regardless of (nfc_manager_initialize) state.
*
* @return true on NFC supported, otherwise false
* @exception #NFC_ERROR_NONE Success
bool nfc_manager_is_supported(void);
/**
- * @brief Set NFC Activation state changed callback
+ * @brief Sets NFC Activation state changed callback.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*
- * @param [in] callback The callback function to invoke when activation state is changed.
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] callback The callback function to invoke when activation state is changed.
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
int nfc_manager_set_activation_changed_cb(nfc_activation_changed_cb callback , void *user_data);
/**
- * @brief Unregisters the callback function.
+ * @brief Unsets the callback function.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*
void nfc_manager_unset_activation_changed_cb(void);
/**
- * @brief Sets NFC Activation
+ * @platform
+ * @brief Sets NFC Activation.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/nfc.admin
- * @platform
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
- * @param [in] activation The NFC state for setting
- * @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback function
- *
- * @post It invokes nfc_activation_completed_cb() when it has completed to set activation.\n
- * The Callback can receive error code when process is done.
+ * @param[in] activation The NFC state for setting
+ * @param[in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_ALREADY_DEACTIVATED Already deactivated
* @retval #NFC_ERROR_OUT_OF_MEMORY Out of memory
* @retval #NFC_ERROR_OPERATION_FAILED Operation fail
+ * @retval #NFC_ERROR_PERMISSION_DENIED Permission denied
+ *
+ * @post It invokes nfc_activation_completed_cb() when it has completed to set activation.\n
+ * The Callback can receive error code when process is done.
*
* @see nfc_manager_is_activated()
* @see nfc_activation_completed_cb()
int nfc_manager_set_activation(bool activation, nfc_activation_completed_cb callback, void *user_data);
/**
- * @brief Gets NFC Activation state
+ * @brief Gets NFC Activation state.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
* @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- * @remarks This function can executed Regardless of nfc_manager_initialize state.
+ * @remarks This function can executed Regardless of (nfc_manager_initialize) state.
*
* @return true on NFC activated, otherwise false
* @exception #NFC_ERROR_NONE Success
* @brief Initializes NFC Manager.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
- * @remarks This function must be called before proceeding any other nfc functions\n
- * When an application crashes or exits without the deinitialization. NFC manager automatically deinitializes the process itself.\n
+ * @remarks This function must be called before proceeding any other NFC functions\n
+ * When an application crashes or exits without the deinitialization. NFC manager automatically deinitializes the process itself.\n
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
int nfc_manager_deinitialize(void);
/**
- * @brief Registers a callback function for receiving tag discovered notification.
+ * @brief Sets a callback function for receiving tag discovered notification.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*
- * @param [in] callback The callback function called when a tag is appeared or disappeared
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] callback The callback function called when a tag is appeared or disappeared
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_NOT_SUPPORTED Not supported NFC
* @retval #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
- * @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see nfc_manager_unset_tag_discovered_cb()
* @see nfc_tag_discovered_cb()
int nfc_manager_set_tag_discovered_cb(nfc_tag_discovered_cb callback, void *user_data);
/**
- * @brief Unregisters the callback function.
+ * @brief Unsets the callback function.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*
void nfc_manager_unset_tag_discovered_cb(void);
/**
- * @brief Registers a callback function for receiving NDEF Message discovered notification
+ * @brief Sets a callback function for receiving NDEF Message discovered notification.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*
- * @param [in] callback The callback function called when NDEF Message is discovered
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] callback The callback function called when NDEF Message is discovered
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_NOT_SUPPORTED Not supported NFC
* @retval #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
- * @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see nfc_manager_unset_ndef_discovered_cb()
* @see nfc_ndef_discovered_cb()
int nfc_manager_set_ndef_discovered_cb(nfc_ndef_discovered_cb callback, void *user_data);
/**
- * @brief Unregisters the callback function.
+ * @brief Unsets the callback function.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*
* @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
*
+ * @return 0 on success, otherwise a negative error value.
* @exception #NFC_ERROR_NONE Success
* @exception #NFC_ERROR_NOT_SUPPORTED Not supported NFC
* @exception #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
void nfc_manager_unset_ndef_discovered_cb(void);
/**
- * @brief Registers a callback function for receiving NFC peer-to-peer target discovered notification.
+ * @brief Sets a callback function for receiving NFC peer-to-peer target discovered notification.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*
- * @param [in] callback The callback function called when NFC peer-to-peer target is discovered
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] callback The callback function called when NFC peer-to-peer target is discovered
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_NOT_SUPPORTED Not supported NFC
* @retval #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
- * @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see nfc_manager_unset_ndef_discovered_cb()
* @see nfc_p2p_target_discovered_cb()
int nfc_manager_set_p2p_target_discovered_cb(nfc_p2p_target_discovered_cb callback, void *user_data);
/**
- * @brief Unregisters the callback function.
+ * @brief Unsets the callback function.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*
* @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
*
+ * @return 0 on success, otherwise a negative error value.
* @exception #NFC_ERROR_NONE Success
* @exception #NFC_ERROR_NOT_SUPPORTED Not supported NFC
* @exception #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
/**
- * @brief Registers a callback function for receiving Secure Element (SIM/UICC(Universal Integrated Circuit Card)) event.
+ * @brief Sets a callback function for receiving Secure Element (SIM/UICC (Universal Integrated Circuit Card)) event.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*
- * @param [in] callback The callback function called when occurred Secure Element (SIM/UICC(Universal Integrated Circuit Card)) event.
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] callback The callback function called when occurred Secure Element (SIM/UICC (Universal Integrated Circuit Card)) event.
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_NOT_SUPPORTED Not supported NFC
* @retval #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
- * @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see nfc_se_event_cb()
* @see nfc_manager_unset_se_event_cb()
int nfc_manager_set_se_event_cb(nfc_se_event_cb callback, void *user_data);
/**
- * @brief Unregisters the callback function.
+ * @brief Unsets the callback function.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*
* @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
*
+ * @return 0 on success, otherwise a negative error value.
* @exception #NFC_ERROR_NONE Success
* @exception #NFC_ERROR_NOT_SUPPORTED Not supported NFC
* @exception #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
void nfc_manager_unset_se_event_cb(void);
/**
- * @brief Registers a callback function for receiving Secure Element (SIM/UICC(Universal Integrated Circuit Card)) transaction event(#NFC_SE_EVENT_TRANSACTION) data.
+ * @brief Sets a callback function for receiving Secure Element (SIM/UICC (Universal Integrated Circuit Card)) transaction event(#NFC_SE_EVENT_TRANSACTION) data.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*
- * @param [in] se_type The type of secure element.
- * @param [in] callback The callback function called when occurred SE transaction event.
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] se_type The type of secure element.
+ * @param[in] callback The callback function called when occurred SE transaction event.
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_NOT_SUPPORTED Not supported NFC
* @retval #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
- * @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see nfc_se_transaction_event_cb()
* @see nfc_manager_unset_se_transaction_event_cb()
int nfc_manager_set_se_transaction_event_cb(nfc_se_type_e se_type, nfc_se_transaction_event_cb callback, void *user_data);
/**
- * @brief Unregisters the callback function.
+ * @brief Unsets the callback function.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
- *
- * @param [in] se_type The type of secure element.
- *
* @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
*
+ * @param[in] se_type The type of secure element.
+ *
+ * @return 0 on success, otherwise a negative error value.
* @exception #NFC_ERROR_NONE Success
* @exception #NFC_ERROR_NOT_SUPPORTED Not supported NFC
* @exception #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
+ * @exception #NFC_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see nfc_se_transaction_event_cb()
* @see nfc_manager_set_se_transaction_event_cb()
void nfc_manager_unset_se_transaction_event_cb(nfc_se_type_e se_type);
/**
- * @brief Registers a callback function for receiving HCE(Host Card Emulation) event.
+ * @brief Sets a callback function for receiving HCE (Host Card Emulation) event.
* @since_tizen 2.3.1
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc.cardemulation
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*
- * @param [in] callback The callback function called when HCE(Host Card Emulation) event occurred.
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] callback The callback function called when HCE (Host Card Emulation) event occurred.
+ * @param[in] user_data The user data to be passed to the callback function
*
+ * @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_NOT_SUPPORTED Not supported NFC
* @retval #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
- * @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #NFC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #NFC_ERROR_PERMISSION_DENIED Permission denied
*
* @see nfc_hce_event_cb()
* @see nfc_manager_unset_hce_event_cb()
int nfc_manager_set_hce_event_cb(nfc_hce_event_cb callback, void *user_data);
/**
- * @brief Unregisters the callback function.
+ * @brief Unsets the callback function.
* @since_tizen 2.3.1
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc.cardemulation
*
* @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
*
+ * @return 0 on success, otherwise a negative error value.
* @exception #NFC_ERROR_NONE Success
* @exception #NFC_ERROR_NOT_SUPPORTED Not supported NFC
* @exception #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
- * @exception #NFC_ERROR_PERMISSION_DENIED Permission denied
+ * @exception #NFC_ERROR_PERMISSION_DENIED Permission denied
*
* @see nfc_hce_event_cb()
* @see nfc_manager_set_hce_event_cb()
void nfc_manager_unset_hce_event_cb(void);
/**
- * @brief give the priority to the foreground application when dispatching transaction event.
+ * @brief Gives the priority to the foreground application when dispatching transaction event.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc.cardemulation
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
* @remarks This function must be called only when the application is in the foreground. \n
- * If the application go out from foreground, application must call "nfc_manager_disable_transaction_fg_dispatch" to disable foreground dispatch \n\n
+ * If the application go out from foreground, application must call "nfc_manager_disable_transaction_fg_dispatch" to disable foreground dispatch \n\n
* @remarks Security level can be determined by the manufacturer usage.\n
* If a security issue is occurred, contact with the manufacturer of the product.\n
* If you want to know about security level in detail, See the GSMA specification.\n
* @retval #NFC_ERROR_DEVICE_BUSY Device is too busy to handle your request
* @retval #NFC_ERROR_SECURITY_RESTRICTED Security restricted by Access Control
* @retval #NFC_ERROR_ILLEGAL_STATE Illegal state
- * @retval #NFC_ERROR_OPERATION_FAILED IPC fail
+ * @retval #NFC_ERROR_OPERATION_FAILED IPC fail
*
* @see nfc_manager_disable_transaction_fg_dispatch()
* @see nfc_manager_initialize()
int nfc_manager_enable_transaction_fg_dispatch(void);
/**
- * @brief disable foreground dispatch for "EVT_TRANSACTION" to the given application.
+ * @brief Disables foreground dispatch for "EVT_TRANSACTION" to the given application.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc.cardemulation
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
- * @remarks After calling "nfc_manager_enable_transaction_fg_dispatch", an application must call this api when it goes out from foreground. \n\n
+ * @remarks After calling "nfc_manager_enable_transaction_fg_dispatch", an application must call this function when it goes out from foreground. \n\n
* @remarks Security level can be determined by the manufacturer usage.\n
* If a security issue is occurred, contact with the manufacturer of the product.\n
* If you want to know about security level in detail, See the GSMA specification.\n
* @retval #NFC_ERROR_DEVICE_BUSY Device is too busy to handle your request
* @retval #NFC_ERROR_SECURITY_RESTRICTED Security restricted by Access Control
* @retval #NFC_ERROR_ILLEGAL_STATE Illegal state
- * @retval #NFC_ERROR_OPERATION_FAILED IPC fail
+ * @retval #NFC_ERROR_OPERATION_FAILED IPC fail
*
* @see nfc_manager_enable_transaction_fg_dispatch()
* @see nfc_manager_initialize()
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*
- * @remarks This function is used to get the ndef message that was read before launched your application.
- * @param [out] ndef_message The cached NDEF message
+ * @remarks The @a ndef_message should be released using nfc_ndef_message_destroy().
+ * @remarks This function is used to get the NDEF message that was read before launched your application.
+ * @param[out] ndef_message The cached NDEF message
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @brief Sets filter of target types.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
- * @remarks Bit operator OR(|) can be used in the configure parameter (like NFC_TAG_FILTER_ISO14443A_ENABLE | NFC_TAG_FILTER_ISO14443B_ENABLE)
+ * @remarks Bit operator OR(|) can be used in the configure parameter (like #NFC_TAG_FILTER_ISO14443A_ENABLE | #NFC_TAG_FILTER_ISO14443B_ENABLE)
* or you may choose "NFC_TAG_ALL_ENABLE" enum value to get all result.
* It prevent getting tag types from RF level.
- * If the client api does call this function, default is always NFC_TAG_ALL_ENABLE.
- *
- * @param [in] filter The filter value with bits operation #nfc_tag_filter_e
- *
+ * If the client function does call this function, default is always NFC_TAG_ALL_ENABLE.
* @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
*
+ * @param[in] filter The filter value with bits operation #nfc_tag_filter_e
+ *
+ * @return 0 on success, otherwise a negative error value.
* @exception #NFC_ERROR_NONE Success
* @exception #NFC_ERROR_NOT_SUPPORTED Not supported NFC
* @exception #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*
* @remarks Bit operation OR(|) is used in return data\n
- * The default value is NFC_TAG_FILTER_ALL_ENABLE
+ * The default value is #NFC_TAG_FILTER_ALL_ENABLE
* @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
*
* @return The filter which is set #nfc_tag_filter_e
*
- * @exception #NFC_ERROR_NONE Success
- * @exception #NFC_ERROR_NOT_SUPPORTED Not supported NFC
- * @exception #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
+ * @return 0 on success, otherwise a negative error value.
+ * @retval #NFC_ERROR_NONE Success
+ * @retval #NFC_ERROR_NOT_SUPPORTED Not supported NFC
+ * @retval #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
*
* @see nfc_manager_set_tag_filter()
* @see nfc_manager_initialize()
* @privilege %http://tizen.org/privilege/nfc
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*
- * @param [out] tag The connected tag
+ * @remarks The @a tag should not be released.
+ * @remarts The @a tag is managed by the platform and will be released when NFC service stops.
+ *
+ * @param[out] tag The connected tag
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
int nfc_manager_get_connected_tag(nfc_tag_h *tag);
/**
- * @brief Gets current connected p2p target
+ * @brief Gets current connected p2p target.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*
- * @param [out] target The connected target
+ * @remarks The @a target should not be released.
+ * @remarts The @a target is managed by the platform and will be released when NFC service stops.
+ *
+ * @param[out] target The connected target
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
/**
- * @brief Enable or disable the system handling for tag and target discovered event
+ * @brief Enables or disable the system handling for tag and target discovered event.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
* @remarks In default, The system handling is enabled.
*
- * @param [in] enable The state of enable
+ * @param[in] enable The state of enable
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
int nfc_manager_set_system_handler_enable(bool enable);
/**
- * @brief Gets the state of the system handler
+ * @brief Gets the state of the system handler.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc
*
* @return true on enabled, otherwise false.
*
+ * @return 0 on success, otherwise a negative error value.
* @exception #NFC_ERROR_NONE Success
* @exception #NFC_ERROR_NOT_SUPPORTED Not supported NFC
* @exception #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
- * @exception #NFC_ERROR_INVALID_PARAMETER Invalid parameter
* @exception #NFC_ERROR_NOT_ACTIVATED NFC is not activated
* @exception #NFC_ERROR_PERMISSION_DENIED Security restricted by SMACK
* @exception #NFC_ERROR_OPERATION_FAILED Operation failed
bool nfc_manager_is_system_handler_enabled(void);
/**
- * @brief Sets the card emulation Secure Element type
+ * @brief Sets the card emulation Secure Element type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc.cardemulation
* If you want to know about security level in detail, See the GSMA specification.\n
* (http://www.gsma.com/digitalcommerce/wp-content/uploads/2013/12/GSMA-NFC05-NFC-Handset-APIs-Requirement-Specification-version-4-1.pdf)
*
- * @param [in] type The type of Secure Element
+ * @param[in] type The type of Secure Element
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
int nfc_manager_set_se_type(nfc_se_type_e type);
/**
- * @brief Gets the card emulation Secure Element type
+ * @brief Gets the card emulation Secure Element type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc.cardemulation
* @ingroup CAPI_NETWORK_NFC_MANAGER_MODULE
*
- * @param [out] type The type of Secure Element
+ * @param[out] type The type of Secure Element
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_RECORD_MODULE
*
+ * @remarks The @a record should be released using nfc_ndef_record_destroy().
+ * @remarks The @a record should be released using nfc_ndef_record_destroy().
* @remarks Every data buffer is deeply copied.\n
* Every data is a byte array(binary data).
*
- * @param [out] record A handle to record
- * @param [in] tnf The type name format
- * @param [in] type The specified type name
- * @param [in] type_size The byte size of type
- * @param [in] id The record ID
- * @param [in] id_size The byte size of ID
- * @param [in] payload The payload of this record
- * @param [in] payload_size The byte size of payload
+ * @param[out] record A handle to record
+ * @param[in] tnf The type name format
+ * @param[in] type The specified type name
+ * @param[in] type_size The byte size of type
+ * @param[in] id The record ID
+ * @param[in] id_size The byte size of ID
+ * @param[in] payload The payload of this record
+ * @param[in] payload_size The byte size of payload
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
/**
- * @brief Creates a record with text type payload
+ * @brief Creates a record with text type payload.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_RECORD_MODULE
*
+ * @remarks The @a record should be released using nfc_ndef_record_destroy().
* @remarks This function does not encode the text. @a text will be assumed as that it is already encoded with encode type.\n
* The text buffer will be deeply copied.\n
* The record is created in this format\n
- * - TNF : NFC_RECORD_TNF_WELL_KNOWN\n
+ * - TNF : #NFC_RECORD_TNF_WELL_KNOWN\n
* - type : "T"\n
* - payload : encode and header information + language code + text \n
* Defined in Record Type Definition Technical Specifications.
*
- * @param [out] record A handle to record
- * @param [in] text The encoded text
- * @param [in] lang_code The language code string value followed by IANA[RFC 3066] (ex: en-US, ko-KR)
- * @param [in] encode The encoding type
+ * @param[out] record A handle to record
+ * @param[in] text The encoded text
+ * @param[in] lang_code The language code string value followed by IANA[RFC 3066] (ex: en-US, ko-KR)
+ * @param[in] encode The encoding type
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
int nfc_ndef_record_create_text(nfc_ndef_record_h *record, const char *text, const char *lang_code, nfc_encode_type_e encode);
/**
- * @brief Creates a record with URI type payload
+ * @brief Creates a record with URI type payload.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_RECORD_MODULE
*
- * @remarks The uri string will be deep copied.\n
+ * @remarks The @a record should be released using nfc_ndef_record_destroy().
+ * @remarks The @a record should be released using free().
+ * @remarks The URI string will be deep copied.\n
* The record is created in this format\n
- * - TNF : NFC_RECORD_TNF_WELL_KNOWN\n
+ * - TNF : #NFC_RECORD_TNF_WELL_KNOWN\n
* - type : "U"\n
- * - payload : protocol scheme + uri\n
+ * - payload : protocol scheme + URI\n
* Defined in Record Type Definition Technical Specifications.
*
- * @param [out] record A handle to record
- * @param [in] uri The URI string that will be stored in the payload
+ * @param[out] record A handle to record
+ * @param[in] uri The URI string that will be stored in the payload
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
/**
- * @brief Creates a record with MIME type payload
+ * @brief Creates a record with MIME type payload.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_RECORD_MODULE
*
+ * @remarks The @a record should be released using nfc_ndef_record_destroy().
* @remarks The data buffer will be deep copied.\n
* The data are bytes array(binary data).\n
* The mime_type string will deep copied.\n
* The record is created in this format\n
- * - TNF : NFC_RECORD_TNF_MIME_MEDIA\n
- * - type : mime type\n
+ * - TNF : #NFC_RECORD_TNF_MIME_MEDIA\n
+ * - type : MIME type\n
* - payload : data\n
* Defined in Record Type Definition Technical Specifications.
*
- * @param [out] record A handle to record
- * @param [in] mime_type The mime type [RFC 2046] (ex. text/plain, image/jpeg ) This value is stored in type field
- * @param [in] data The pointer of data
- * @param [in] data_size The size of data
+ * @param[out] record A handle to record
+ * @param[in] mime_type The MIME type [RFC 2046] (ex. text/plain, image/jpeg ) This value is stored in type field
+ * @param[in] data The pointer of data
+ * @param[in] data_size The size of data
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
/**
- * @brief Destroys the record handle
+ * @brief Destroys the record handle.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_RECORD_MODULE
*
- * @param [in] record The handle to record
+ * @param[in] record The handle to record
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
int nfc_ndef_record_destroy(nfc_ndef_record_h record);
/**
- * @brief Sets record ID
+ * @brief Sets record ID.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_RECORD_MODULE
*
* @remarks The ID buffer are deep copied.
*
- * @param [in] record The handle to record
- * @param [in] id The record ID
- * @param [in] id_size The size of ID in bytes
+ * @param[in] record The handle to record
+ * @param[in] id The record ID
+ * @param[in] id_size The size of ID in bytes
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
int nfc_ndef_record_set_id(nfc_ndef_record_h record, unsigned char *id, int id_size);
/**
- * @brief Gets record ID
+ * @brief Gets record ID.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_RECORD_MODULE
*
* This function gives you the pointer of ID that is contained by record\n
* Do not free the ID. It will be released when @a record is destroyed by nfc_ndef_record_destroy().
*
- * @param [in] record The handle to record
- * @param [out] id The record ID ( do not free )
- * @param [out] size The size of ID in bytes
+ * @param[in] record The handle to record
+ * @param[out] id The record ID ( do not free )
+ * @param[out] size The size of ID in bytes
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @remarks This function gives you the pointer of payload that is contained by record\n
* Do not free the payload. it will be freed when @a record is destroyed by nfc_ndef_record_destroy().
*
- * @param [in] record The handle to record
- * @param [out] payload The payload ( do not free this pointer )
- * @param [out] size the size of payload in byte
+ * @param[in] record The handle to record
+ * @param[out] payload The payload ( do not free this pointer )
+ * @param[out] size the size of payload in byte
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @remarks This function gives you the pointer of type that is contained by record.\n
* Do not free the type. it will be freed when the record is freed.
*
- * @param [in] record The handle to record
- * @param [out] type The record type ( do not free this pointer )
- * @param [out] size The size of type in byte
+ * @param[in] record The handle to record
+ * @param[out] type The record type ( do not free this pointer )
+ * @param[out] size The size of type in byte
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
int nfc_ndef_record_get_type(nfc_ndef_record_h record, unsigned char **type, int *size);
/**
- * @brief Gets record TNF(Type Name Format) value.
+ * @brief Gets record TNF (Type Name Format) value.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_RECORD_MODULE
*
- * @param [in] record The handle to record
- * @param [out] tnf The TNF(Type Name Format) value
+ * @param[in] record The handle to record
+ * @param[out] tnf The TNF (Type Name Format) value
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
int nfc_ndef_record_get_tnf(nfc_ndef_record_h record, nfc_record_tnf_e *tnf);
/**
- * @brief Gets text from text record
+ * @brief Gets text from text record.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_RECORD_MODULE
*
* @remarks This function returns newly allocated string, this value must be deallocated by caller.\n
* This function is valid only for text type record.\n
- * The text type record 's tnf is NFC_RECORD_TNF_WELL_KNOWN and it's type is "T"
+ * The text type record 's tnf is #NFC_RECORD_TNF_WELL_KNOWN and it's type is "T"
*
- * @param [in] record The handle to record
- * @param [out] text The text in record payload ( should be freed by caller )
+ * @param[in] record The handle to record
+ * @param[out] text The text in record payload ( should be freed by caller )
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
int nfc_ndef_record_get_text(nfc_ndef_record_h record, char **text);
/**
- * @brief Gets language code from text record
+ * @brief Gets language code from text record.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_RECORD_MODULE
* @remarks This function returns newly allocated string, this value must be deallocated by caller.\n
* This function is valid only for text type record.\n
- * The text type record 's tnf is NFC_RECORD_TNF_WELL_KNOWN and it's type is "T"
+ * The text type record 's tnf is #NFC_RECORD_TNF_WELL_KNOWN and it's type is "T"
*
- * @param [in] record The handle to record
- * @param [out] lang_code lang code ( should be freed by caller )
+ * @param[in] record The handle to record
+ * @param[out] lang_code lang code ( should be freed by caller )
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
int nfc_ndef_record_get_langcode(nfc_ndef_record_h record, char **lang_code);
/**
- * @brief Gets encoding type from text record
+ * @brief Gets encoding type from text record.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_RECORD_MODULE
*
* @remarks This function is valid only for text type record.\n
- * The text type record 's tnf is NFC_RECORD_TNF_WELL_KNOWN and it's type is "T"
+ * The text type record 's tnf is #NFC_RECORD_TNF_WELL_KNOWN and it's type is "T"
*
- * @param [in] record The handle to record
- * @param [out] encode encode type #nfc_encode_type_e
+ * @param[in] record The handle to record
+ * @param[out] encode encode type #nfc_encode_type_e
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
int nfc_ndef_record_get_encode_type(nfc_ndef_record_h record, nfc_encode_type_e *encode);
/**
- * @brief Gets URI from uri record
+ * @brief Gets URI from URI record.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_RECORD_MODULE
*
* @remarks The function returns newly allocated string, this value must be deallocated by caller.\n
- * This function is valid only for uri type record.
- * The uri type record 's tnf is NFC_RECORD_TNF_WELL_KNOWN and it's type is "U"
+ * This function is valid only for URI type record.
+ * The URI type record 's tnf is #NFC_RECORD_TNF_WELL_KNOWN and it's type is "U"
*
- * @param [in] record The handle to record
- * @param [out] uri The uri in record payload ( should be freed by caller )
+ * @param[in] record The handle to record
+ * @param[out] uri The URI in record payload ( should be freed by caller )
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
/**
- * @brief Gets mime type from mime type record
+ * @brief Gets MIME type from MIME type record.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_RECORD_MODULE
*
* @remarks The function returns newly allocated string, this value must be deallocated by caller.\n
- * This function is valid only for mime type record.\n
- * The uri type record 's tnf is NFC_RECORD_TNF_MIME_MEDIA.
+ * This function is valid only for MIME type record.\n
+ * The URI type record 's tnf is #NFC_RECORD_TNF_MIME_MEDIA.
*
- * @param [in] record The handle to record
- * @param [out] mime_type The mime type in record payload ( should be freed by caller )
+ * @param[in] record The handle to record
+ * @param[out] mime_type The MIME type in record payload ( should be freed by caller )
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
/**
- * @brief Creates NDEF message handle
+ * @brief Creates NDEF message handle.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_MESSAGE_MODULE
*
- * @param [out] ndef_message A handle to NDEF message
+ * @remarks The @a ndef_message should be released using nfc_ndef_message_destroy().
+ *
+ * @param[out] ndef_message A handle to NDEF message
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_MESSAGE_MODULE
*
- * @remarks It consumes the bytes array until get the ME(Message End) flag*. It returns error if the bytes array does not have ME flag.\n
+ * @remarks The @a ndef_message should be released using nfc_ndef_message_destroy().
+ * @remarks It consumes the bytes array until get the ME (Message End) flag*. It returns error if the bytes array does not have ME flag.\n
* *The ME flag is a 1-bit field that when set indicates the end of an NDEF message.
*
- * @param [out] ndef_message The handle to NDEF message
- * @param [in] rawdata The NDEF message in form of bytes array
- * @param [in] rawdata_size The size of bytes array
+ * @param[out] ndef_message The handle to NDEF message
+ * @param[in] rawdata The NDEF message in form of bytes array
+ * @param[in] rawdata_size The size of bytes array
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
int nfc_ndef_message_create_from_rawdata(nfc_ndef_message_h *ndef_message, const unsigned char *rawdata, unsigned int rawdata_size);
/**
- * @brief Destroys NDEF message handle
+ * @brief Destroys NDEF message handle.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_MESSAGE_MODULE
*
* @remarks This function will free all these memory including record handles.
*
- * @param [in] ndef_message The handle to NDEF message to destroy
+ * @param[in] ndef_message The handle to NDEF message to destroy
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
int nfc_ndef_message_destroy(nfc_ndef_message_h ndef_message);
/**
- * @brief Gets the number of record in NDEF message
+ * @brief Gets the number of record in NDEF message.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_MESSAGE_MODULE
*
- * @param [in] ndef_message The handle to NDEF message
- * @param [out] count The number of record
+ * @param[in] ndef_message The handle to NDEF message
+ * @param[out] count The number of record
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
*
* @remarks It gets copy of the bytes array from NDEF message. @a rawdata must be released with free() by you.
*
- * @param [in] ndef_message The handle to NDEF message
- * @param [out] rawdata The bytes array of bytes array
- * @param [out] rawdata_size The size of bytes array in byte
+ * @param[in] ndef_message The handle to NDEF message
+ * @param[out] rawdata The bytes array of bytes array
+ * @param[out] rawdata_size The size of bytes array in byte
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
int nfc_ndef_message_get_rawdata(nfc_ndef_message_h ndef_message, unsigned char **rawdata, unsigned int *rawdata_size);
/**
- * @brief Appends a record into NDEF message
+ * @brief Appends a record into NDEF message.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_MESSAGE_MODULE
*
* @remarks Appended record is handled by frameworks. The record is released by frameworks when message is released.
*
- * @param [in] ndef_message The handle to NDEF message
- * @param [in] record The record that will be appended into NDEF message
+ * @param[in] ndef_message The handle to NDEF message
+ * @param[in] record The record that will be appended into NDEF message
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
int nfc_ndef_message_append_record(nfc_ndef_message_h ndef_message, nfc_ndef_record_h record);
/**
- * @brief Inserts a record at index into NDEF message
+ * @brief Inserts a record at index into NDEF message.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_MESSAGE_MODULE
*
* @remarks Appended record is handled by frameworks. The record is released by frameworks when message is released.\n
* The index value should not bigger than nfc_ndef_message_get_record_count()
*
- * @param [in] ndef_message The handle to NDEF message
- * @param [in] index The index of record ( starts from 0 )
- * @param [in] record The record that will be appended into NDEF message
+ * @param[in] ndef_message The handle to NDEF message
+ * @param[in] index The index of record ( starts from 0 )
+ * @param[in] record The record that will be appended into NDEF message
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_MESSAGE_MODULE
*
- * @param [in] ndef_message The handle to NDEF message
- * @param [in] index The index of record ( starts from 0 )
+ * @param[in] ndef_message The handle to NDEF message
+ * @param[in] index The index of record ( starts from 0 )
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_NDEF_MESSAGE_MODULE
*
+ * @remarks The @a record should not be released.
+ * @remarks The @a record is managed by the platform and will be released when MTP service stops.
* @remarks This function just return the pointer of record. if you change the record value it directly affects the NDEF message
*
- * @param [in] ndef_message The handle to NDEF message
- * @param [in] index The index of record ( starts from 0 )
- * @param [out] record The handle to record
+ * @param[in] ndef_message The handle to NDEF message
+ * @param[in] index The index of record ( starts from 0 )
+ * @param[out] record The handle to record
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
int nfc_ndef_message_get_record(nfc_ndef_message_h ndef_message, int index, nfc_ndef_record_h *record);
/**
- * @brief Gets the type of NFC tag
+ * @brief Gets the type of NFC tag.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_TAG_MODULE
*
- * @param [in] tag The handle to NFC tag
- * @param [out] type The type of NFC tag
+ * @param[in] tag The handle to NFC tag
+ * @param[out] type The type of NFC tag
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_TAG_MODULE
*
- * @param [in] tag The handle to NFC tag
- * @param [out] is_supported @c true when NFC tag supports NDEF messages, otherwise @c false
+ * @param[in] tag The handle to NFC tag
+ * @param[out] is_supported @c true when NFC tag supports NDEF messages, otherwise @c false
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
*
* @remarks This max size indicates the maximum size of NDEF message that can be stored in this detected tag.
*
- * @param [in] tag The handle to NFC tag
- * @param [out] maximum_ndef_bytes_size The maximum bytes size of NDEF message that can be stored in this detected tag.
+ * @param[in] tag The handle to NFC tag
+ * @param[out] maximum_ndef_bytes_size The maximum bytes size of NDEF message that can be stored in this detected tag.
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
int nfc_tag_get_maximum_ndef_size(nfc_tag_h tag, unsigned int *maximum_ndef_bytes_size);
/**
- * @brief Gets size of NDEF message that stored in the tag
+ * @brief Gets size of NDEF message that stored in the tag.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_TAG_MODULE
*
- * @param [in] tag The handle to NFC tag
- * @param [out] ndef_bytes_size The NDEF message bytes size that stored in the tag
+ * @param[in] tag The handle to NFC tag
+ * @param[out] ndef_bytes_size The NDEF message bytes size that stored in the tag
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
/**
- * @brief Retrieves all tag information
+ * @brief Retrieves all tag information.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_TAG_MODULE
*
/**
* @brief Transceives the data of the raw format card.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @privlevel public
- * @privilege %http://tizen.org/privilege/nfc
* @details This function is the only way to access the raw format card (not formated),
each tag type requires own command to access tags. \n
This function provides the low level access of tag operation and you require the knowledge of each tag technology.
-* @ingroup CAPI_NETWORK_NFC_TAG_MODULE
-*
-* @param [in] tag The handle to NFC tag
-* @param [in] buffer The binary data for parameter or additional commands
-* @param [in] buffer_size The size of buffer in bytes
-* @param [in] callback The callback function to invoke after this function has completed\n It can be null if a notification is not required
-* @param [in] user_data The user data to be passed to the callback function
-*
-* @return 0 on success, otherwise a negative error value.
-* @retval #NFC_ERROR_NONE Successful
-* @retval #NFC_ERROR_NOT_SUPPORTED Not supported NFC
-* @retval #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
-* @retval #NFC_ERROR_OUT_OF_MEMORY Out of memory
-* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
-* @retval #NFC_ERROR_DEVICE_BUSY Device is too busy to handle your request
-* @retval #NFC_ERROR_TIMED_OUT Timeout is reached while communicating with tag
-* @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
-* @retval #NFC_ERROR_OPERATION_FAILED Operation failed
-*
-* @post It invokes nfc_tag_transceive_completed_cb() when it has completed to transceive data.\n
-* The Callback can receive error code when process is done.
-*
-* @see nfc_tag_read_ndef()
-* @see nfc_tag_is_support_ndef()
-* @see nfc_manager_initialize()
-*/
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/nfc
+ * @ingroup CAPI_NETWORK_NFC_TAG_MODULE
+ *
+ * @param[in] tag The handle to NFC tag
+ * @param[in] buffer The binary data for parameter or additional commands
+ * @param[in] buffer_size The size of buffer in bytes
+ * @param[in] callback The callback function to invoke after this function has completed\n It can be null if a notification is not required
+ * @param[in] user_data The user data to be passed to the callback function
+ *
+ * @return 0 on success, otherwise a negative error value.
+ * @retval #NFC_ERROR_NONE Successful
+ * @retval #NFC_ERROR_NOT_SUPPORTED Not supported NFC
+ * @retval #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
+ * @retval #NFC_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #NFC_ERROR_DEVICE_BUSY Device is too busy to handle your request
+ * @retval #NFC_ERROR_TIMED_OUT Timeout is reached while communicating with tag
+ * @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
+ * @retval #NFC_ERROR_OPERATION_FAILED Operation failed
+ * @retval #NFC_ERROR_PERMISSION_DENIED Permission denied
+ *
+ * @post It invokes nfc_tag_transceive_completed_cb() when it has completed to transceive data.\n
+ * The Callback can receive error code when process is done.
+ *
+ * @see nfc_tag_read_ndef()
+ * @see nfc_tag_is_support_ndef()
+ * @see nfc_manager_initialize()
+ */
int nfc_tag_transceive(nfc_tag_h tag, unsigned char *buffer, int buffer_size, nfc_tag_transceive_completed_cb callback, void *user_data);
/**
* @privilege %http://tizen.org/privilege/nfc
* @ingroup CAPI_NETWORK_NFC_TAG_MODULE
*
- * @param [in] tag The handle to NFC tag
- * @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] tag The handle to NFC tag
+ * @param[in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_DEVICE_BUSY Device is too busy to handle your request
* @retval #NFC_ERROR_TIMED_OUT Timeout is reached while communicating with tag
* @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
- * @retval #NFC_ERROR_NOT_NDEF_FORMAT Not ndef format tag
+ * @retval #NFC_ERROR_NOT_NDEF_FORMAT Not NDEF format tag
* @retval #NFC_ERROR_OPERATION_FAILED Operation failed
+ * @retval #NFC_ERROR_PERMISSION_DENIED Permission denied
*
* @post It invokes nfc_tag_read_completed_cb() when it has completed to read NDEF formatted data.\n
* The Callback can receive error code when process is done.
* @privilege %http://tizen.org/privilege/nfc
* @ingroup CAPI_NETWORK_NFC_TAG_MODULE
*
- * @param [in] tag The handle to NFC tag
- * @param [in] msg The message will be write to the tag
- * @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] tag The handle to NFC tag
+ * @param[in] msg The message will be write to the tag
+ * @param[in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_DEVICE_BUSY Device is too busy to handle your request
* @retval #NFC_ERROR_TIMED_OUT Timeout is reached while communicating with tag
* @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
- * @retval #NFC_ERROR_NOT_NDEF_FORMAT Not ndef format tag
+ * @retval #NFC_ERROR_NOT_NDEF_FORMAT Not NDEF format tag
* @retval #NFC_ERROR_OPERATION_FAILED Operation failed
+ * @retval #NFC_ERROR_PERMISSION_DENIED Permission denied
*
* @post It invokes nfc_tag_write_completed_cb() when it has completed to write NDEF data.\n
* The Callback can receive error code when process is done.
/**
* @brief Formats the detected tag that can store NDEF message.
+ * @details Some tags are required authentication. If the detected target doesn't need authentication, @a key can be NULL.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc
- * @details Some tags are required authentication. If the detected target doesn't need authentication, @a key can be NULL.
* @ingroup CAPI_NETWORK_NFC_TAG_MODULE
*
- * @param [in] tag The handle to NFC tag
- * @param [in] key The key value that may need to format the tag
- * @param [in] key_size The size of key in byte
- * @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] tag The handle to NFC tag
+ * @param[in] key The key value that may need to format the tag
+ * @param[in] key_size The size of key in byte
+ * @param[in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_DEVICE_BUSY Device is too busy to handle your request
* @retval #NFC_ERROR_TIMED_OUT Timeout is reached while communicating with tag
* @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
- * @retval #NFC_ERROR_NOT_NDEF_FORMAT Not ndef format tag
+ * @retval #NFC_ERROR_NOT_NDEF_FORMAT Not NDEF format tag
* @retval #NFC_ERROR_OPERATION_FAILED Operation failed
+ * @retval #NFC_ERROR_PERMISSION_DENIED Permission denied
*
* @post It invokes nfc_tag_format_completed_cb() when it has completed to format the NFC tag.\n
* The Callback can receive error code when process is done.
* @retval #NFC_ERROR_TIMED_OUT Timeout is reached while communicating with tag
* @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
* @retval #NFC_ERROR_OPERATION_FAILED Operation failed
+ * @retval #NFC_ERROR_PERMISSION_DENIED Permission denied
*
* @post It invokes nfc_mifare_authenticate_with_keyA_completed_cb() when it has completed to authenticate the given sector with key A.\n
* The Callback can receive error code when process is done.
* => 0 ~ 31 : 32 sector and 4 block with 16 bytes \n
* => 32 ~ 39 : 8 sector and 16 block with 16 bytes
*
- * @param [in] tag The handle to NFC tag
- * @param [in] sector_index The index of sector to authenticate with key B, starting from 0
- * @param [in] auth_key 6-byte authentication key
- * @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] tag The handle to NFC tag
+ * @param[in] sector_index The index of sector to authenticate with key B, starting from 0
+ * @param[in] auth_key 6-byte authentication key
+ * @param[in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_TIMED_OUT Timeout is reached while communicating with tag
* @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
* @retval #NFC_ERROR_OPERATION_FAILED Operation failed
+ * @retval #NFC_ERROR_PERMISSION_DENIED Permission denied
*
* @post It invokes nfc_mifare_authenticate_with_keyB_completed_cb() when it has completed to authenticate the given sector with key B.\n
* The Callback can receive error code when process is done.
* @privilege %http://tizen.org/privilege/nfc
* @remarks This function is only available for MIFARE classic.
*
- * @param [in] tag The handle to NFC tag
- * @param [in] block_index The block or starting page number
- * @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] tag The handle to NFC tag
+ * @param[in] block_index The block or starting page number
+ * @param[in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_TIMED_OUT Timeout is reached while communicating with tag
* @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
* @retval #NFC_ERROR_OPERATION_FAILED Operation failed
+ * @retval #NFC_ERROR_PERMISSION_DENIED Permission denied
*
* @post It invokes nfc_mifare_read_block_completed_cb() when it has completed to read a block.\n
* The Callback can receive error code when process is done.
* @remarks This function is only available for MIFARE Ultra light.\n
* The MIFARE Ultralight protocol always reads 4 pages at a time, to reduce the number of commands required to read an entire tag.
*
- * @param [in] tag The handle to NFC tag
- * @param [in] page_index The index of page to read, starting from 0
- * @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] tag The handle to NFC tag
+ * @param[in] page_index The index of page to read, starting from 0
+ * @param[in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
+ * @param[in] user_data The user data to be passed to the callback function
*
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_TIMED_OUT Timeout is reached while communicating with tag
* @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
* @retval #NFC_ERROR_OPERATION_FAILED Operation failed
+ * @retval #NFC_ERROR_PERMISSION_DENIED Permission denied
*
* @post It invokes nfc_mifare_read_page_completed_cb() when it has completed to read a page.\n
* The Callback can receive error code when process is done.
* @privilege %http://tizen.org/privilege/nfc
* @remarks This function is only available for MIFARE classic.
*
- * @param [in] tag The handle to NFC tag
- * @param [in] block_index The index of block to read, starting from 0
- * @param [in] buffer 16 bytes of data to write
- * @param [in] buffer_size The size of buffer in bytes
- * @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] tag The handle to NFC tag
+ * @param[in] block_index The index of block to read, starting from 0
+ * @param[in] buffer 16 bytes of data to write
+ * @param[in] buffer_size The size of buffer in bytes
+ * @param[in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_TIMED_OUT Timeout is reached while communicating with tag
* @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
* @retval #NFC_ERROR_OPERATION_FAILED Operation failed
+ * @retval #NFC_ERROR_PERMISSION_DENIED Permission denied
*
* @post It invokes nfc_mifare_write_block_completed_cb() when it has completed to write a block.\n The Callback can receive error code when process is done.
*
/**
* @ingroup CAPI_NETWORK_NFC_TAG_MIFARE_MODULE
- * @brief Writes a page (4 bytes) of data to the tag at a given page index
+ * @brief Writes a page (4 bytes) of data to the tag at a given page index.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc
* @remarks This function is only available for MIFARE Ultra light
*
- * @param [in] tag The handle to NFC tag
- * @param [in] page_index The index of page to write, starting from 0
- * @param [in] buffer 4 bytes of data to write
- * @param [in] buffer_size The size of buffer in bytes
- * @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] tag The handle to NFC tag
+ * @param[in] page_index The index of page to write, starting from 0
+ * @param[in] buffer 4 bytes of data to write
+ * @param[in] buffer_size The size of buffer in bytes
+ * @param[in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_TIMED_OUT Timeout is reached while communicating with tag
* @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
* @retval #NFC_ERROR_OPERATION_FAILED Operation failed
+ * @retval #NFC_ERROR_PERMISSION_DENIED Permission denied
*
* @post It invokes nfc_mifare_write_page_completed_cb() when it has completed to write a page.\n
* The Callback can receive error code when process is done.
* @privilege %http://tizen.org/privilege/nfc
* @remarks This function is only available for MIFARE classic
*
- * @param [in] tag The handle to NFC tag
- * @param [in] block_index The index of block to increase, starting from 0
- * @param [in] value Non-negative to increment by
- * @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] tag The handle to NFC tag
+ * @param[in] block_index The index of block to increase, starting from 0
+ * @param[in] value Non-negative to increment by
+ * @param[in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_TIMED_OUT Timeout is reached while communicating with tag
* @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
* @retval #NFC_ERROR_OPERATION_FAILED Operation failed
+ * @retval #NFC_ERROR_PERMISSION_DENIED Permission denied
*
* @post It invokes nfc_mifare_increment_completed_cb() when it has completed to increment.\n
* The Callback can receive error code when process is done.
* @privilege %http://tizen.org/privilege/nfc
* @remarks This function is only available for MIFARE classic
*
- * @param [in] tag The handle to NFC tag
- * @param [in] block_index The index of block to decrease, starting from 0
- * @param [in] value non-negative to decrement by
- * @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] tag The handle to NFC tag
+ * @param[in] block_index The index of block to decrease, starting from 0
+ * @param[in] value non-negative to decrement by
+ * @param[in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_TIMED_OUT Timeout is reached while communicating with tag
* @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
* @retval #NFC_ERROR_OPERATION_FAILED Operation failed
+ * @retval #NFC_ERROR_PERMISSION_DENIED Permission denied
*
* @post It invokes nfc_mifare_decrement_completed_cb() when it has completed to decrement.\n
* The Callback can receive error code when process is done.
/**
* @ingroup CAPI_NETWORK_NFC_TAG_MIFARE_MODULE
- * @brief Copy from the temporary block to the specified block.
+ * @brief Copies from the temporary block to the specified block.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc
* @remarks This function is only available for MIFARE classic
*
- * @param [in] tag The handle to NFC tag
- * @param [in] block_index The index of block to copy to, starting from 0
- * @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] tag The handle to NFC tag
+ * @param[in] block_index The index of block to copy to, starting from 0
+ * @param[in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_TIMED_OUT Timeout is reached while communicating with tag
* @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
* @retval #NFC_ERROR_OPERATION_FAILED Operation failed
+ * @retval #NFC_ERROR_PERMISSION_DENIED Permission denied
*
* @post It invokes nfc_mifare_transfer_completed_cb() when it has completed to transfer.\n
* The Callback can receive error code when process is done.
/**
* @ingroup CAPI_NETWORK_NFC_TAG_MIFARE_MODULE
- * @brief Copy from a value block to the temporary block.
+ * @brief Copies from a value block to the temporary block.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc
* @remarks This function is only available for MIFARE classic
*
- * @param [in] tag The handle to NFC tag
- * @param [in] block_index The index of block to copy from, starting from 0
- * @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] tag The handle to NFC tag
+ * @param[in] block_index The index of block to copy from, starting from 0
+ * @param[in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_TIMED_OUT Timeout is reached while communicating with tag
* @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
* @retval #NFC_ERROR_OPERATION_FAILED Operation failed
+ * @retval #NFC_ERROR_PERMISSION_DENIED Permission denied
*
* @post It invokes nfc_mifare_restore_completed_cb() when it has completed to restore.\n
* The Callback can receive error code when process is done.
int nfc_mifare_restore(nfc_tag_h tag, int block_index, nfc_mifare_restore_completed_cb callback, void *user_data);
/**
- * @brief Registers a callback function for receiving data from NFC peer-to-peer target.
+ * @brief Sets a callback function for receiving data from NFC peer-to-peer target.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_P2P_MODULE
*
- * @param [in] target The handle to peer target
- * @param [in] callback The callback function to invoke when an NDEF Message is discovered
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] target The handle to peer target
+ * @param[in] callback The callback function to invoke when an NDEF Message is discovered
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
int nfc_p2p_set_data_received_cb(nfc_p2p_target_h target, nfc_p2p_data_received_cb callback, void *user_data);
/**
- * @brief Unregisters the callback function.
+ * @brief Unsets the callback function.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @ingroup CAPI_NETWORK_NFC_P2P_MODULE
*
- * @param [in] target The handle to peer target
+ * @param[in] target The handle to peer target
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
int nfc_p2p_unset_data_received_cb(nfc_p2p_target_h target);
/**
- * @brief Sends data to NFC peer-to-peer target
+ * @brief Sends data to NFC peer-to-peer target.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc
* @ingroup CAPI_NETWORK_NFC_P2P_MODULE
*
- * @param [in] target The handle to peer target
- * @param [in] message The message to send
- * @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] target The handle to peer target
+ * @param[in] message The message to send
+ * @param[in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NFC_ERROR_DEVICE_BUSY Device is too busy to handle your request
* @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
+ * @retval #NFC_ERROR_PERMISSION_DENIED Permission denied
*
* @post It invokes nfc_p2p_send_completed_cb() when it has completed to p2p send.\n
* The Callback can receive error code when process is done.
int nfc_p2p_send(nfc_p2p_target_h target, nfc_ndef_message_h message, nfc_p2p_send_completed_cb callback, void *user_data);
/**
- * @brief Start peer-to-peer server using SNEP protocol
+ * @brief Starts peer-to-peer server using SNEP protocol.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc
* @ingroup CAPI_NETWORK_NFC_P2P_MODULE
*
- * @param [in] target The handle to peer target
- * @param [in] san The name of service (service access name)
- * @param [in] sap The number of service (service access point)
- * @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] target The handle to peer target
+ * @param[in] san The name of service (service access name)
+ * @param[in] sap The number of service (service access point)
+ * @param[in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NFC_ERROR_DEVICE_BUSY Device is too busy to handle your request
* @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
+ * @retval #NFC_ERROR_PERMISSION_DENIED Permission denied
*
* @post It invokes nfc_snep_event_cb() when snep event is occured.\n
* The Callback can receive error code when process is done.
int nfc_snep_start_server(nfc_p2p_target_h target, const char *san, int sap, nfc_snep_event_cb callback, void *user_data);
/**
- * @brief Start peer-to-peer client using SNEP protocol
+ * @brief Starts peer-to-peer client using SNEP protocol.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc
* @ingroup CAPI_NETWORK_NFC_P2P_MODULE
*
- * @param [in] target The handle to peer target
- * @param [in] san The name of service (service access name)
- * @param [in] sap The number of service (service access point)
- * @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] target The handle to peer target
+ * @param[in] san The name of service (service access name)
+ * @param[in] sap The number of service (service access point)
+ * @param[in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NFC_ERROR_DEVICE_BUSY Device is too busy to handle your request
* @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
+ * @retval #NFC_ERROR_PERMISSION_DENIED Permission denied
*
* @post It invokes nfc_snep_event_cb() when snep event is occured.\n
* The Callback can receive error code when process is done.
int nfc_snep_start_client(nfc_p2p_target_h target, const char *san, int sap, nfc_snep_event_cb callback, void *user_data);
/**
- * @brief Send request message to peer-to-peer client using SNEP protocol
+ * @brief Sends request message to peer-to-peer client using SNEP protocol.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc
* @ingroup CAPI_NETWORK_NFC_P2P_MODULE
*
- * @param [in] handle The handle to connected snep instance
- * @param [in] type The request type of snep protocol
- * @param [in] msg The ndef message which will be sent
- * @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] handle The handle to connected snep instance
+ * @param[in] type The request type of snep protocol
+ * @param[in] msg The NDEF message which will be sent
+ * @param[in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NFC_ERROR_DEVICE_BUSY Device is too busy to handle your request
* @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
+ * @retval #NFC_ERROR_PERMISSION_DENIED Permission denied
*
* @post It invokes nfc_snep_event_cb() when snep event is occured.\n
* The Callback can receive error code when process is done.
int nfc_snep_send_client_request(nfc_p2p_snep_h handle, nfc_snep_type_e type, nfc_ndef_message_h msg, nfc_snep_event_cb callback, void *user_data);
/**
- * @brief Stop snep server or client
+ * @brief Stops snep server or client.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc
* @ingroup CAPI_NETWORK_NFC_P2P_MODULE
*
- * @param [in] target The handle to peer target
- * @param [in] service The handle which will be stopped
+ * @param[in] target The handle to peer target
+ * @param[in] service The handle which will be stopped
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_OPERATION_FAILED Operation failed
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
+ * @retval #NFC_ERROR_PERMISSION_DENIED Permission denied
*
* @see nfc_snep_event_cb()
* @see nfc_manager_initialize()
int nfc_snep_stop_service(nfc_p2p_target_h target, nfc_p2p_snep_h service);
/**
- * @brief Register peer-to-peer server using SNEP protocol
+ * @brief Registers peer-to-peer server using SNEP protocol.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc
* @ingroup CAPI_NETWORK_NFC_P2P_MODULE
*
- * @param [in] san The name of service (service access name)
- * @param [in] sap The number of service (service access point)
- * @param [in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] san The name of service (service access name)
+ * @param[in] sap The number of service (service access point)
+ * @param[in] callback The callback function to invoke after this function has completed\n It can be null if notification is not required
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NFC_ERROR_DEVICE_BUSY Device is too busy to handle your request
* @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
+ * @retval #NFC_ERROR_PERMISSION_DENIED Permission denied
*
* @post It invokes nfc_snep_event_cb() when snep event is occured.\n
* The Callback can receive error code when process is done.
int nfc_snep_register_server(const char *san, int sap, nfc_snep_event_cb callback, void *user_data);
/**
- * @brief Unregister snep server or client
+ * @brief Unregisters snep server or client.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc
* @ingroup CAPI_NETWORK_NFC_P2P_MODULE
*
- * @param [in] san The name of service (service access name)
- * @param [in] sap The number of service (service access point)
+ * @param[in] san The name of service (service access name)
+ * @param[in] sap The number of service (service access point)
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_OPERATION_FAILED Operation failed
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
+ * @retval #NFC_ERROR_PERMISSION_DENIED Permission denied
*
* @see nfc_snep_event_cb()
* @see nfc_manager_initialize()
int nfc_snep_unregister_server(const char *san, int sap);
/**
- * @brief Enable card emulation mode.
+ * @brief Enables card emulation mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc.cardemulation
* @retval #NFC_ERROR_NOT_SUPPORTED Not supported NFC
* @retval #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
* @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
- * @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NFC_ERROR_OPERATION_FAILED Operation failed
* @retval #NFC_ERROR_PERMISSION_DENIED Security Restricted by SMACK
* @retval #NFC_ERROR_SECURITY_RESTRICTED Security Restricted
int nfc_se_enable_card_emulation(void);
/**
- * @brief Disable card emulation mode.
+ * @brief Disables card emulation mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc.cardemulation
* @retval #NFC_ERROR_NOT_SUPPORTED Not supported NFC
* @retval #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
* @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
- * @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NFC_ERROR_OPERATION_FAILED Operation failed
* @retval #NFC_ERROR_PERMISSION_DENIED Security Restricted by SMACK
* @retval #NFC_ERROR_SECURITY_RESTRICTED Security Restricted
int nfc_se_disable_card_emulation(void);
/**
- * @brief Get the current card emulation mode.
+ * @brief Gets the current card emulation mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc.cardemulation
* @ingroup CAPI_NETWORK_NFC_SE_MODULE
*
- * @param [out] type The current card emulation mode type
+ * @param[out] type The current card emulation mode type
*
* @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_NOT_SUPPORTED Not supported NFC
+ * @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
* @retval #NFC_ERROR_NOT_ACTIVATED NFC is not activated
* @retval #NFC_ERROR_OPERATION_FAILED Operation failed
int nfc_se_get_card_emulation_mode(nfc_se_card_emulation_mode_type_e *type);
/**
- * @brief Send APDU(Application Protocol Data Unit) response to CLF(Contactless Front-end).
+ * @brief Sends APDU (Application Protocol Data Unit) response to CLF (Contactless Front-end).
* @since_tizen 2.3.1
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc.cardemulation
* @ingroup CAPI_NETWORK_NFC_SE_MODULE
*
- * @param [in] handle The handle of connected secure element
- * @param [in] resp The bytes array of response data
- * @param [in] resp_len The size of response bytes array
+ * @param[in] handle The handle of connected secure element
+ * @param[in] resp The bytes array of response data
+ * @param[in] resp_len The size of response bytes array
*
+ * @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_NOT_SUPPORTED Not supported NFC
* @retval #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
int nfc_hce_send_apdu_response(nfc_se_h handle, unsigned char *resp, unsigned int resp_len);
/**
- * @brief Set the default route for each device status.
+ * @brief Sets the default route for each device status.
* @since_tizen 2.3.1
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc.cardemulation
* @ingroup CAPI_NETWORK_NFC_SE_MODULE
*
- * @param [in] powered_on_status The type of default Secure Element when device is powered on
- * @param [in] powered_off_status The type of default Secure Element when device is powered off
- * @param [in] low_battery_status The type of default Secure Element when battery is low
+ * @param[in] powered_on_status The type of default Secure Element when device is powered on
+ * @param[in] powered_off_status The type of default Secure Element when device is powered off
+ * @param[in] low_battery_status The type of default Secure Element when battery is low
*
+ * @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_NOT_SUPPORTED Not supported NFC
* @retval #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
int nfc_se_set_default_route(nfc_se_type_e powered_on_status, nfc_se_type_e powered_off_status, nfc_se_type_e low_battery_status);
/**
- * @brief Gets the state whether an application to call this api is currently the activated handler for specific AID.
+ * @brief Gets the state whether an application to call this function is currently the activated handler for specific AID.
* @since_tizen 2.3.1
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc.cardemulation
* @ingroup CAPI_NETWORK_NFC_SE_MODULE
*
- * @param [in] se_type The type of Secure Element
- * @param [in] aid Application Id, specified in ISO/IEC 7816-4
- * @param [out] is_activated_handler @c true when application is currently the activated handler, otherwise @c false
+ * @param[in] se_type The type of Secure Element
+ * @param[in] aid Application Id, specified in ISO/IEC 7816-4
+ * @param[out] is_activated_handler @c true when application is currently the activated handler, otherwise @c false
*
+ * @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_NOT_SUPPORTED Not supported NFC
* @retval #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
int nfc_se_is_activated_handler_for_aid(nfc_se_type_e se_type, const char *aid, bool *is_activated_handler);
/**
- * @brief Gets the state whether an application to call this api is currently the activated handler for category.
+ * @brief Gets the state whether an application to call this function is currently the activated handler for category.
* @since_tizen 2.3.1
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc.cardemulation
* @ingroup CAPI_NETWORK_NFC_SE_MODULE
*
- * @param [in] se_type The type of Secure Element
- * @param [in] category The category
- * @param [out] is_activated_handler @c true when application is currently the activated handler, otherwise @c false
+ * @param[in] se_type The type of Secure Element
+ * @param[in] category The category
+ * @param[out] is_activated_handler @c true when application is currently the activated handler, otherwise @c false
*
+ * @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_NOT_SUPPORTED Not supported NFC
* @retval #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
* @privilege %http://tizen.org/privilege/nfc.cardemulation
* @ingroup CAPI_NETWORK_NFC_SE_MODULE
*
- * @param [in] se_type The type of Secure Element
- * @param [in] category The category
- * @param [in] aid Application Id, specified in ISO/IEC 7816-4
+ * @param[in] se_type The type of Secure Element
+ * @param[in] category The category
+ * @param[in] aid Application Id, specified in ISO/IEC 7816-4
*
+ * @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_NOT_SUPPORTED Not supported NFC
* @retval #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
/**
* @brief Unregisters a previously registered AID for the specified category.
- * @details You can unregister aid only you registered. If you try to release the aid what you are not registered, then the api return error.
+ * @details You can unregister aid only you registered. If you try to release the aid what you are not registered, then the function return error.
* @since_tizen 2.3.1
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc.cardemulation
* @ingroup CAPI_NETWORK_NFC_SE_MODULE
*
- * @param [in] se_type The type of Secure Element
- * @param [in] category The category
- * @param [in] aid Application Id, specified in ISO/IEC 7816-4
+ * @param[in] se_type The type of Secure Element
+ * @param[in] category The category
+ * @param[in] aid Application Id, specified in ISO/IEC 7816-4
*
+ * @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_NOT_SUPPORTED Not supported NFC
* @retval #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
/**
* @brief Retrieves all registered AID.
- * @details You can retrieve aid only you registered. If you try to retrieves the aid what you are not registered, then the api return error.
+ * @details You can retrieve aid only you registered. If you try to retrieves the aid what you are not registered, then the function return error.
* @since_tizen 2.3.1
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc.cardemulation
* @ingroup CAPI_NETWORK_NFC_SE_MODULE
*
- * @param [in] se_type The type of Secure Element
- * @param [in] category The category
- * @param [in] callback The callback function to invoke
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] se_type The type of Secure Element
+ * @param[in] category The category
+ * @param[in] callback The callback function to invoke
+ * @param[in] user_data The user data to be passed to the callback function
*
+ * @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_NOT_SUPPORTED Not supported NFC
* @retval #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
* @retval #NFC_ERROR_ILLEGAL_STATE Illegal state
* @retval #NFC_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NFC_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #NFC_ERROR_PERMISSION_DENIED Permission denied
*
* @see nfc_manager_initialize()
*
/**
* @brief Sets the application as a preferred handler.
+ * @details This function is possible to call when your application is in the foreground.\n
+ * We recommend that you call function when the app state is resume.
* @since_tizen 3.0
- * @details This api is possible to call when your application is in the foreground.\n
- * We recommend that you call api when the app state is resume.
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc.cardemulation
* @ingroup CAPI_NETWORK_NFC_SE_MODULE
*
+ * @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_NOT_SUPPORTED Not supported NFC
* @retval #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
/**
* @brief Unsets the application as a preferred handler.
- * @since_tizen 3.0
- * @details We recommend that you call api when the app state is pause.\n
- * If you do not call the api, Tizen will initialize the preferred app properly.\n
+ * @details We recommend that you call API when the app state is pause.\n
+ * If you do not call the API, Tizen will initialize the preferred app properly.\n
* But there may be a problem with the performance, we recommend your explicit call.
+ * @since_tizen 3.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/nfc.cardemulation
* @ingroup CAPI_NETWORK_NFC_SE_MODULE
*
+ * @return 0 on success, otherwise a negative error value.
* @retval #NFC_ERROR_NONE Successful
* @retval #NFC_ERROR_NOT_SUPPORTED Not supported NFC
* @retval #NFC_ERROR_NOT_INITIALIZED Not initialized NFC
projects / platform / core / api / nfc.git / commitdiff