include/notification_status_internal.h

   1 /*
   2  *  libnotification
   3  *
   4  * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
   5  *
   6  * Contact: Seungtaek Chung <seungtaek.chung@samsung.com>, Mi-Ju Lee <miju52.lee@samsung.com>, Xi Zhichan <zhichan.xi@samsung.com>
   7  *
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  *
  20  */
  21
  22 #ifndef __NOTIFICATION_STATUS_INTERNAL_DEF_H__
  23 #define __NOTIFICATION_STATUS_INTERNAL_DEF_H__
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif /* __cplusplus */
  28
  29 /**
  30  * @file notification_status_internal.h
  31  */
  32
  33 /**
  34  * @addtogroup NOTIFICATION_STATUS
  35  * @{
  36  */
  37
  38 /**
  39  * @internal
  40  * @brief Unregisters a callback for all notification events.
  41  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  42  * @privlevel public
  43  * @privilege %http://tizen.org/privilege/notification
  44  * @param[in] changed_cb The callback function
  45  * @return #NOTIFICATION_ERROR_NONE on success,
  46  *         otherwise any other value on failure
  47  * @retval #NOTIFICATION_ERROR_NONE         Success
  48  * @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
  49  * @retval #NOTIFICATION_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
  50  * @see notification_register_detailed_changed_cb()
  51  * @par Sample code:
  52  * @code
  53 #include <notification.h>
  54 ...
  55 {
  56         noti_err = notification_register_detailed_changed_cb(app_changed_cb, user_data);
  57         if(noti_err != NOTIFICATION_ERROR_NONE) {
  58                 return;
  59         }
  60 }
  61  * @endcode
  62  */
  63 int notification_unregister_detailed_changed_cb(
  64                 void (*detailed_changed_cb)(void *data, notification_type_e type, notification_op *op_list, int num_op),
  65                 void *user_data);
  66
  67 /**
  68  * @internal
  69  * @brief Called when a new message is posted.
  70  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  71  * @param[in] message The message posted
  72  * @param[in] data    The user data
  73  * @pre notification_status_monitor_message_cb_set() used to register this callback.
  74  * @see notification_status_monitor_message_cb_set()
  75 */
  76 typedef void (*notification_status_message_cb)(const char *message, void *data);
  77
  78 /**
  79  * @internal
  80  * @brief Registers a callback to receive a message.
  81  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  82  * @param[in] callback The callback function
  83  * @param[in] data     The user_data
  84  * @return #NOTIFICATION_ERROR_NONE if success, other value if failure
  85  * @retval #NOTIFICATION_ERROR_NONE Success
  86  * @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
  87  * @retval #NOTIFICATION_ERROR_FROM_DBUS Error from DBus
  88  */
  89 int notification_status_monitor_message_cb_set(notification_status_message_cb callback, void *user_data);
  90
  91 /**
  92  * @internal
  93  * @brief Unregisters a callback to receive a message.
  94  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  95  * @param[in] callback The callback function
  96  * @param[in] data     The user_data
  97  * @return #NOTIFICATION_ERROR_NONE if success, other value if failure
  98  * @retval #NOTIFICATION_ERROR_NONE Success
  99  */
 100 int notification_status_monitor_message_cb_unset(void);
 101
 102 /**
 103  * @}
 104  */
 105
 106 #ifdef __cplusplus
 107 }
 108 #endif /* __cplusplus */
 109 #endif /* __NOTIFICATION_STATUS_INTERNAL_DEF_H__ */