tizen_src/ewk/efl_integration/public/ewk_auth_challenge_internal.h

   1 /*
   2  * Copyright (C) 2012 Samsung Electronics
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public License
  15  * along with this library; see the file COPYING.LIB.  If not, write to
  16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17  * Boston, MA 02110-1301, USA.
  18  */
  19
  20 /**
  21  * @file    ewk_auth_challenge_internal.h
  22  * @brief   Describes the authentication challenge API.
  23  */
  24
  25 #ifndef ewk_auth_challenge_internal_h
  26 #define ewk_auth_challenge_internal_h
  27
  28 #include <Eina.h>
  29 #include <tizen.h>
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 /** Creates a type name for _Ewk_Auth_Challenge */
  36 typedef struct _Ewk_Auth_Challenge Ewk_Auth_Challenge;
  37
  38 /**
  39  * Gets the realm string of authentication challenge received from "Ewk_View_Authentication_Callback" function.
  40  *
  41  * @param auth_challenge authentication challenge instance received from "Ewk_View_Authentication_Callback" function.
  42  * @return the realm of authentication challenge on success, @c 0 otherwise
  43  *
  44  * @see ewk_view_authentication_callback_set
  45  */
  46 EXPORT_API const char* ewk_auth_challenge_realm_get(Ewk_Auth_Challenge* auth_challenge);
  47
  48 /**
  49  * Gets the url string of authentication challenge received from "Ewk_View_Authentication_Callback" function.
  50  *
  51  * @param auth_challenge authentication challenge request instance received from "Ewk_View_Authentication_Callback" function.
  52  * @return the url of authentication challenge on success, @c 0 otherwise
  53  *
  54  * @see ewk_view_authentication_callback_set
  55  */
  56 EXPORT_API const char* ewk_auth_challenge_url_get(Ewk_Auth_Challenge* auth_challenge);
  57
  58 /**
  59  * Suspend the operation for authentication challenge.
  60  *
  61  * @param auth_challenge authentication challenge instance received from "Ewk_View_Authentication_Callback" function.
  62  *
  63  * @see ewk_view_authentication_callback_set
  64  */
  65 EXPORT_API void ewk_auth_challenge_suspend(Ewk_Auth_Challenge* auth_challenge);
  66
  67 /**
  68  *  If user select ok, send credential for authentication challenge from user input.
  69  *
  70  * @param auth_challenge authentication challenge instance received from "Ewk_View_Authentication_Callback" function.
  71  * @param user user id from user input.
  72  * @param password user password from user input.
  73  *
  74  * @see ewk_view_authentication_callback_set
  75  */
  76 EXPORT_API void ewk_auth_challenge_credential_use(Ewk_Auth_Challenge* auth_challenge, const char* user, const char* password);
  77
  78 /**
  79  *  If user select cancel, send cancellation notification for authentication challenge.
  80  *
  81  * @param auth_challenge authentication challenge instance received from "Ewk_View_Authentication_Callback" function.
  82  *
  83  * @see ewk_view_authentication_callback_set
  84  */
  85 EXPORT_API void ewk_auth_challenge_credential_cancel(Ewk_Auth_Challenge* auth_challenge);
  86
  87 #ifdef __cplusplus
  88 }
  89 #endif
  90
  91 #endif // ewk_auth_challenge_internal_h