2007-06-26 Murray Cumming <murrayc@murrayc.com>
[modest] / src / dbus_api / modest-dbus-api.h
1 /* Copyright (c) 2007, Nokia Corporation
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  * * Redistributions of source code must retain the above copyright
9  *   notice, this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright
11  *   notice, this list of conditions and the following disclaimer in the
12  *   documentation and/or other materials provided with the distribution.
13  * * Neither the name of the Nokia Corporation nor the names of its
14  *   contributors may be used to endorse or promote products derived from
15  *   this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30
31 #ifndef __MODEST_DBUS_API__
32 #define __MODEST_DBUS_API__
33
34
35 /* Note that the com.nokia service name and /com/nokia object name 
36  * are what is assumed by the, bizarrely named, osso_rpc_run_with_defaults() function, 
37  * so they are probably a good choice. */
38 #define MODEST_DBUS_NAME    "modest"
39 #define MODEST_DBUS_SERVICE "com.nokia."MODEST_DBUS_NAME
40 #define MODEST_DBUS_OBJECT  "/com/nokia/"MODEST_DBUS_NAME
41 #define MODEST_DBUS_IFACE   "com.nokia."MODEST_DBUS_NAME
42
43
44 #define MODEST_DBUS_METHOD_MAIL_TO "MailTo"
45 enum ModestDbusMailToArguments
46 {
47         MODEST_DEBUS_MAIL_TO_ARG_URI,
48         MODEST_DEBUS_MAIL_TO_ARGS_COUNT
49 };
50
51 #define MODEST_DBUS_METHOD_OPEN_MESSAGE "OpenMessage"
52 enum ModestDbusOpenMessageArguments
53 {
54         MODEST_DEBUS_OPEN_MESSAGE_ARG_URI,
55         MODEST_DEBUS_OPEN_MESSAGE_ARGS_COUNT
56 };
57
58 #define MODEST_DBUS_METHOD_SEND_RECEIVE "SendReceive"
59
60 #define MODEST_DBUS_METHOD_COMPOSE_MAIL "ComposeMail"
61 enum ModestDbusComposeMailArguments
62 {
63         MODEST_DEBUS_COMPOSE_MAIL_ARG_TO,
64         MODEST_DEBUS_COMPOSE_MAIL_ARG_CC,
65         MODEST_DEBUS_COMPOSE_MAIL_ARG_BCC,
66         MODEST_DEBUS_COMPOSE_MAIL_ARG_SUBJECT,
67         MODEST_DEBUS_COMPOSE_MAIL_ARG_BODY,
68         MODEST_DEBUS_COMPOSE_MAIL_ARG_ATTACHMENTS,
69         MODEST_DEBUS_COMPOSE_MAIL_ARGS_COUNT
70 };
71
72 #define MODEST_DBUS_METHOD_DELETE_MESSAGE "DeleteMessage"
73 enum ModestDbusDeleteMessageArguments
74 {
75         MODEST_DEBUS_DELETE_MESSAGE_ARG_URI,
76         MODEST_DEBUS_DELETE_MESSAGE_ARGS_COUNT
77 };
78
79 #define MODEST_DBUS_METHOD_OPEN_DEFAULT_INBOX "OpenDefaultInbox"
80
81 /* These are handle via normal D-Bus instead of osso-rpc: */
82 #define MODEST_DBUS_METHOD_SEARCH "Search"
83 #define MODEST_DBUS_METHOD_GET_FOLDERS "GetFolders"
84
85
86 #endif /* __MODEST_DBUS_API__ */