libsyncml 0.5.4

- Main Page
- Modules
- Data Structures
- Files

- File List

sml_notification.h
1 /*
2 * libsyncml - A syncml protocol implementation
3 * Copyright (C) 2005 Armin Bauer <armin.bauer@opensync.org>
4 * Copyright (C) 2007 Michael Bell <michael.bell@opensync.org>
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 *
20 */
21
29
30 #ifndef _SML_NOTIFICATION_H_
31 #define _SML_NOTIFICATION_H_
32
33 typedef enum {
34 SML_SAN_VERSION_UNKNOWN = 0,
35 SML_SAN_VERSION_10 = 1,
36 SML_SAN_VERSION_11 = 2,
37 SML_SAN_VERSION_12 = 3
38 } SmlNotificationVersion;
39
40 typedef enum {
41 SML_SAN_UIMODE_UNSPECIFIED = 0,
42 SML_SAN_UIMODE_BACKGROUND = 1,
43 SML_SAN_UIMODE_INFORMATIVE = 2,
44 SML_SAN_UIMODE_USER = 3
45 } SmlNotificationUIMode;
46
47 typedef enum {
48 SML_SAN_INITIATOR_USER = 0,
49 SML_SAN_INITIATOR_SERVER = 1
50 } SmlNotificationInitiator;
51
52 SmlNotification *smlNotificationNew(SmlNotificationVersion version, SmlNotificationUIMode mode, SmlNotificationInitiator init, unsigned int sessionID, const char *identifier, const char *target, SmlMimeType type, SmlError **error);
53 void smlNotificationSetCred(SmlNotification *san, SmlCred *cred);
54 void smlNotificationSetManager(SmlNotification *san, SmlManager *manager);
55 void smlNotificationFree(SmlNotification *san);
56 SmlNotification *smlNotificationParse(const char *data, unsigned int size, SmlError **error);
57 SmlBool smlNotificationAssemble(SmlNotification *san, char **data, unsigned int *size, SmlError **error);
58 SmlBool smlNotificationSend(SmlNotification *san, SmlTransport *tsp, SmlError **error);
59
60 SmlBool smlNotificationNewAlert(SmlNotification *san, SmlAlertType type, const char *contenttype, const char *serverURI, SmlError **error);
61 void smlNotificationFreeAlert(SmlSanAlert *alert);
62
63 SmlNotificationVersion smlNotificationGetVersion(SmlNotification *san);
64 SmlNotificationUIMode smlNotificationGetMode(SmlNotification *san);
65 SmlNotificationInitiator smlNotificationGetInitiator(SmlNotification *san);
66 unsigned int smlNotificationGetSessionID(SmlNotification *san);
67 const char *smlNotificationGetIdentifier(SmlNotification *san);
68 unsigned int smlNotificationNumAlerts(SmlNotification *san);
69 SmlSanAlert *smlNotificationNthAlert(SmlNotification *san, unsigned int nth);
70
71 SmlAlertType smlSanAlertGetType(SmlSanAlert *alert);
72 const char *smlSanAlertGetContentType(SmlSanAlert *alert);
73 const char *smlSanAlertGetServerURI(SmlSanAlert *alert);
74
75 #endif //_SML_NOTIFICATION_H_
76