aapimms.h

彩信MMS的全部代码

 *      - MMS_MSG_HEADER        
 *          The msgPart parameter contains an MmsHeader.
 *      - MMS_MSG_NOTIFICATION
 *          The msgPart parameter contains an MmsNotification
 *      - MMS_MSG_INFO
 *          The msgPart parameter contains an MmsMessageInfo.
 *****************************************************************************/
void MMSa_getMessageResponse(MmsResult result, MmsMsgType msgType, 
    MmsMessagePart *msgPart);

/*!
 * Type: Answer Adapter
 *
 * Related Connector: #MMSc_getMessageDate
 *
 * The operation ordered in the connector function 
 * #MMSc_getMessageDate is finished. This adapter indicates the 
 * outcome of that operation and returns additional data that is needed or 
 * requested.
 *
 * \param result The result of the #MMSc_getMessageDate operation. 
 * \param date The date for the message
 *****************************************************************************/
void MMSa_getMessageDateResponse(MmsResult result, MmsTimeSec date);

/*!
 * Type: Answer Adapter
 *
 * Related Connector: #MMSc_getMessageIdList
 *
 * The operation ordered in the connector function #MMSc_getMessageIdList is 
 * finished. This adapter indicates the outcome of that operation and 
 * returns additional data that is needed or requested.
 *
 * \param result The result of the #MMSc_getMessageIdList operation. 
 * \param msgCount The number of returned message IDs
 * \param msgIds[] An array with the message IDs in the specified folder. This 
 *      data must be copied if needed after the adapter function returns.
 * \param msgDates[] An array with the creation/reception time for the messages
 *      in the msgIds array. This data must be copied if needed after the 
 *      adapter function returns.
 * \param metadata[] An array with the application supplied metadata for the 
 *      messages in the msgIds array. This data must be copied if needed after
 *      the adapter function returns.
 * \param attribute[] An array with the attributes (isRead and isProtected) 
 *      for the messages in the msgIds array. This data must be copied if 
 *      needed after the adapter function returns.
 * \param folder Which folder the IDs are fetched from.
 *****************************************************************************/
void MMSa_getMessageIdListResponse(MmsResult result, UINT32 msgCount, 
    MmsMsgId msgIds[], MmsTimeSec msgDates[], UINT8 metadata[], 
    UINT8 attribute[], MmsFolderType folder);

/*!
 * Type: Answer Adapter
 *
 * Related Connector: #MMSc_getMessageMetadata
 *
 * The operation ordered in the connector function 
 * #MMSc_getMessageMetadata is finished. This adapter indicates the 
 * outcome of that operation and returns additional data that is needed or 
 * requested.
 *
 * \param result The result of the #MMSc_getMessageMetadata operation. 
 * \param metadata The application supplied metadata for the message
 *****************************************************************************/
void MMSa_getMessageMetadataResponse(MmsResult result, UINT8 metadata);

/*!
 * Type: Answer Adapter
 *
 * Related Connector: #MMSc_getMessageRead
 *
 * The operation ordered in the connector function 
 * #MMSc_getMessageRead is finished. This adapter indicates the 
 * outcome of that operation and returns additional data that is needed or 
 * requested.
 *
 * \param result The result of the #MMSc_getMessageRead operation. 
 * \param isRead The read status for the message
 *****************************************************************************/
void MMSa_getMessageReadResponse(MmsResult result, CMN_BOOL isRead);

/*!
 * Type: Answer Adapter
 *
 * Related Connector: #MMSc_getNumberOfMessages
 *
 * The operation ordered in the connector function #MMSc_getNumberOfMessages is 
 * finished. This adapter indicates the outcome of that operation and 
 * returns additional data that is needed or requested.
 *
 * \param result The result of the #MMSc_getNumberOfMessages operation. 
 * \param number The number of returned message IDs.
 * \param folder The folder where the messages were counted.
 *****************************************************************************/
void MMSa_getNumberOfMessagesResponse(MmsResult result, UINT32 number, 
    MmsFolderType folder);

/*!
 * Type: Service Adapter
 *
 * Related Connector: #MMSc_httpResponse
 *
 * The MMS Client wants to send/retreive data via a POST/GET operation
 * 
 * The MMS Client wants to use a previously started WSP/HTTP session for a GET
 * or POST operation. Data sent and retrieved must not be fetched from or 
 * stored into the cache.
 *
 * \param requestId     Request ID for the ongoing WSP/HTTP operation
 * \param requestType   MMS_HTTP_GET or MMS_HTTP_POST
 * \param url           The URL of the WSP/HTTP request. This data This data 
 *                      must be copied if needed after the adapter function 
 *                      returns.
 * \param headers       WSP/HTTP headers, e.g. 
 *                      "Accept: text/html\nContent-type:..."
                        This data must be copied if needed after the adapter 
                        function returns.
 * \param data          Data to POST or NULL. This data must be copied if  
                        needed after the adapter function returns.  
 * \param dataLen       Length of the data buffer to POST.
 * \param msgSize       Size of the complete message to POST. If MIC is used as
 *                      the communication stack, this parameter should be sent
 *                      to MIC in the call to MICc_httpRequest in its totalSize
 *                      parameter.
 * \param moreData      If more data to POST this is set to TRUE, else FALSE.
 *****************************************************************************/
void MMSa_http(MmsRequestId requestId, int requestType, const char *url, 
    const char *headers, void *data, UINT32 dataLen, UINT32 msgSize, 
    CMN_BOOL moreData);

/*!
 * Type: Service Adapter
 *
 * Related Connector: None.
 *
 * The MMS Client has previously ordered a WSP/HTTP operation (GET/POST). The 
 * result of the operation is no longer wanted and the operation is 
 * cancelled.
 *
 * \param requestId     Request ID for the ongoing WSP/HTTP operation
 *****************************************************************************/
void MMSa_httpCancel(MmsRequestId requestId);

/*!
 * Type: Answer Adapter
 *
 * Related Connector: #MMSa_httpRequestData
 *
 * The MMS Client has previously started a WSP/HTTP POST operation where its 
 * data is divided into many chunks. The WAP stack has handled the 
 * first or previous data chunks and is requesting more data. This adapter 
 * returns more data to the WAP stack.
 *
 * \param requestId     Request ID for the ongoing WSP/HTTP operation
 * \param data          Data to POST or NULL. This data must be copied if 
                        needed after the adapter function returns.
 * \param dataLen       Length of the data buffer to POST.
 * \param moreData      TRUE if there is more data, else FALSE.
 *****************************************************************************/
void MMSa_httpRequestDataResponse(MmsRequestId requestId, void *data, 
    int dataLen, CMN_BOOL moreData);

/*!
 * Type: Service Adapter
 *
 * Related Connector: #MMSc_httpResponse
 *
 * Indicates that the MMS Client is ready to receive more data 
 *
 * The MMS Client has ordered a WSP/HTTP Request for more data from the WAP 
 * stack with a call to #MMSc_http. The result of this request is divided into
 * several parts and is returned to MMS Client with calls to the conector
 * #MMSc_httpResponse. This adapter function indicates to the WAP stack that 
 * the MMS Client is ready to receive more data.
 * 
 * \param requestId Request ID for the corresponding WSP/HTTP operation
 *****************************************************************************/
void MMSa_httpResponseAck(MmsRequestId requestId);

/*!
 * Type: Service Adapter
 *
 * Related Connector: #MMSc_httpSessionStartResponse
 *
 * The MMS Client is about to start sending/retrieving data and needs a 
 * WSP/HTTP session.
 *
 *****************************************************************************/
void MMSa_httpSessionStart(void);

/*!
 * Type: Service Adapter
 *
 * Related Connector: #MMSc_httpSessionStopResponse
 *
 * The MMS Client has finished sending/retrieving data using its WSP/HTTP 
 * session and the WSP/HTTP session can be released.
 *
 *****************************************************************************/
void MMSa_httpSessionStop(void);

/*!
 * Type: Answer Adapter
 *
 * Related Connector: #MMSc_importMessages
 *
 * The MMS Client has finished the import of messages.
 *
 * \param result The result of the #MMSc_importMessages operation. 
 * \param numberImported The number of successfully imported messages.
 *****************************************************************************/
void MMSa_importMessagesResponse( MmsResult result, UINT32 numberImported);

/*!
 * Type: Answer Adapter
 *
 * Related Connector: #MMSc_moveMessage
 *
 * The operation ordered in the connector function #MMSc_moveMessage is 
 * finished. This adapter indicates the outcome of that operation and 
 * returns additional data that is needed or requested.
 *
 * \param result The result of the #MMSc_moveMessage operation. 
 *****************************************************************************/
void MMSa_moveMessageResponse(MmsResult result);

/*!
 * Type: Service Adapter
 *
 * Related Connector: None.
 *
 * Whenever a notification is received, this adapter is called to announce 
 * it to the MMS Application. The notification can be of several types.
 *
 * \param type The type of the received and stored notification.
 * \param notifId A unique identity for a stored notification.
 * \param seqId An identity to be able to match calls to MMSa_status. 
 *              This is used for started but failed immediate retrievals. 
 *              Is set to 0 if not used.
 * \param reason The reason why the notification is sent to the application. 
 *****************************************************************************/
void MMSa_notificationReceived( MmsNotificationType type, MmsMsgId notifId, 
    UINT32 seqId, MmsNotificationReason reason);

/*!
 * Type: Service Adapter
 *
 * Related Connector: None.
 *
 * Whenever a Read Report is received, this adapter is called to announce 
 * it to the MMS Application.
 * 
 * \param mmsOrigInd    Data received in the Read Report.
 * \param origMsgId     MsgId to the message that originated this read
 *                      report. If no msgId could be found is 0 returned. 
 *****************************************************************************/
void MMSa_readReportIndication(MmsReadOrigInd *mmsOrigInd, MmsMsgId origMsgId);

/*!
 * Type: Service Adapter
 *
 * Related Connector: #MMSc_timerExpired
 *
 * This function is used by the MMS Client to reset a previously set timer.
 * 
 *****************************************************************************/
void MMSa_resetTimer(void);

/*!
 * Type: Answer Adapter
 *
 * Related Connector: #MMSc_retrieveMessage
 *
 * The operation ordered in the connector function #MMSc_retrieveMessage is 
 * finished. This adapter indicates the outcome of that operation and returns 
 * additional data that is needed or requested.
 *
 * \param result The result of the #MMSc_retrieveMessage operation. 
 * \param msgId The identity for the recently retrieved multimedia message.
 * \param retrieveStatus Status value eventually returned from the MMSC, or 0
 * \param retrieveText Status text eventually returned from the MMSC, or NULL
 *****************************************************************************/
void MMSa_retrieveMessageResponse(MmsResult result, MmsMsgId msgId,
    MmsRetrieveStatus retrieveStatus, MmsEncodedText *retrieveText);

/*!
 * Type: Answer Adapter
 *
 * Related Connector: #MMSc_sendMessage
 *
 * The operation ordered in the connector function #MMSc_sendMessage is 
 * finished. This adapter indicates the outcome of that operation and returns 
 * additional data that is needed or requested.
 *
 * \param result The result of the #MMSc_sendMessage operation. 
 * \param responseStatus Status value eventually returned from the MMSC, or 0
 * \param responseText Status text eventually returned from the MMSC, or NULL
 *****************************************************************************/
void MMSa_sendMessageResponse(MmsResult result,
    MmsResponseStatus responseStatus, MmsEncodedText *responseText);

/*!
 * Type: Answer Adapter
 *
 * Related Connector: #MMSc_sendReadReport
 *
 * The operation ordered in the connector function #MMSc_sendReadReport is 
 * finished. This adapter indicates the outcome of that operation and returns 
 * additional data that is needed or requested.
 *
 * \param result The result of the #MMSc_sendReadReport operation. 
 * \param msgId If the MMS Client is configured for an MMS Proxy-Relay using
 *              MMS Version 1.0, this parameter contains the identity for the 
 *              created and sent message containing the Read Report.
 *****************************************************************************/
void MMSa_sendReadReportResponse(MmsResult result, MmsMsgId msgId);

/*!
 * Type: Answer Adapter
 *
 * Related Connector: #MMSc_setConfigInt
 *
 * The operation ordered in the connector function #MMSc_setConfigInt is 
 * finished. This adapter indicates the outcome of that operation and returns 
 * additional data that is needed or requested.
 *
 * \param result The result of the #MMSc_setConfigInt operation. 
 * \param key The variable whose value that was changed.