*/
/**
- * @if WEARABLE
+ * @WEARABLE_ONLY
* @defgroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE Bluetooth PBAP
* @brief Bluetooth PBAP (Phone Book Access Profile) API provides functions for managing connections to a phone book server and retrieving phone book data.
* @ingroup CAPI_NETWORK_BLUETOOTH_MODULE
*
* More details on using features in your application can be found from <a href="https://developer.tizen.org/development/tools/native-tools/manifest-text-editor#feature"><b>Feature Element</b>.</a>
*
- * @endif
*
*/
/**
+ * @WEARABLE_ONLY
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Initializes the Bluetooth PBAP Client.
* @details This initialization is necessary to call other PBAP client APIs.
- * @since_tizen @if WEARABLE 3.0 @endif
+ * @since_tizen 3.0
*
* @remarks This function must be called to initialize Bluetooth PBAP client. You must free all resources of the Bluetooth service
* by calling bt_pbap_client_deinitialize() if Bluetooth PBAP Client is no longer needed.
int bt_pbap_client_initialize(void);
/**
+ * @WEARABLE_ONLY
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Deinitializes the Bluetooth PBAP Client.
* @details This deinitialization must be done to free resources when the PBAP client is not longer needed.
- * @since_tizen @if WEARABLE 3.0 @endif
+ * @since_tizen 3.0
*
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
int bt_pbap_client_deinitialize(void);
/**
+ * @WEARABLE_ONLY
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Registers a callback function that will be invoked when the connection state is changed.
- * @since_tizen @if WEARABLE 3.0 @endif
+ * @since_tizen 3.0
* @param[in] callback The callback function to register
* @param[in] user_data The user data to be passed to the callback function
* @return 0 on success, otherwise a negative error value.
int bt_pbap_client_set_connection_state_changed_cb(bt_pbap_connection_state_changed_cb callback, void *user_data);
/**
+ * @WEARABLE_ONLY
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Unregisters a callback function that will be invoked when the connection state is changed.
- * @since_tizen @if WEARABLE 3.0 @endif
+ * @since_tizen 3.0
* @return 0 on success, otherwise a negative error value.
* @retval #BT_ERROR_NONE Successful
* @retval #BT_ERROR_NOT_INITIALIZED Not initialized
int bt_pbap_client_unset_connection_state_changed_cb(void);
/**
+ * @WEARABLE_ONLY
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Connects to PBAP server, asynchronously.
- * @since_tizen @if WEARABLE 3.0 @endif
+ * @since_tizen 3.0
* @privlevel public
* @privilege http://tizen.org/privilege/bluetooth
*
int bt_pbap_client_connect(const char *address);
/**
+ * @WEARABLE_ONLY
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Disconnects from PBAP server, asynchronously.
- * @since_tizen @if WEARABLE 3.0 @endif
+ * @since_tizen 3.0
* @privlevel public
* @privilege http://tizen.org/privilege/bluetooth
*
int bt_pbap_client_disconnect(const char *address);
/**
+ * @WEARABLE_ONLY
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Gets size of phone book from PBAP server, asynchronously.
- * @since_tizen @if WEARABLE 3.0 @endif
+ * @since_tizen 3.0
* @privlevel public
* @privilege http://tizen.org/privilege/bluetooth
*
void *user_data);
/**
+ * @WEARABLE_ONLY
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Gets all contacts and call logs as vCard from PBAP server, asynchronously.
* @details The received phone book file will be saved in the platform downloads folder.
- * @since_tizen @if WEARABLE 3.0 @endif
+ * @since_tizen 3.0
* @privlevel public
* @privilege http://tizen.org/privilege/bluetooth
* http://tizen.org/privilege/mediastorage
void *user_data);
/**
+ * @WEARABLE_ONLY
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Gets contact and call log information from the PBAP server, asynchronously.
- * @since_tizen @if WEARABLE 3.0 @endif
+ * @since_tizen 3.0
* @privlevel public
* @privilege http://tizen.org/privilege/bluetooth
*
void *user_data);
/**
+ * @WEARABLE_ONLY
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Gets the selected contact using the index parameter as vCard from PBAP server, asynchronously.
* @details The received phone book file will be saved in the platform downloads folder.
* The @a index value should be equal to the value of the @a index field in the #bt_pbap_vcard_info_s structure,
* which can be obtained with bt_pbap_client_get_list() or bt_pbap_client_search_phone_book().
- * @since_tizen @if WEARABLE 3.0 @endif
+ * @since_tizen 3.0
* @privlevel public
* @privilege http://tizen.org/privilege/bluetooth
* http://tizen.org/privilege/mediastorage
void *user_data);
/**
+ * @WEARABLE_ONLY
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Finds and fetches the contact and call log information from the PBAP server, asynchronously.
- * @since_tizen @if WEARABLE 3.0 @endif
+ * @since_tizen 3.0
* @privlevel public
* @privilege http://tizen.org/privilege/bluetooth
*
/**
+ * @WEARABLE_ONLY
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Enumeration of PBAP fields.
- * @since_tizen @if WEARABLE 3.0 @endif
+ * @since_tizen 3.0
*/
typedef enum {
BT_PBAP_FIELD_ALL = (0xFFFFFFFFU), /**< All field */
typedef void *bt_advertiser_h;
/**
+ * @WEARABLE_ONLY
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Enumeration of address book location for PBAP.
- * @since_tizen @if WEARABLE 3.0 @endif
+ * @since_tizen 3.0
*/
typedef enum {
BT_PBAP_SOURCE_DEVICE = 0x00, /**< Request for Addressbook from remote device */
} bt_pbap_address_book_source_e;
/**
+ * @WEARABLE_ONLY
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Enumeration of folder type.
- * @since_tizen @if WEARABLE 3.0 @endif
+ * @since_tizen 3.0
*/
typedef enum {
BT_PBAP_FOLDER_PHONE_BOOK = 0x00, /**< Request for address book */
} bt_pbap_folder_type_e;
/**
+ * @WEARABLE_ONLY
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Enumeration of phone book search fields.
- * @since_tizen @if WEARABLE 3.0 @endif
+ * @since_tizen 3.0
*/
typedef enum {
BT_PBAP_SEARCH_NAME = 0x00, /**< Request for search by name (default) */
} bt_pbap_search_field_e;
/**
+ * @WEARABLE_ONLY
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Enumeration of vCard Formats.
- * @since_tizen @if WEARABLE 3.0 @endif
+ * @since_tizen 3.0
*/
typedef enum {
BT_PBAP_VCARD_FORMAT_VCARD21 = 0x00, /**< vCard format 2.1 (default) */
} bt_pbap_vcard_format_e;
/**
+ * @WEARABLE_ONLY
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Enumeration of sorting orders.
- * @since_tizen @if WEARABLE 3.0 @endif
+ * @since_tizen 3.0
*/
typedef enum {
BT_PBAP_ORDER_INDEXED = 0x00, /**< Filter order indexed (default) */
/**
+ * @WEARABLE_ONLY
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief The structure type containing vCard information.
- * @since_tizen @if WEARABLE 3.0 @endif
+ * @since_tizen 3.0
*
* @see bt_pbap_client_pull_vcard()
*/
} bt_pbap_vcard_info_s;
/**
+ * @WEARABLE_ONLY
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Called when PBAP is Connected or Disconnected.
* @details The following error codes can be delivered: \n
* #BT_ERROR_NONE \n
* #BT_ERROR_OPERATION_FAILED \n
- * @since_tizen @if WEARABLE 3.0 @endif
+ * @since_tizen 3.0
*
* @param[in] result The result of connecting to or disconnecting from the remote device
* @param[in] connected The PBAP connection status (@c true = connected, @c false = disconnected)
const char *remote_address, void *user_data);
/**
+ * @WEARABLE_ONLY
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Called when PBAP Phonebook size calculation completes.
* @details The following error codes can be delivered: \n
* #BT_ERROR_NONE \n
* #BT_ERROR_OPERATION_FAILED \n
- * @since_tizen @if WEARABLE 3.0 @endif
+ * @since_tizen 3.0
*
* @param[in] result The result of getting the phone book size
* @param[in] remote_address The remote device address (@a remote_address is valid only inside this function. To use outside the callback, make a copy. @a remote_address should not be freed.)
int size, void *user_data);
/**
+ * @WEARABLE_ONLY
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Called when PBAP Phonebook Pull completes.
* @details The received phone book file will be saved in the platform downloads folder. \n
* The following error codes can be delivered: \n
* #BT_ERROR_NONE \n
* #BT_ERROR_OPERATION_FAILED \n
- * @since_tizen @if WEARABLE 3.0 @endif
+ * @since_tizen 3.0
*
* @param[in] result The result of getting the phone book
* @param[in] remote_address The remote device address (@a remote_address is valid only inside this function. To use outside the callback, make a copy. @a remote_address should not be freed.)
const char *vcf_file, void *user_data);
/**
+ * @WEARABLE_ONLY
* @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE
* @brief Called when PBAP List vCards completes.
* @details The following error codes can be delivered: \n
* #BT_ERROR_NONE \n
* #BT_ERROR_OPERATION_FAILED \n
- * @since_tizen @if WEARABLE 3.0 @endif
+ * @since_tizen 3.0
*
* @param[in] result The result of getting the vcard list
* @param[in] remote_address The remote device address (@a remote_address is valid only inside this function. To use outside the callback, make a copy. @a remote_address should not be freed.)