src/include/common/event/FireEvent.h

00001 /*
00002  * Funambol is a mobile platform developed by Funambol, Inc. 
00003  * Copyright (C) 2003 - 2007 Funambol, Inc.
00004  * 
00005  * This program is free software; you can redistribute it and/or modify it under
00006  * the terms of the GNU Affero General Public License version 3 as published by
00007  * the Free Software Foundation with the addition of the following permission 
00008  * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
00009  * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE 
00010  * WARRANTY OF NON INFRINGEMENT  OF THIRD PARTY RIGHTS.
00011  * 
00012  * This program is distributed in the hope that it will be useful, but WITHOUT
00013  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00014  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
00015  * details.
00016  * 
00017  * You should have received a copy of the GNU Affero General Public License 
00018  * along with this program; if not, see http://www.gnu.org/licenses or write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
00020  * MA 02110-1301 USA.
00021  * 
00022  * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite 
00023  * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com.
00024  * 
00025  * The interactive user interfaces in modified source and object code versions
00026  * of this program must display Appropriate Legal Notices, as required under
00027  * Section 5 of the GNU Affero General Public License version 3.
00028  * 
00029  * In accordance with Section 7(b) of the GNU Affero General Public License
00030  * version 3, these Appropriate Legal Notices must retain the display of the
00031  * "Powered by Funambol" logo. If the display of the logo is not reasonably 
00032  * feasible for technical reasons, the Appropriate Legal Notices must display
00033  * the words "Powered by Funambol".
00034  */
00035 
00036 #ifndef INCL_FIRE_EVENTS
00037 #define INCL_FIRE_EVENTS
00038 
00040 #include "event/BaseEvent.h"
00041 #include "event/SyncEvent.h"
00042 #include "event/SyncSourceEvent.h"
00043 #include "event/SyncItemEvent.h"
00044 #include "event/SyncStatusEvent.h"
00045 #include "event/TransportEvent.h"
00046 #include "event/constants.h"
00047 
00048 /*
00049  * A set of global functions to fire an event from inside the API.
00050  */
00051 
00052 
00053 /*
00054  * Fire a SyncEvent.
00055  *
00056  * @param msg  : the message of sync event
00057  * @param type : the type of event to fire (see event/constants.h)
00058  * @return     : TRUE if no errors,
00059  *               FALSE if syncListener not instantiated, or 'type' wrong
00060  */
00061 bool fireSyncEvent(const char* msg, int type);
00062 
00063 /*
00064  * Fire a TransportEvent.
00065  *
00066  * @param size : the data size
00067  * @param type : the type of event to fire (see event/constants.h)
00068  * @return     : TRUE if no errors,
00069  *               FALSE if transportListener not instantiated, or 'type' wrong
00070  */
00071 bool fireTransportEvent(unsigned long size, int type);
00072 
00073 /*
00074  * Fire a SyncSourceEvent.
00075  *
00076  * @param sourceURI : the source being synchronized
00077  * @param sourceName: the source name being synchronized
00078  * @param mode      : type of the performed sync
00079  * @param data      : data information returned
00080  * @param type      : the type of event to fire (see event/constants.h)
00081  * @return          : TRUE if no errors,
00082  *                    FALSE if syncsourceListener not instantiated, or 'type' wrong
00083  */
00084 bool fireSyncSourceEvent(const char* sourceURI, const char* sourceName, SyncMode mode, int data, int type);
00085 
00086 /*
00087  * Fire a SyncItemEvent.
00088  *
00089  * @param sourceURI : the source the item belongs to
00090  * @param name      : the source name
00091  * @param itemKey   : the item key (GUID from the server)
00092  * @param type      : the type of event to fire (see event/constants.h)
00093  * @return          : TRUE if no errors,
00094  *                    FALSE if syncitemListener not instantiated, or 'type' wrong
00095  */
00096 bool fireSyncItemEvent(const char* sourceURI, const char* name, const WCHAR* itemKey, int type);
00097 
00098 /*
00099  * Fire a SyncStatusEvent.
00100  *
00101  * @param command   : the command the status relates to
00102  * @param statusCode: the status code
00103  * @param name      : the source name
00104  * @param uri       : the source uri
00105  * @param itemKey   : the key of the item this status relates to if it is in response of a modification command
00106  * @param type      : the type of event to fire (see event/constants.h)
00107  * @return          : TRUE if no errors,
00108  *                    FALSE if syncstatusListener not instantiated, or 'type' wrong
00109  */
00110 bool fireSyncStatusEvent(const char* command, int statusCode, const char* name, const char* uri, const WCHAR* itemKey, int type);
00111 
00112 
00114 #endif

Generated on Mon Feb 4 09:50:46 2008 for Funambol Outlook Plug-in Library by  doxygen 1.5.2