From 49e65559c972aac17136d8013cd0f6c72df33626 Mon Sep 17 00:00:00 2001 From: Don Sanders Date: Wed, 13 Apr 2011 14:26:12 +1000 Subject: Add missing doc. --- src/messaging/qmessageservice.cpp | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'src/messaging/qmessageservice.cpp') diff --git a/src/messaging/qmessageservice.cpp b/src/messaging/qmessageservice.cpp index 7982ab6800..d7937d9e4b 100644 --- a/src/messaging/qmessageservice.cpp +++ b/src/messaging/qmessageservice.cpp @@ -309,9 +309,23 @@ QTM_BEGIN_NAMESPACE The folder must be in the same account as the message. This will move the message on the external server, as well as locally. + On Windows mobile and desktop platforms this function performs no operation. + Returns true if the operation can be initiated; otherwise returns false. */ +/*! + \fn QMessageService::synchronize(const QMessageAccountId &id) + + Initiate synchronization with external server identified by \a id + + On Windows mobile and desktop platforms this function performs no operation. + + Returns true if the operation can be initiated; otherwise returns false. + + \sa QMessageManager::addMessage(), QMessageManager::updateMessage(), QMessageManager::removeMessage(), QMessageManager::removeMessages() +*/ + /*! \fn QMessageService::state() const -- cgit v1.2.3 From 32123bf15564698a5e506a4ff2258d9a06da405e Mon Sep 17 00:00:00 2001 From: Don Sanders Date: Wed, 13 Apr 2011 18:19:47 +1000 Subject: Stub in empty implementation of QMessageService::synchronize on win and maemo5 --- src/messaging/qmessageservice.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src/messaging/qmessageservice.cpp') diff --git a/src/messaging/qmessageservice.cpp b/src/messaging/qmessageservice.cpp index d7937d9e4b..b9d75128c6 100644 --- a/src/messaging/qmessageservice.cpp +++ b/src/messaging/qmessageservice.cpp @@ -319,7 +319,7 @@ QTM_BEGIN_NAMESPACE Initiate synchronization with external server identified by \a id - On Windows mobile and desktop platforms this function performs no operation. + On Windows mobile and desktop platforms, and Maemo 5 this function performs no operation. Returns true if the operation can be initiated; otherwise returns false. -- cgit v1.2.3 From 217532b0534b583eb19a0f9f38d76b53975f6073 Mon Sep 17 00:00:00 2001 From: Patrick Burke Date: Thu, 14 Apr 2011 14:26:35 +1000 Subject: Correctly error when attempt to send SMS messages on Meego.com (QTMOBILITY-1394) --- src/messaging/qmessageservice.cpp | 2 ++ 1 file changed, 2 insertions(+) (limited to 'src/messaging/qmessageservice.cpp') diff --git a/src/messaging/qmessageservice.cpp b/src/messaging/qmessageservice.cpp index b9d75128c6..641604bbf1 100644 --- a/src/messaging/qmessageservice.cpp +++ b/src/messaging/qmessageservice.cpp @@ -210,6 +210,8 @@ QTM_BEGIN_NAMESPACE action object enters the FinishedState when the message is queued for sending rather than actually sent. + On the MeeGo.com platform this function is not yet supported for SMS type messages. + Returns true if the operation can be initiated; otherwise returns false. \sa QMessage, QMessageAccountId -- cgit v1.2.3 From 3406c0058ab8cd57a543579f43daea83fdab6376 Mon Sep 17 00:00:00 2001 From: Don Sanders Date: Thu, 14 Apr 2011 18:01:10 +1000 Subject: Doc QMessageService::moveMessages symbian limitations. --- src/messaging/qmessageservice.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src/messaging/qmessageservice.cpp') diff --git a/src/messaging/qmessageservice.cpp b/src/messaging/qmessageservice.cpp index 641604bbf1..3a44a5d148 100644 --- a/src/messaging/qmessageservice.cpp +++ b/src/messaging/qmessageservice.cpp @@ -311,7 +311,7 @@ QTM_BEGIN_NAMESPACE The folder must be in the same account as the message. This will move the message on the external server, as well as locally. - On Windows mobile and desktop platforms this function performs no operation. + On Windows mobile and desktop platforms this function is not supported. On Symbian prior to SR1.11 this function is not supported. On Symbian SR1.11 this function is only partially supported. Returns true if the operation can be initiated; otherwise returns false. */ -- cgit v1.2.3 From 906c2d9a2f38058693d7a39b234a044724b1d1fc Mon Sep 17 00:00:00 2001 From: Peter Yard Date: Fri, 15 Apr 2011 14:24:20 +1000 Subject: Docs: added since version to 1.0 classes. QTMOBILITY-790 --- src/messaging/qmessageservice.cpp | 187 +++++++++++++++++++------------------- 1 file changed, 94 insertions(+), 93 deletions(-) (limited to 'src/messaging/qmessageservice.cpp') diff --git a/src/messaging/qmessageservice.cpp b/src/messaging/qmessageservice.cpp index 7982ab6800..1249c38061 100644 --- a/src/messaging/qmessageservice.cpp +++ b/src/messaging/qmessageservice.cpp @@ -49,43 +49,44 @@ QTM_BEGIN_NAMESPACE /*! \class QMessageService - + \inmodule QtMessaging - + \ingroup messaging + \since 1.0 - \brief The QMessageService class provides the interface for requesting + \brief The QMessageService class provides the interface for requesting messaging service operations. - QMessageService provides the mechanisms for messaging clients to request services, - and to receive information in response. All requestable service operations present + QMessageService provides the mechanisms for messaging clients to request services, + and to receive information in response. All requestable service operations present the same interface for communicating status, and progress information. - All service request operations communicate changes in their operational state + All service request operations communicate changes in their operational state by emitting the stateChanged() signal. - Service request operations report progress information by emitting the + Service request operations report progress information by emitting the progressChanged() signal. - - If a requested operation fails after being initiated then the error() + + If a requested operation fails after being initiated then the error() function will return a value indicating the failure mode encountered. - - A client may attempt to cancel a requested operation after it has been + + A client may attempt to cancel a requested operation after it has been initiated. The cancel() slot is provided for this purpose. Cancelation is not guaranteed to succeed, and is not possible on all platforms. - A QMessageService instance supports only a single request at a time. Attempting - to initiate an operation on a QMessageService while another operation is already - in progress will result in function initiating the latter request returning - false. A client may, however, use multiple QMessageService instances to + A QMessageService instance supports only a single request at a time. Attempting + to initiate an operation on a QMessageService while another operation is already + in progress will result in function initiating the latter request returning + false. A client may, however, use multiple QMessageService instances to concurrently initiate a queue of requests that will be serviced sequentially. - Each QMessageService instance will report only the changes pertaining to + Each QMessageService instance will report only the changes pertaining to the request that instance initiated. - Except where noted QMessageServices may initiate network activity. - Other functions in the mobility messaging API will not initiate network - activity, with the exception of Windows mobile and desktop platforms which + Except where noted QMessageServices may initiate network activity. + Other functions in the mobility messaging API will not initiate network + activity, with the exception of Windows mobile and desktop platforms which may initiate network activity during the evaluation of any function call. */ @@ -102,203 +103,203 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageService::QMessageService(QObject *parent) - + Constructs a message service representation object. - + The \a parent is passed to the QObject constructor. */ /*! \fn QMessageService::~QMessageService() - + Destroys the message service representation. */ /*! \fn QMessageService::queryMessages(const QMessageFilter &filter, const QMessageSortOrder &sortOrder, uint limit, uint offset) - + Emits the messagesFound() signal providing \l{QMessageId}s of messages in the messaging - store. If \a filter is not empty only identifiers for messages matching the parameters + store. If \a filter is not empty only identifiers for messages matching the parameters set by \a filter will be emitted, otherwise identifiers for all messages will be emitted. - If \a sortOrder is not empty, then the identifiers will be sorted by the parameters + If \a sortOrder is not empty, then the identifiers will be sorted by the parameters set by \a sortOrder. - If \a limit is not zero, then \a limit places an upper bound on the number of + If \a limit is not zero, then \a limit places an upper bound on the number of ids in the list returned. \a offset specifies how many ids to skip at the beginning of the list returned. - - Calling this function may result in the messagesFound() and progressChanged() + + Calling this function may result in the messagesFound() and progressChanged() signals being emitted multiple times. An emission of the progressChanged() signal with a total of 0 indicates that the number of progress steps is unknown. - - The performance of querying messages is currently significantly less than + + The performance of querying messages is currently significantly less than optimal for some querying criteria on some platforms. - + Returns true if the operation can be initiated; otherwise returns false. Note: This function should not initiate network activity, instead only message data already stored on the device will be used during evaluation of the function. - + \sa QMessage, QMessageFilter, QMessageSortOrder, messagesFound(), progressChanged(), countMessages() */ /*! \fn QMessageService::queryMessages(const QMessageFilter &filter, const QString &body, QMessageDataComparator::MatchFlags matchFlags, const QMessageSortOrder &sortOrder, uint limit, uint offset) - + Emits the messagesFound() signal providing \l{QMessageId}s of messages in the messaging - store. If \a filter is not empty only identifiers for messages matching the parameters - set by \a filter and with a body containing the string \a body will be emitted, - otherwise identifiers for all messages with a body containing \a body using + store. If \a filter is not empty only identifiers for messages matching the parameters + set by \a filter and with a body containing the string \a body will be emitted, + otherwise identifiers for all messages with a body containing \a body using matching flags \a matchFlags will be emitted. - If \a sortOrder is not empty, then the identifiers will be sorted by the parameters + If \a sortOrder is not empty, then the identifiers will be sorted by the parameters set by \a sortOrder. - If \a limit is not zero, then \a limit places an upper bound on the number of + If \a limit is not zero, then \a limit places an upper bound on the number of ids in the list returned. \a offset specifies how many ids to skip at the beginning of the list returned. - - Calling this function may result in the messagesFound() and progressChanged() + + Calling this function may result in the messagesFound() and progressChanged() signals being emitted multiple times. An emission of the progressChanged() signal with a total of 0 indicates that the number of progress steps is unknown. - The performance of querying messages is currently significantly less than + The performance of querying messages is currently significantly less than optimal for some querying criteria on some platforms. - + Returns true if the operation can be initiated; otherwise returns false. - + Note: This function should not initiate network activity, instead only message data already stored on the device will be used during evaluation of the function. - + \sa QMessage, QMessageFilter, QMessageSortOrder, messagesFound(), progressChanged(), countMessages() */ /*! \fn QMessageService::countMessages(const QMessageFilter &filter) - - Emits via a messagesCounted() signal the number messages in the messaging + + Emits via a messagesCounted() signal the number messages in the messaging store matching \a filter. - - Calling this function may result in the progressChanged() + + Calling this function may result in the progressChanged() signal being emitted multiple times. An emission of the progressChanged() signal with a total of 0 indicates that the number of progress steps is unknown. - - The performance of counting messages is currently significantly less than optimal + + The performance of counting messages is currently significantly less than optimal for some filters on some platforms. - + Returns true if the operation can be initiated; otherwise returns false. - + Note: This function should not initiate network activity, instead only message data already stored on the device will be used during evaluation of the function. - + \sa QMessage, QMessageFilter, messagesCounted(), progressChanged(), queryMessages() */ /*! \fn QMessageService::send(QMessage &message) - + Transmit \a message using the account identified by the message's \l{QMessage::parentAccountId()}{parentAccountId} function. - If the message does not have a valid parentAccountId, it will be set to the + If the message does not have a valid parentAccountId, it will be set to the result of QMessageAccount::defaultAccount() for the message's \l{QMessage::Type}{type}. - + The message will be stored in the standard Outbox folder for the account before transmission, or moved to that folder if it is already stored in another folder. If transmission is successful, the message will be moved to the standard Sent folder for the account. - - Currently on the Maemo 5 (Fremantle), Symbian, and Windows Mobile platforms the service - action object enters the FinishedState when the message is queued for sending + + Currently on the Maemo 5 (Fremantle), Symbian, and Windows Mobile platforms the service + action object enters the FinishedState when the message is queued for sending rather than actually sent. - + Returns true if the operation can be initiated; otherwise returns false. - + \sa QMessage, QMessageAccountId */ /*! \fn QMessageService::compose(const QMessage &message) - + Open a composer application using \a message as a prototype. - + The default application for handling the type of \a message should be used. - + Returns true if the operation can be initiated; otherwise returns false. - - On the QMF platform implementation of this function is left as a task for system + + On the QMF platform implementation of this function is left as a task for system integrators. - + \sa QMessage::type() */ /*! \fn QMessageService::retrieveHeader(const QMessageId& id) - - Retrieve meta data of the message identified by \a id. - The meta data (including flags, from, to, subject, and date fields where applicable) of + Retrieve meta data of the message identified by \a id. + + The meta data (including flags, from, to, subject, and date fields where applicable) of the message identified by \a id should be retrieved. If only the message envelope information is present, any other accessible header information should be retrieved. - + If the message can not be found on the originating server it will be marked as removed. Returns true if the operation can be initiated; otherwise returns false. - + \sa QMessageId, QMessage::Removed */ /*! \fn QMessageService::retrieveBody(const QMessageId& id) - - Retrieve the body of the message identified by \a id. + + Retrieve the body of the message identified by \a id. If the message can not be found on the originating server it will be marked as removed. On the Symbian^3 platform this function is not yet supported. Returns true if the operation can be initiated; otherwise returns false. - + \sa QMessageId, QMessage::Removed */ /*! \fn QMessageService::retrieve(const QMessageId &messageId, const QMessageContentContainerId& id) - - Retrieve the container identified by \a messageId and \a id, the contents of the container should also be + + Retrieve the container identified by \a messageId and \a id, the contents of the container should also be retrieved. - + Returns true if the operation can be initiated; otherwise returns false. - + \sa QMessageContentContainerId */ /*! \fn QMessageService::show(const QMessageId& id) - + Show the message identified by \a id. The default application for handling the type of message that \a id identifies should be used. Returns true if the operation can be initiated; otherwise returns false. - + On the Maemo 5 (Fremantle) platform this function is not yet supported for SMS type messages. - - On the QMF platform implementation of this function is left as a task for system + + On the QMF platform implementation of this function is left as a task for system integrators. - + \sa QMessageId, QMessage::type() */ - + /*! \fn QMessageService::exportUpdates(const QMessageAccountId &id) - - Initiate synchronization with external servers of local changes that have been queued by message store operations, + + Initiate synchronization with external servers of local changes that have been queued by message store operations, for messages with parent account \a id. - On Windows mobile and desktop platforms this function performs no operation, as when a connection is available, + On Windows mobile and desktop platforms this function performs no operation, as when a connection is available, local changes are opportunistically synchronized with external servers. Returns true if the operation can be initiated; otherwise returns false. - + \sa QMessageManager::addMessage(), QMessageManager::updateMessage(), QMessageManager::removeMessage(), QMessageManager::removeMessages() */ @@ -311,10 +312,10 @@ QTM_BEGIN_NAMESPACE Returns true if the operation can be initiated; otherwise returns false. */ - + /*! \fn QMessageService::state() const - + Returns the current state of the operation. \sa stateChanged() @@ -322,7 +323,7 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageService::cancel() - + Attempts to cancel the last requested operation. */ @@ -369,7 +370,7 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageService::error() const - + Returns a value indicating the last error condition encountered by the operation. */ -- cgit v1.2.3