summaryrefslogtreecommitdiff
path: root/include/badge_internal.h
blob: 610582d716b5e1306b344959451eac5c64c06423 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
/*
 *  libbadge
 *
 * Copyright (c) 2000 - 2015 Samsung Electronics Co., Ltd. All rights reserved.
 *
 * Contact: Youngjoo Park <yjoo93.park@samsung.com>,
 *      Seungtaek Chung <seungtaek.chung@samsung.com>, Youngsub Ko <ys4610.ko@samsung.com>
 *
 * Licensed under the Apache License, Version 2.0 (the License);
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an AS IS BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

#ifndef __BADGE_INTERNAL_DEF_H__
#define __BADGE_INTERNAL_DEF_H__

#include <stdbool.h>
#include <stdarg.h>

#include "badge_error.h"
#include "badge.h"

#ifndef EXPORT_API
#define EXPORT_API __attribute__ ((visibility("default")))
#endif

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

typedef struct _badge_h badge_h;

char *_badge_get_pkgname_by_pid(void);

int _badge_is_existing(const char *pkgname, bool *existing);

int _badge_foreach_existed(badge_cb callback, void *data);

int _badge_insert(badge_h *badge);

int _badge_remove(const char *caller, const char *pkgname);

int _badget_set_count(const char *caller, const char *pkgname,
			unsigned int count);

int _badget_get_count(const char *pkgname, unsigned int *count);

int _badget_set_display(const char *pkgname,
			unsigned int is_display);

int _badget_get_display(const char *pkgname, unsigned int *is_display);

int _badge_register_changed_cb(badge_change_cb callback, void *data);

int _badge_unregister_changed_cb(badge_change_cb callback);

int _badge_free(badge_h *badge);

badge_h *_badge_new(const char *pkgname, const char *writable_pkgs,
		int *err);

char *_badge_pkgs_new(int *err, const char *pkg1, ...);

char *_badge_pkgs_new_valist(int *err,
			const char *pkg1, va_list args);

void badge_changed_cb_call(unsigned int action, const char *pkgname,
			unsigned int count);

/**
 * @internal
 * @brief Creates a badge for the designated package.
 * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
 * @privlevel public
 * @privilege %http://tizen.org/privilege/notification
 * @details Creates new badge to display.
 * @param[in] pkgname The name of the designated package
 * @param[in] writable_pkg The name of package which is authorized to change the badge
 * @return #BADGE_ERROR_NONE if success, other value if failure
 * @see #badge_error_e
 * @par Sample code:
 * @code
#include <badge.h>
...
{
	int err = BADGE_ERROR_NONE;

	err = badge_create("org.tizen.sms", "org.tizen.sms2");
	if(err != BADGE_ERROR_NONE) {
		return;
	}

}
 * @endcode
 */
int badge_create(const char *pkgname, const char *writable_pkg);

/**
 * @brief This function sets badge property for designated package.
 * @param[in] pkgname The name of designated package
 * @param[in] property name
 * @param[in] property value
 * @return #BADGE_ERROR_NONE if success, other value if failure
 * @see #badge_error_e
 */
int badge_setting_property_set(const char *pkgname, const char *property, const char *value);

/**
 * @brief This function gets badge property for designated package.
 * @param[in] pkgname The name of designated package
 * @param[in] property name
 * @param[in] pointer which can save the getting value
 * @return #BADGE_ERROR_NONE if success, other value if failure
 * @see #badge_error_e
 */
int badge_setting_property_get(const char *pkgname, const char *property, char **value);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* __BADGE_INTERNAL_DEF_H__ */