diff options
Diffstat (limited to 'inc/FNetBtBluetoothOppServer.h')
| -rwxr-xr-x | inc/FNetBtBluetoothOppServer.h | 47 |
1 files changed, 29 insertions, 18 deletions
diff --git a/inc/FNetBtBluetoothOppServer.h b/inc/FNetBtBluetoothOppServer.h index 786fd1e..2a042ac 100755 --- a/inc/FNetBtBluetoothOppServer.h +++ b/inc/FNetBtBluetoothOppServer.h @@ -51,14 +51,17 @@ class _BluetoothOppServerImpl; * * For more information on the class features, see * <a href="../org.tizen.native.appprogramming/html/guide/net/bluetooth_namespace.htm">Bluetooth Guide</a>. + * + * The following diagram illustrates the interactions between this class and the application. + * @image html net_bluetooth_oppserver_sequence_diagram.png */ class _OSP_EXPORT_ BluetoothOppServer : public Tizen::Base::Object { public: /** - * The object is not fully constructed after this constructor is called. For full construction, the Construct() - * method must be called right after calling this constructor. + * The object is not fully constructed after this constructor is called. @n + * For full construction, the Construct() method must be called right after calling this constructor. * * @since 2.0 */ @@ -87,7 +90,7 @@ public: * Application Filtering</a>. * @exception E_SYSTEM A system error has occurred. * @remarks Before calling this method, check whether the feature is supported by - * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&). + * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&). */ result Construct(IBluetoothOppServerEventListener& listener); @@ -107,9 +110,9 @@ public: * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified * operation. @n * For example, the service is not started yet or a push request is not - * received from a remote device. + * received from the remote device. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_FAILURE The method has failed. * @see IBluetoothOppClientEventListener::OnOppPushResponded() */ @@ -130,9 +133,9 @@ public: * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified * operation. @n * For example, the service is not started yet or a push request is not - * received from a remote device. + * received from the remote device. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_FAILURE The method has failed. * @see IBluetoothOppClientEventListener::OnOppPushResponded() */ @@ -155,9 +158,13 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified * operation. @n - * For example, trying to change the path on Push transition is prohibited. - * @exception E_INACCESSIBLE_PATH The specified @c dstPath is inaccessible. + * For example, trying to change the path on a Push transition is prohibited. + * @exception E_INACCESSIBLE_PATH The specified input parameter is inaccessible. * @exception E_FAILURE The method has failed. + * @remarks + * - The destination path is either a media directory or an external storage directory. + * - Use Tizen::System::Environment::GetMediaPath() to access the media directory and + * Tizen::System::Environment::GetExternalStoragePath() to access the external storage directory. */ result SetDestinationPath(const Tizen::Base::String& dstPath); @@ -182,13 +189,17 @@ public: * For example, %Bluetooth is not activated. * @exception E_IN_PROGRESS The service has already started. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_SERVICE_UNAVAILABLE The OPP service is unavailable. - * @exception E_INACCESSIBLE_PATH The specified @c dstPath is inaccessible. + * @exception E_INACCESSIBLE_PATH The specified input parameter is inaccessible. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified * operation. @n - * For example, The stop process is in progress. + * For example, the stop process is in progress. * @exception E_FAILURE The method has failed. + * @remarks + * - The destination path is either a media directory or an external storage directory. + * - Use Tizen::System::Environment::GetMediaPath() to access the media directory and + * Tizen::System::Environment::GetExternalStoragePath() to access the external storage directory. */ result StartService(const Tizen::Base::String& dstPath); @@ -208,14 +219,14 @@ public: * operation. @n * For example, the service is not started as yet. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_IN_PROGRESS The stop process is in progress. * @exception E_FAILURE The method has failed. */ result StopService(void); /** - * Stops the file transfer in progress which was started by the client. @n + * Stops the file transfer in progress which is started by the client. @n * If the %StopTransfer() method is called during the file transfer, the IBluetoothOppServerEventListener::OnOppTransferDone() * method is called with @c isCompleted as @c false. * @@ -231,22 +242,22 @@ public: * operation. @n * 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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @exception E_OPERATION_FAILED The operation has failed. */ result StopTransfer(void); /** - * Sets the minimum interval of invocation of IBluetoothOppServerEventListener::OnOppTransferInProgress() in + * Sets the minimum interval for the invocation of IBluetoothOppServerEventListener::OnOppTransferInProgress() in * percentage. @n * The default value is @c 5. * * @since 2.0 * * @return An error code - * @param[in] percent The minimum period of progress interval as a percentage value + * @param[in] percent The minimum period of the progress interval as a percentage value * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. + * @exception E_OUT_OF_RANGE The specified input parameter is outside the valid range defined by the method. * @see IBluetoothOppServerEventListener::OnOppTransferInProgress() */ result SetMinProgressInterval(int percent); |