API Guide Home (Online version only) |

# MmsHelperCommon.h

Go to the documentation of this file.

    00001 /*******************************************************************************
    00002  * Copyright (c) 2004-2005 palmOne, Inc. or its subsidiaries.
    00003  * All rights reserved.
    00004  ******************************************************************************/
    00005 /**
    00006  * @ingroup Helper
    00007  */
    00008
    00009 /**
    00010  * @file    MmsHelperCommon.h
    00011  * @version 1.0
    00012  * @brief   Public 68k common header files to be used with Default Helper Library.
    00013  *
    00014  * This file contains the type and structure parameters for the MMS Helper Service Class.
    00015  * Developers should register to this service using Default Helper library if it wants
    00016  * to handle MMS.
    00017  *
    00018  * <hr>
    00019  */
    00020
    00021 #ifndef HELPER_MMS_H
    00022 #define HELPER_MMS_H
    00023
    00024 /** New helper class registered with PalmSource for sending by MMS */
    00025 #define    kHelperServiceClassIDMMS    'mms_'
    00026
    00027 /** Structure to hold the MMS object. This structure is part of the linked list
    00028   * which is pointed by the object member of HelperServiceMMSDetailsType */
    00029 typedef struct _HelperServiceMMSObjectType
    00030 {
    00031     Int16   pageNum;            /**< IN: page of message this content should appear on. */
    00032     Char*   mimeType;           /**< IN: IANA Mime type for this object (compulsory!)
    00033                                      The object may be passed in a buffer or via a file.
    00034                                      Either set bufferP and bufferLen or set tempFileName
    00035                                   */
    00036
    00037     MemPtr  bufferP;            /**< IN: The object is stored in a buffer if this is non-NULL */
    00038     UInt32  bufferLen;          /**< IN: Length of the buffer */
    00039
    00040     Char*   tempFileName;       /**< IN: The temporary file its stored in if bufferP is NULL */
    00041     Boolean isVFSFileName;      /**< IN: Is the file local or under VFS e.g Memory card? */
    00042     Boolean freeTempFile;       /**< IN: If set, the file should be deleted by the helper application */
    00043
    00044     Char*   name;               /**< IN: the name of the object as sent to us (maybe the filename) */
    00045
    00046     struct  _HelperServiceMMSObjectType* nextP; /**< IN: Linked list pointer of objects to send. */
    00047
    00048 } HelperServiceMMSObjectType;
    00049
    00050 /**
    00051  * @brief Helpers of this Service Class send an MMS message.
    00052  *
    00053  * "To" address(es) are passed in the 'pData' element of the main structure
    00054  * (HelperNotifyExecuteType)
    00055  *
    00056  * The 'pDetails' struct member may optionally point to
    00057  * HelperServiceMMSDetailsType for this service class.
    00058  */
    00059 typedef struct _HelperServiceMMSDetailsType
    00060 {
    00061     UInt16  version;                    /**< This is currently version 1 */
    00062
    00063     Char*   cc;                         /**< IN: carbon copy address string or NULL -- will
    00064                                              be duplicated by helper if necessary;
    00065                                              multiple addresses are separated by
    00066                                              semicolon (ex. "john@host.com; jane@host.com") */
    00067
    00068     Char*   subject;                    /**< IN: subject string or NULL -- will be duplicated
    00069                                              by helper if necessary (ex. "helper API") */
    00070
    00071     Char*   message;                    /**< IN: initial message body string or NULL -- will be
    00072                                              duplicated by helper if necessary (ex.
    00073                                              "Lets discuss the helper API tomorrow.")
    00074                                              Message will be put on first page. */
    00075
    00076     HelperServiceMMSObjectType* object; /**< IN: Head of Linked list of objects to send or NULL */
    00077
    00078     Char*   bcc;                        /**< IN: blind carbon copy address string or NULL -- will
    00079                                              be duplicated by helper if necessary;
    00080                                              multiple addresses are separated by
    00081                                              semicolon (ex. "john@host.com; jane@host.com") */
    00082
    00083     Boolean justSend;                   /**< IN: Set this to true to send without invoking any UI */
    00084
    00085 } HelperServiceMMSDetailsType;
    00086
    00087
    00088 #endif //HELPER_MMS_H

Top | Palm Developer Network © 2004-2008, Palm, Inc. All rights reserved. Generated on Fri Jun 13 10:06:54 2008 for Palm API Guide