sapimms.h

彩信MMS的全部代码

/*
 * Copyright (C) Obigo AB, 2002-2005.
 * All rights reserved.
 *
 * This software is covered by the license agreement between
 * the end user and Obigo AB, and may be 
 * used and copied only in accordance with the terms of the 
 * said agreement.
 *
 * Obigo AB assumes no responsibility or 
 * liability for any errors or inaccuracies in this software, 
 * or any consequential, incidental or indirect damage arising
 * out of the use of the software.
 *
 */

/******************************************************************************
 * Revision:        $Revision: \main\4 $
 * Original Author: Tommy Molen
 *****************************************************************************/

/*! \file sapimms.h
 * \brief  Synchronous connector functions.
 */

#ifndef _SAPIMMS_H
#define _SAPIMMS_H

/*--- Definitions/Declarations ---*/

/*--- Types ---*/

/*--- Constants ---*/

/*--- Forwards ---*/

/*--- Externs ---*/

/*--- Macros ---*/

/*--- Prototypes ---*/

/*!
 * Type: Synchronous
 *
 * This function deletes all notifications in the immediate retrieval queue.
 * Notifications queued for immediate retrieval is stored in a number of files. 
 * Calling this connector will remove them all. This function should only be 
 * called when persistent storage has to be freed abruptly. During normal 
 * operations it is not necessary to call this function.
 * 
 *****************************************************************************/
void MMSs_deleteNotificationQueue(void);

/*!
 * Type: Synchronous
 *
 * This function deletes the report file that keeps track of read reports and 
 * delivery reports for sent messages. This function should only be called when
 * either persistent storage has to be freed abruptly or if the report file 
 * becomes full. During normal operations it is not necessary to call this 
 * function.
 *
 * When the report file becomes full it will be reported by the 
 * MMSa_error with MMS_RESULT_REPORT_FILE_IS_FULL. In this case it is
 * recommended to delete the file to start all over again to be able to 
 * store new report information.
 * 
 *****************************************************************************/
void MMSs_deleteReportFile(void);

/*!
 * Type: Synchronous
 *
 * Get the file ID that matches a specified message ID.
 *
 * \param id Message ID in question.
 * \param wantInfoFile If the message file or the info file is requested.
 * \param fileId The requested file ID
 * \return MmsResult indicating the result of the operation
 *****************************************************************************/
MmsResult MMSs_getFileId( MmsMsgId id, CMN_BOOL wantInfoFile, UINT32 *fileId);

/*!
 * Type: Synchronous
 *
 * Get the application metadata (four bits) of the message.
 *
 * \param msgId A unique identity for a multimedia message.
 * \param metadata The application supplied metadata for the message
 * \return MmsResult indicating the result of the operation
 *****************************************************************************/
MmsResult MMSs_getMessageMetadata(MmsMsgId msgId, UINT8 *metadata);

/*!
 * Type: Synchronous
 *
 * Get the number of messages in the specified folder.
 *
 * \param folder The folder in question, or MMS_ALL_FOLDERS.
 * \param number The number of messages in the specified folder. 
 * \return MmsResult indicating the result of the operation
 *****************************************************************************/
MmsResult MMSs_getNumberOfMessages( MmsFolderType folder, UINT32 *number);

/*!
 * Type: Synchronous
 *
 * Get the number of unread messages in the specified folder.
 *
 * \param folder The folder in question, or MMS_ALL_FOLDERS.
 * \param number The number of unread messages in the specified folder. 
 * \return MmsResult indicating the result of the operation
 *****************************************************************************/
MmsResult MMSs_getNumberOfUnreadMessages( MmsFolderType folder, UINT32 *number);

/*!
 * Type: Synchronous
 *
 * If the index table is marked as dirty, this connector function forces saving 
 * of the index table to persistent storage. This function should only be used 
 * if all or multiple of the CMN_INDEX_SAVE_CREATE/DELETE/MOVE settings have 
 * been disabled. This way the integration is responsible for saving the index 
 * table to avoid loss of data.
 *
 * \param save Indicates which one of the index and the backup file should be 
 *      saved or if both should be saved
 * \return MmsResult indicating the result of the operation
 *****************************************************************************/
MmsResult MMSs_indexTableSave(MmsSaveFile save);

/*!
 * Type: Synchronous
 *
 * Set the application unique metadata for a message
 *
 * \param msgId A unique identity for a multimedia message.
 * \param metadata Data to set for a message. Only the four low bits can be set.
 * \return MmsResult indicating the result of the operation
 *****************************************************************************/
MmsResult MMSs_setMessageMetadata( MmsMsgId msgId, UINT8 metadata);

#endif /* _SAPIMMS_H */