2 // Open Service Platform
3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
5 // Licensed under the Apache License, Version 2.0 (the License);
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
9 // http://www.apache.org/licenses/LICENSE-2.0
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
19 * @file FWebCtrlAuthenticationChallenge.h
20 * @brief This is the header file for the %AuthenticationChallenge class.
22 * This header file contains the declarations of the %AuthenticationChallenge class.
25 #ifndef _FWEB_CTRL_AUTHENTICATION_CHALLENGE_H_
26 #define _FWEB_CTRL_AUTHENTICATION_CHALLENGE_H_
28 #include <FBaseDataType.h>
29 #include <FBaseObject.h>
30 #include <FBaseString.h>
32 namespace Tizen { namespace Web { namespace Controls
37 * @class AuthenticationChallenge
38 * @brief This class handles the HyperText Transfer Protocol (HTTP) authentication requests.
42 * The %AuthenticationChallenge class sends the user ID and password to the server requesting user authentication.
44 * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/web/controls_namespace.htm">Web Controls Guide</a>.
46 class _OSP_EXPORT_ AuthenticationChallenge
47 : public Tizen::Base::Object
51 * This destructor overrides Tizen::Base::Object::~Object().
55 virtual ~AuthenticationChallenge(void);
58 * Sends the user ID and password to the host.
62 * @privilege %http://tizen.org/privilege/web.privacy
64 * @param[in] userId The user ID for authentication
65 * @param[in] password The password for authentication
66 * @exception E_SUCCESS The method is successful.
67 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
68 * @remarks The specific error code can be accessed using the GetLastResult() method.
70 void Process(const UserId& userId, const Tizen::Base::String& password);
73 * Cancels the authentication request.
77 * @privilege %http://tizen.org/privilege/web.privacy
79 * @exception E_SUCCESS The method is successful.
80 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
81 * @remarks The specific error code can be accessed using the GetLastResult() method.
87 // This is the constructor for the %AuthenticationChallenge class.
89 // @remarks This constructor is hidden.
91 AuthenticationChallenge(void);
94 friend class _WebImpl;
95 friend class _AuthenticationChallengeImpl;
96 class _AuthenticationChallengeImpl* __pAuthenticationChallengeImpl;
97 }; // AuthenticationChallenge
99 }}} // Tizen::Web::Controls
100 #endif // _FWEB_CTRL_AUTHENTICATION_CHALLENGE_H_