*
* @return An error code
* @param[in] address An address of the %Bluetooth device
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified address is invalid @n
- * The size of the address should be 6 bytes.
- * @remarks @c address must have 6 byte data (remaining elements). @n
- * Setting the address of the %BluetoothDevice instance which is obtained from the paired list does not
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified address is invalid. @n
+ * The size of the address should be @c 6 bytes.
+ * @remarks Setting the address of the %BluetoothDevice instance which is obtained from the paired list does not
* affect the information of the paired list in the system.
*/
result SetAddress(const Tizen::Base::ByteBuffer& address);
* @since 2.0
*
* @return The service class of the device
- * @remarks This operation is not supported in the local device acquired by BluetoothManager::GetLocalDevice().
*/
unsigned long GetServiceClassList(void) const;
* @since 2.0
*
* @return The %Bluetooth device service list
- * @remarks This operation is not supported in the local device acquired by BluetoothManager::GetLocalDevice().
*/
unsigned long GetServiceList(void) const;
* @since 2.0
*
* @return The %Bluetooth device service UUID list
- * @remarks This operation returns @c null, if it is called in the local device acquired by
- * BluetoothManager::GetLocalDevice().
*/
const Tizen::Base::Collection::IList* GetServiceUuidList(void) const;
virtual int GetHashCode(void) const;
/**
- * Gets a new instance of %BluetoothDevice generated using the result of the %Bluetooth AppControl.
+ * Gets a new instance of %BluetoothDevice that is generated using the result of the %Bluetooth AppControl.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because the type of AppControl result is changed. Instead of using this
- * method, GetInstanceFromAppControlResultN(const Tizen::Base::Collection::IMap& appControlResult) is
+ * @deprecated This method is deprecated because the type of AppControl result has changed. Instead of using this
+ * method, GetInstanceFromAppControlResultN(const Tizen::Base::Collection::IMap&) is
* recommended.
*
* @since 2.0
- * @return The %Bluetooth device containing the specified information extracted from the input data if successful,
- * @n
+ * @return The %Bluetooth device containing the specified information extracted from the input data if successful, @n
* else @c null
* @param[in] appControlResult The data list, which is the result of the %Bluetooth AppControl
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c appControlResult contains an invalid value. @n
+ * @exception E_INVALID_ARG The specified list contains an invalid value. @n
* The result of %Bluetooth AppControl is only permitted to be used as an input
* argument.
* @remarks The specific error code can be accessed using the GetLastResult() method.
static BluetoothDevice* GetInstanceFromAppControlResultN(const Tizen::Base::Collection::IList& appControlResult);
/**
- * Gets a new instance of %BluetoothDevice generated using the result of the %Bluetooth AppControl.
+ * Gets a new instance of %BluetoothDevice that is generated using the result of the %Bluetooth AppControl.
*
* @since 2.1
- * @return The %Bluetooth device containing the specified information extracted from the input data if successful,
- * @n
+ * @return The %Bluetooth device containing the specified information extracted from the input data if successful, @n
* else @c null
* @param[in] appControlResult The data map, which is the result of the %Bluetooth AppControl
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c appControlResult contains an invalid value. @n
+ * @exception E_INVALID_ARG The specified map contains an invalid value. @n
* The result of %Bluetooth AppControl is only permitted to be used as an input
* argument.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*
* @return An error code
* @param[in] listener The event listener for the %BluetoothHealth. @n
- * Listener must be allocated at heap, not stack.
+ * The specified listener must be allocated at heap, not stack.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_UNSUPPORTED_OPERATION The device does not support the %Bluetooth feature.
result Construct(IBluetoothHealthEventListener& listener);
/**
- * Starts %Bluetooth health as a role of sink with the specified data type.
+ * Starts %Bluetooth health as a role of sink with the specified data type. @n
+ * One %BluetoothHealth instance supports only a sink role with the specific data type at one time and
+ * only one sink role for the specific data type can be enabled system-widely. @n
+ * For providing sink roles with various data types, make multiple %BluetoothHealth instances with different data types.
*
* @since 2.0
* @privlevel public
* instance or application.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_OPERATION_FAILED The method has failed.
- * @remarks One %BluetoothHealth instance supports only a sink role with the specific data type at one time and
- * only one sink role for the specific data type can be enabled system-widely. For providing sink
- * roles with various data types, make multiple %BluetoothHealth instances with different data types.
*/
result StartAsSink(int dataType);
* @privilege http://tizen.org/privilege/bluetooth.health
*
* @return An error code
- * @param[in] channelId The ID of the specified channel to disconnect
+ * @param[in] channelId The ID of the specified channel to disconnect. @n
+ * The ID can be obtained by IBluetoothHealthEventListener::OnHealthConnected() after the
+ * specific channel is established.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE %Bluetooth is not activated.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified
* For example, there is no connection with the specified channel ID.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_OPERATION_FAILED The method has failed.
- * @see IBluetoothHealthEventListener::OnHealthDisconnected()
- * @remarks @c channelId value can be obtained by IBluetoothHealthEventListener::OnHealthConnected() after the
- * specific channel is established.
*/
result Disconnect(int channelId);
* @privilege http://tizen.org/privilege/bluetooth.health
*
* @return An error code
- * @param[in] channelId The ID of the specified channel on which the data is sent
+ * @param[in] channelId The ID of the specified channel on which the data is sent. @n
+ * The ID can be obtained by IBluetoothHealthEventListener::OnHealthConnected() after the
+ * specific channel is established.
* @param[in] buffer The data to send
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE %Bluetooth is not activated.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_OPERATION_FAILED The operation has failed.
* @see IBluetoothHealthEventListener::OnHealthDataReceived()
- * @remarks @c channelId value can be obtained by IBluetoothHealthEventListener::OnHealthConnected() after the
- * specific channel is established.
*/
result SendData(int channelId, const Tizen::Base::ByteBuffer& buffer);
*
* @since 2.0
*
- * @return The local %Bluetooth device address
- * @remarks The address is expressed as a @c 6 byte hexadecimal value delimited by colons. @n
- * For example, "00:3D:47:EF:8A:03".
+ * @return The local %Bluetooth device address @n
+ * The address is expressed as a @c 6 byte hexadecimal value delimited by colons. @n
+ * For example, "00:3D:47:EF:8A:03".
*/
Tizen::Base::String GetLocalDeviceAddress(void) const;
/**
* Gets the remaining time, in seconds, until the discoverable mode is changed from
- * @c BT_DISC_MODE_TIME_LIMITED_DISCOVERABLE to be @c BT_DISC_MODE_NOT_DISCOVERABLE. @n
+ * ::BT_DISC_MODE_TIME_LIMITED_DISCOVERABLE to be ::BT_DISC_MODE_NOT_DISCOVERABLE. @n
* This method is valid only if the current discoverable mode is @c BT_DISC_MODE_TIME_LIMITED_DISCOVERABLE.
*
* @since 2.0
*
- * @return The remaining time, in seconds, until the local device to be not discoverable.
- * @remarks 0 will be returned if the current discoverable mode is not @c BT_DISC_MODE_TIME_LIMITED_DISCOVERABLE.
+ * @return The remaining time, in seconds, until the local device to be not discoverable. @n
+ * @c 0 will be returned if the current discoverable mode is not @c BT_DISC_MODE_TIME_LIMITED_DISCOVERABLE.
*/
int GetRemainingTimeAsDiscoverable(void) const;
bool IsDiscoveryInProgress(void) const;
/**
- * Sets the name of the local device.
- *
+ * Sets the name of the local device. @n
+ * The searching device detects the local devices in close proximity based on the specified device name, and
+ * the name is only valid while an application is active.
* @since 2.0
* @privlevel public
* @privilege http://tizen.org/privilege/bluetooth.admin
*
* @return An error code
- * @param[in] deviceName The new device name
+ * @param[in] deviceName The new device name. @n
+ * The specified device name is automatically truncated if its size is greater than @c 64 bytes.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified device name is an empty string.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SYSTEM A system error has occurred.
- * @remarks This method does not affect the system settings. The device name is only valid while an application
- * is active. The searching device detects the local devices in close proximity based on the specified
- * device name. The specified device name is automatically truncated if its size is greater than @c 64
- * bytes.
+ * @remarks This method does not affect the system settings.
*/
result SetLocalDeviceName(const Tizen::Base::String& deviceName);
*
* @return An error code
* @param[in] mode The new discoverable mode
- * @param[in] seconds The duration in seconds for which the local device is discoverable
+ * @param[in] seconds The duration in seconds for which the local device is discoverable. @n
+ * The specified duration is adopted only if the specified @c mode is @c BT_DISC_MODE_TIME_LIMITED_DISCOVERABLE.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c seconds should be greater than 0 if the specified
- * @c mode is @c BT_DISC_MODE_TIME_LIMITED_DISCOVERABLE.
+ * @c mode is @c BT_DISC_MODE_TIME_LIMITED_DISCOVERABLE.
* @exception E_INVALID_OPERATION %Bluetooth is not activated.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SYSTEM A system error has occurred.
* @see IBluetoothManagerEventListener::OnBluetoothDiscoverableModeChanged()
- * @remarks @c seconds is adopted only if the specified @c mode is @c BT_DISC_MODE_TIME_LIMITED_DISCOVERABLE.
*/
result SetDiscoverableMode(BluetoothDiscoverableMode mode, int seconds = 0);
Tizen::Base::Collection::IList* GetPairedDeviceListN(void) const;
/**
- * Sets a remote device event listener for searching devices and services.
+ * Sets a remote device event listener for searching devices and services. @n
*
* @since 2.0
*
* @return An error code
- * @param[in] pListener The device event listener to add
+ * @param[in] pListener The device event listener to set @n
+ * If the specified listener is @c null, the listener currently set is unregistered.
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks Only one event listener can be set. If the input parameter is @c null, the listener currently set
- * is unregistered.
+ * @remarks Only one event listener can be set.
*/
result SetBluetoothDeviceListener(IBluetoothDeviceEventListener* pListener);
* @exception E_IN_PROGRESS The termination of the pairing process is in progress.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SYSTEM A system error has occurred.
- * @remarks If the canceling of the pairing process is successful,
- * IBluetoothDeviceEventListener::OnBluetoothPairingFailed() is called with E_OPERATION_CANCELED.
+ * @remarks If the canceling of the pairing process is successful, @n
+ * IBluetoothDeviceEventListener::OnBluetoothPairingFailed() is called with @c E_OPERATION_CANCELED.
*/
result CancelPair(void);
/**
- * Unpairs with the paired device.
+ * Unpairs with the paired device. @n
+ * The process of unpairing is to remove the specified device from the paired device list. No
+ * notification is transmitted to the remote device. @n
+ * This method is synchronous.
+ * Only when the result of this method is @c E_SUCCESS, the unpaired event is fired.
*
* @since 2.0
* @privlevel public
* @exception E_NOT_PAIRED The input device is not found in the paired device list.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The process of unpairing is to remove the specified device from the paired device list. No
- * notification is transmitted to the remote device. @n
- * This method is synchronous. Only when the result of this method is E_SUCCESS, the unpaired event is
- * fired.
* @see IBluetoothDeviceEventListener::OnBluetoothUnpaired()
*/
result Unpair(const BluetoothDevice& pairedDevice);
/**
* Cancels the file push request in progress. @n
* If this method is called before the OPP server accepts the push request, the
- * IBluetoothOppClientEventListener::OnOppPushResponded() method is called and the exception E_SYSTEM is thrown. @n
+ * IBluetoothOppClientEventListener::OnOppPushResponded() method is called and its result @c E_SYSTEM is thrown. @n
* If this method is called during the file transfer, the IBluetoothOppClientEventListener::OnOppTransferDone()
* method is called with @c isCompleted as @c false.
*
* For example, the push request is not sent or accepted by a remote device.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_FAILURE The method has failed.
- * @see IBluetoothOppClientEventListener::OnOppPushResponded()
- * @see IBluetoothOppClientEventListener::OnOppTransferDone()
*/
result CancelPush(void);
* @param[in] percent The minimum period of progress interval as a percentage value
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method.
- * @see IBluetoothOppClientEventListener::OnOppTransferInProgress()
*/
result SetMinProgressInterval(int percent);
* For example, the file transfer is not in progress.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_OPERATION_FAILED The operation has failed.
- * @see IBluetoothOppServerEventListener::OnOppTransferDone()
*/
result StopTransfer(void);
* @privilege http://tizen.org/privilege/bluetooth.spp
*
* @return An error code
- * @param[in] buffer The data to send
+ * @param[in] buffer The data to send. @n
+ * The size of the buffer should not exceed @c 1000 bytes.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state. @n
* For example, this instance has not been constructed as yet or %Bluetooth is
* @exception E_SYSTEM A system error has occurred.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_FAILURE The method has failed.
- * @remarks The size of the buffer should not exceed @c 1000 bytes.
* @see IBluetoothSppInitiatorEventListener::OnSppDataReceived()
*/
result SendData(const Tizen::Base::ByteBuffer& buffer);
/**
* Disconnects the current connection. @n
* If this method is called before the SPP acceptor accepts the connection request, the
- * IBluetoothSppInitiatorEventListener::OnSppConnectionResponded() and E_SYSTEM is thrown. @n
+ * IBluetoothSppInitiatorEventListener::OnSppConnectionResponded() and its result @c E_SYSTEM is thrown. @n
* If this method is called on connection, the IBluetoothSppInitiatorEventListener::OnSppDisconnected() and
- * E_SUCCESS is thrown.
+ * its result @c E_SUCCESS is thrown.
*
* @since 2.0
* @privlevel public
* remote device is not established yet.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_FAILURE The method has failed.
- * @see IBluetoothSppInitiatorEventListener::OnSppConnectionResponded()
- * @see IBluetoothSppInitiatorEventListener::OnSppDisconnected()
* @see IBluetoothSppAcceptorEventListener::OnSppDisconnected()
*/
result Disconnect(void);
* @privilege http://tizen.org/privilege/bluetooth.spp
*
* @return An error code
- * @param[in] buffer The data to send
+ * @param[in] buffer The data to send. @n
+ * The size of the buffer should not exceed @c 1000 bytes.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state. @n
* For example, this instance has not been constructed as yet or %Bluetooth is
* @exception E_SYSTEM A system error has occurred.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_FAILURE The method has failed.
- * @remarks The size of the buffer should not exceed @c 1000 bytes.
* @see IBluetoothSppAcceptorEventListener::OnSppDataReceived()
*/
result SendData(const Tizen::Base::ByteBuffer& buffer);
virtual void OnBluetoothDiscoveryStarted(result r) = 0;
/**
- * Called when a remote device is found during the device discovery process.
+ * Called when a remote device is found during the device discovery process. @n
+ * This event may be issued only if the device discovery process has started successfully.
*
* @since 2.0
*
* @param[in] pFoundDevice The remote device that is found
- * @remarks This event may be issued only if the device discovery process has started successfully.
* @see BluetoothManager::StartDiscovery()
*/
virtual void OnBluetoothRemoteDeviceFoundN(BluetoothDevice* pFoundDevice) = 0;
/**
- * Called when the device discovery process for finding the nearby %Bluetooth devices has completed.
+ * Called when the device discovery process for finding the nearby %Bluetooth devices has completed. @n
+ * This event must be issued only if the discovery starts successfully.
*
* @since 2.0
*
* @param[in] isCompleted Set to @c true if the device discovery process is successfully completed, @n
* else @c false @n
* For example, the discovery is canceled.
- * @remarks This event must be issued only if the discovery starts successfully.
* @see BluetoothManager::CancelDiscovery()
*/
virtual void OnBluetoothDiscoveryDone(bool isCompleted) = 0;
* @since 2.0
*
* @param[in] targetDevice The remote device that sends its service list
- * @param[in] serviceList The service list that is received
+ * @param[in] serviceList The service list that is received. @n
+ * The specified service list consists of Bluetooth::BluetoothServiceType values which are joined by OR operator.
* @param[in] r The result of receiving the service list
* @exception E_SUCCESS The method is successful.
* @exception E_REMOTE_SERVICE_NOT_FOUND The service list of the remote device is not found.
* @exception E_SYSTEM A system error has occurred.
- * @remarks @c serviceList consists of Bluetooth::BluetoothServiceType values which are joined by OR
- * operator.
*/
virtual void OnBluetoothServiceListReceived(const BluetoothDevice& targetDevice, unsigned long serviceList, result r) = 0;
/**
- * Called when a new remote device is paired with this local device.
+ * Called when a new remote device is paired with this local device. @n
+ * This method is able to be called even though the specified device already exists in the paired
+ * device list. Because the authorized key with the remote device is no more valid. @n
+ * If the pairing is explicitly requested by BluetoothManager::Pair() and the request fails,
+ * OnBluetoothPairingFailed() is called instead of this method.
*
* @since 2.0
*
- * @param[in] pairedDevice The device to pair with the local device
- * @remarks This method is able to be called even though the specified device already exists in the paired
- * device list. Because the authorized key with the remote device is no more valid. @n
- * @c pairedDevice may have no service list value and elements in the service UUID list because the
- * retrieving the service list from the remote device fails. In that case, call
- * BluetoothManager::RetrieveServiceList() to get the service list from the paired device. @n
- * If the pairing is explicitly requested by BluetoothManager::Pair() and the request fails,
- * IBluetoothDeviceEventListener::OnBluetoothPairingFailed() is called instead of this method.
- * @see BluetoothManager::Pair()
- * @see OnBluetoothPairingFailed()
+ * @param[in] pairedDevice The device to pair with the local device. @n
+ * The specified device may have no service list value and elements in the service UUID list because the
+ * retrieving the service list from the remote device fails.@n
+ * In that case, call BluetoothManager::RetrieveServiceList() to get the service list from the paired device.
*/
virtual void OnBluetoothPaired(const BluetoothDevice& pairedDevice) = 0;
* One of the following exception is thrown.
* @exception E_OPERATION_CANCELED The pairing operation is canceled explicitly.
* @exception E_TIMEOUT The pairing request has timed out because the remote device does not
- * respond within 60 seconds.
+ * respond within @c 60 seconds.
* @exception E_OPERATION_FAILED The operation has failed.
* @see BluetoothManager::Pair()
* @see BluetoothManager::CancelPair()
*
* @since 2.0
* @param[in] channelId The channel ID of the established connection, @n
- * else an invalid ID (-1) if the method is not successful
+ * else an invalid ID (@c -1) if the method is not successful
* @param[in] dataType The type of data used in the established connection which is defined in
* ISO/IEEE 11073-20601 and represents type of health device such as thermometer,
* heart rate monitor, weight scale, and so on
*
* @since 2.0
*
- * @param[in] fileName The name of the file to transfer
- * @param[in] fileSize The size of the file to transfer
- * @param[in] isCompleted Set to @c true if the transfer is successfully completed, @n
- * else @c false
- * @remarks If the name of the received file already exists in the destination path, the received file is renamed
- * automatically and @c isCompleted is set to @c true. For renaming, the specified postfix is appended to
- * the original file name. The postfix consists of an underscore and three digit sequence numbers starting
- * from 001. For example, "MySong.mp3" may be changed to "MySong_001.mp3".
+ * @param[in] fileName The name of the file to transfer. @n
+ * If the name of the received file already exists in the destination path, the received file is renamed
+ * automatically and @c isCompleted is set to @c true. For renaming, the specified postfix is appended to
+ * the original file name. The postfix consists of an underscore and three digit sequence numbers starting
+ * from 001. For example, "MySong.mp3" may be changed to "MySong_001.mp3".
+ * @param[in] fileSize The size of the file to transfer
+ * @param[in] isCompleted Set to @c true if the transfer is successfully completed, @n
+ * else @c false
*/
virtual void OnOppTransferDone(const Tizen::Base::String& fileName, int fileSize, bool isCompleted) = 0;
* @since 2.0
*
* The %IBluetoothSppInitiatorEventListener interface specifies the methods used for creating notifications about the
- * different kinds of BluetoothSppInitiator events. When a BluetoothSppInitiator event is generated, one of these
+ * different kinds of BluetoothSppInitiator events. When a %BluetoothSppInitiator event is generated, one of these
* methods is called.
*
* For more information on the class features, see
projects / platform / framework / native / bluetooth.git / commitdiff