* Constructs and initializes an instance of the %BluetoothManager class with the specified listener.
*
* @since 2.0
+ * @feature %http://tizen.org/feature/network.bluetooth
*
* @return An error code
- * @param[in] listener The listener to handle the %BluetoothManager event
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_UNSUPPORTED_OPERATION This operation is not supported.
- * @exception E_SYSTEM A system error has occurred.
+ * @param[in] listener The listener to handle the %BluetoothManager event
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * For more information, see
+ * <a href=”../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm”>
+ * Application Filtering</a>.
+ * @exception E_SYSTEM A system error has occurred.
*/
result Construct(IBluetoothManagerEventListener& listener);
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_IN_PROGRESS The %Bluetooth activation process is in progress.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the
- * specified operation. @n
- * For example, %Bluetooth is already activated.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_IN_PROGRESS The %Bluetooth activation process is in progress.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified
+ * operation. @n
+ * For example, %Bluetooth is already activated.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @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::OnBluetoothActivated()
*/
result Activate(void);
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_IN_PROGRESS The %Bluetooth deactivation process is in progress.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the
- * specified operation. @n
- * For example, the %Bluetooth is already deactivated.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_IN_PROGRESS The %Bluetooth deactivation process is in progress.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified
+ * operation. @n
+ * For example, the %Bluetooth is already deactivated.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @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::OnBluetoothDeactivated()
*/
result Deactivate(void);
*
* @return @c true if the specified type of connection is available, @n
* else @c false
- * @param[in] type The connection type
+ * @param[in] type The connection type
*
* @endif
*/
* @since 2.0
*
* @return The local device information
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @endif
*/
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @return An error code
- * @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.
+ * @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.
*/
result SetLocalDeviceName(const Tizen::Base::String& deviceName);
* @privilege %http://tizen.org/privilege/bluetoothmanager
*
* @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. @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.
- * @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.
+ * @param[in] mode The new discoverable mode
+ * @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.
+ * @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()
*/
result SetDiscoverableMode(BluetoothDiscoverableMode mode, int seconds = 0);
* @since 2.0
*
* @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_SYSTEM A system error has occurred.
* @endif
*/
result RefreshPairedDeviceList(void);
*
* @return The instance of %BluetoothDevice containing the specified address, @n
* else @c null if the search is not successful
- * @param[in] deviceAddress The address to locate
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified device is not found in the paired device list.
+ * @param[in] deviceAddress The address to locate
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The specified device is not found in the paired device list.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @endif
*/
*
* @return The instance of %BluetoothDevice containing the specified address, @n
* else @c null if the search is not successful
- * @param[in] deviceAddress The address to locate
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified device is not found in the paired device list.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @param[in] deviceAddress The address to locate
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The specified device is not found in the paired device list.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
BluetoothDevice* GetPairedDeviceByAddressN(const Tizen::Base::ByteBuffer& deviceAddress) const;
*
* @return A list containing the matching devices, @n
* else @c null if the search is not successful
- * @param[in] deviceName The name of the device to locate
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified device is not found in the paired device list.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @param[in] deviceName The name of the device to locate
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The specified device is not found in the paired device list.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* GetPairedDeviceByNameN(const Tizen::Base::String& deviceName) const;
*
* @return The instance of %BluetoothDevice at the specified index, @n
* else @c null if there is no element
- * @param[in] index The index in the list
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified index is not found in the paired device list.
+ * @param[in] index The index in the list
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The specified index is not found in the paired device list.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @endif
*/
*
* @return A pointer to the paired device list on success, @n
* else @c null
- * @exception E_SUCCESS The method is successful.
+ * @exception E_SUCCESS The method is successful.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @endif
*/
*
* @return A pointer to the paired device list on success, @n
* else @c null
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* GetPairedDeviceListN(void) const;
* @since 2.0
*
* @return An error code
- * @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.
+ * @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.
*/
result SetBluetoothDeviceListener(IBluetoothDeviceEventListener* pListener);
* @privilege %http://tizen.org/privilege/bluetooth.gap
*
* @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_IN_PROGRESS The device discovery process is in progress.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this
- * operation.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_IN_PROGRESS The device discovery process is in progress.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this
+ * operation.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_SYSTEM A system error has occurred.
* @see IBluetoothDeviceEventListener::OnBluetoothDiscoveryStarted()
* @see IBluetoothDeviceEventListener::OnBluetoothRemoteDeviceFoundN()
* @see IBluetoothDeviceEventListener::OnBluetoothDiscoveryDone()
* @privilege %http://tizen.org/privilege/bluetooth.gap
*
* @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_IN_PROGRESS The termination of the device discovery process is in progress.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this
- * operation. @n
- * For example, the discovery has not started as yet.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_IN_PROGRESS The termination of the device discovery process is in progress.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this
+ * operation. @n
+ * For example, the discovery has not started as yet.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_SYSTEM A system error has occurred.
* @see IBluetoothDeviceEventListener::OnBluetoothDiscoveryDone()
*/
result CancelDiscovery(void);
* @privilege %http://tizen.org/privilege/bluetooth.gap
*
* @return An error code
- * @param[in] pairedDevice A remote device that is already paired with the local device
- * @exception E_SUCCESS The method is successful.
- * @exception E_IN_PROGRESS The retrieving is in progress.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this
- * operation. @n
- * For example, the discovery is in progress.
- * @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.
+ * @param[in] pairedDevice A remote device that is already paired with the local device
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_IN_PROGRESS The retrieving is in progress.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this
+ * operation. @n
+ * For example, the discovery is in progress.
+ * @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 target remote device should be a paired device.
* @see IBluetoothDeviceEventListener::OnBluetoothServiceListReceived()
*/
* @privilege %http://tizen.org/privilege/bluetooth.gap
*
* @return An error code
- * @param[in] remoteDevice The remote %Bluetooth device to pair with
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this
- * operation. @n
- * For example, the %Bluetooth is not activated.
- * @exception E_DEVICE_BUSY The device cannot be approached because other operation 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.
+ * @param[in] remoteDevice The remote %Bluetooth device to pair with
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this
+ * operation. @n
+ * For example, the %Bluetooth is not activated.
+ * @exception E_DEVICE_BUSY The device cannot be approached because other operation 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 IBluetoothDeviceEventListener::OnBluetoothPaired() is called if the pairing is successful, @n
* IBluetoothDeviceEventListener::OnBluetoothPairingFailed() if the pairing has failed.
*/
* @privilege %http://tizen.org/privilege/bluetooth.gap
*
* @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this
- * operation. @n
- * For example, the pairing process is not in progress.
- * @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.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this
+ * operation. @n
+ * For example, the pairing process is not in progress.
+ * @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, @n
* IBluetoothDeviceEventListener::OnBluetoothPairingFailed() is called with @c E_OPERATION_CANCELED.
*/
* @privilege %http://tizen.org/privilege/bluetooth.gap
*
* @return An error code
- * @param[in] pairedDevice The paired device to unpair
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this
- * operation. @n
- * For example, the %Bluetooth is not activated, or retrieving the service
- * list is in progress.
- * @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.
+ * @param[in] pairedDevice The paired device to unpair
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of this
+ * operation. @n
+ * For example, the %Bluetooth is not activated, or retrieving the service
+ * list is in progress.
+ * @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.
* @see IBluetoothDeviceEventListener::OnBluetoothUnpaired()
*/
result Unpair(const BluetoothDevice& pairedDevice);
private:
//
- // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying
- // of objects.
+ // The implementation of this copy constructor is intentionally blank to prohibit copying of objects.
//
BluetoothManager(const BluetoothManager& value);
//
- // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit
- // copying of objects.
+ // The implementation of this copy assignment operator is intentionally blank to prohibit copying of objects.
//
BluetoothManager& operator =(const BluetoothManager& value);