doc/push_doc.h

   1 /*
   2  * Copyright (c) 2000 - 2012 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apach     e License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17
  18 #ifndef __PUSH_DOC_H__
  19 #define __PUSH_DOC_H__
  20
  21 /**
  22  * @internal
  23  * @defgroup CAPI_MESSAGING_PUSH_MODULE Push-Internal
  24  * @brief The @ref CAPI_MESSAGING_PUSH_MODULE API provides functions to receive push notifications.
  25  * @ingroup CAPI_MESSAGING_FRAMEWORK
  26  *
  27  * @addtogroup CAPI_MESSAGING_PUSH_MODULE
  28  *
  29  * @section CAPI_MESSAGING_PUSH_MODULE_HEADER Required Header
  30  *   \#include <push.h>
  31  *
  32  * @section CAPI_MESSAGING_PUSH_MODULE_OVERVIEW Overview
  33  *
  34  * The Push API allows your application to receive push notifications from a push server.
  35  * The push service is a client daemon that maintains a permanent connection between your device
  36  * and the push server, in order to process your registration/deregistration requests and
  37  * deliver push notifications to your application. If the application is connected,
  38  * the push service passes the notification data over the connection. Otherwise,
  39  * the push service posts a UI notification with the data.
  40  * It will be delivered when a user launches the application by selecting the posting.
  41  *
  42  * To receive push notifications, you need to follow the steps below:
  43  *
  44  * - Connecting to the push service
  45  * - Registering your application
  46  * - Getting notification data
  47  *
  48  * Push notification helps your application server send data to the application on devices
  49  * over an IP network even if the application is not running.
  50  * Push notification may reduce battery consumption over other applications keeping its own connection
  51  * to its remote application server.
  52  * @image html capi_messaging_push_overview1.png
  53  *
  54  * @subsection CAPI_MESSAGING_PUSH_MODULE_OVERVIEW Service Limitation
  55  * - Payload of a push message is limited to 4096 bytes.
  56  * - Administrative permission is needed for your application and server to use the push service.
  57  * - Push service does not guarantee delivery and order of push messages.
  58  * - A device should have a valid IMEI number.
  59  *
  60  * @section CAPI_MESSAGING_PUSH_MODULE_FEATURE Related Features
  61  * This API is related with the following feature:
  62  *  - http://tizen.org/feature/network.push
  63  *
  64  * It is recommended to design feature related codes in your application for reliability.
  65  *
  66  * You can check if a devrice supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.
  67  *
  68  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.
  69  *
  70  * More details on featuring your application can be found from <a href="../org.tizen.mobile.native.appprogramming/html/ide_sdk_tools/feature_element.htm"><b>Feature Element</b>.</a>
  71  *
  72  */
  73
  74 #endif /* __PUSH_DOC_H__ */