doc/push-service_doc.h

   1 /*\r
   2  * Copyright (c) 2000 - 2012 Samsung Electronics Co., Ltd All Rights Reserved\r
   3  *\r
   4  * Licensed under the Apach     e License, Version 2.0 (the "License");\r
   5  * you may not use this file except in compliance with the License.\r
   6  * You may obtain a copy of the License at\r
   7  *\r
   8  * http://www.apache.org/licenses/LICENSE-2.0\r
   9  *\r
  10  * Unless required by applicable law or agreed to in writing, software\r
  11  * distributed under the License is distributed on an "AS IS" BASIS,\r
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  13  * See the License for the specific language governing permissions and\r
  14  * limitations under the License.\r
  15  */\r
  16 \r
  17 \r
  18 #ifndef __PUSH_SERVICE_DOC_H__\r
  19 #define __PUSH_SERVICE_DOC_H__\r
  20 \r
  21 /**\r
  22  * @ingroup CAPI_MESSAGING_FRAMEWORK\r
  23  * @defgroup CAPI_MESSAGING_PUSH_PUBLIC_MODULE Push\r
  24  * @brief The @ref CAPI_MESSAGING_PUSH_PUBLIC_MODULE API provides functions to receive push notifications.\r
  25  *\r
  26  * @addtogroup CAPI_MESSAGING_PUSH_PUBLIC_MODULE\r
  27  *\r
  28  * @section CAPI_MESSAGING_PUSH_PUBLIC_MODULE_HEADER Required Header\r
  29  *   \#include <push-service.h>\r
  30  *\r
  31  * @section CAPI_MESSAGING_PUSH_PUBLIC_MODULE_OVERVIEW Overview\r
  32  *\r
  33  * The Push API allows your application to receive push notifications from a push server.\r
  34  * The push service is a client daemon that maintains a permanent connection between your device\r
  35  * and the push server, in order to process your registration/deregistration requests and\r
  36  * deliver push notifications to your application. If the application is connected,\r
  37  * the push service passes the notification data over the connection. Otherwise,\r
  38  * the push service posts a UI notification with the data.\r
  39  * It will be delivered when a user launches the application by selecting the posting.\r
  40  *\r
  41  * To receive push notifications, you need to follow the steps below:\r
  42  *\r
  43  * - Connecting to the push service\r
  44  * - Registering your application\r
  45  * - Getting notification data\r
  46  *\r
  47  * Push notification helps your application server send data to the application on devices\r
  48  * over an IP network even if the application is not running.\r
  49  * Push notification may reduce battery consumption over other applications keeping its own connection\r
  50  * to its remote application server.\r
  51  * @image html capi_messaging_push_overview1.png\r
  52  *\r
  53  * @subsection CAPI_MESSAGING_PUSH_PUBLIC_LIMITATIONS Service Limitation\r
  54  * - Payload of a push message is limited to 4096 bytes.\r
  55  * - Administrative permission is needed for your application and server to use the push service.\r
  56  * - Push service does not guarantee delivery and order of push messages.\r
  57  * - A device should have a valid IMEI number.\r
  58  * <BR>\r
  59  */\r
  60 \r
  61 #endif /* __PUSH_SERVICE_DOC_H__ */\r