doc_prod/account_manager_doc.h

   1 /*
   2  *
   3  * Copyright (c) 2012 - 2013 Samsung Electronics Co., Ltd. All rights reserved.
   4  *
   5  * Contact: Wonyoung Lee <wy1115.lee@samsung.com>, Sungchan Kim <sungchan81.kim@samsung.com>
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 #ifndef __ACCOUNT_PRODUCT_H__
  22 #define __ACCOUNT_PRODUCT_H__
  23
  24 /**
  25  * @defgroup  CAPI_ACCOUNT_MANAGER_MODULE Account Manager
  26  * @ingroup   CAPI_SOCIAL_FRAMEWORK
  27  * @brief     The account APIs provide CRUD (Create, Read, Update, Delete) account management functionality.
  28  *
  29  * @section   CAPI_ACCOUNT_MANAGER_HEADER Required Header
  30  *  \#include <account_product.h>
  31  *
  32  * @section CAPI_ACCOUNT_MANAGER_MODULE_OVERVIEW Overview
  33  * The account APIs is separated into two major sections:
  34  * 1. Registering an account provider while an application is installed. This information will be used for the Add account screen.
  35  * 2. Adding an account information when an application signs in successfully to share the account information to the Tizen system. This information will be shown in the Tizen settings account menu.
  36
  37  * The APIs of both of the sections consist of the following functionality:
  38  * - Create an account or account provider
  39  * - Update an account or account provider(Only available for the creator)
  40  * - Delete an account or account provider(Only available for the creator)
  41  * - Read an account or account provider with some filter
  42 */
  43
  44 #endif /* __ACCOUNT_PRODUCT_H__  */