qtmobility/src/messaging/qmessageservice.cpp
changeset 5 453da2cfceef
parent 1 2b40d63a9c3d
child 8 71781823f776
equal deleted inserted replaced
4:90517678cc4f 5:453da2cfceef
    58     QMessageService provides the mechanisms for messaging clients to request services, 
    58     QMessageService provides the mechanisms for messaging clients to request services, 
    59     and to receive information in response.  All requestable service operations present 
    59     and to receive information in response.  All requestable service operations present 
    60     the same interface for communicating status, and progress information.
    60     the same interface for communicating status, and progress information.
    61 
    61 
    62     All service request operations communicate changes in their operational state 
    62     All service request operations communicate changes in their operational state 
    63     by emitting the activityChanged() signal.
    63     by emitting the stateChanged() signal.
    64 
    64 
    65     Service request operations report progress information by emitting the 
    65     Service request operations report progress information by emitting the 
    66     progressChanged() signal.
    66     progressChanged() signal.
    67     
    67     
    68     If a requested operation fails after being initiated then the error() 
    68     If a requested operation fails after being initiated then the error() 
   126     
   126     
   127     Calling this function may result in the messagesFound() and progressChanged() 
   127     Calling this function may result in the messagesFound() and progressChanged() 
   128     signals  being emitted multiple times. An emission of the progressChanged()
   128     signals  being emitted multiple times. An emission of the progressChanged()
   129     signal with a total of 0 indicates that the number of progress steps is
   129     signal with a total of 0 indicates that the number of progress steps is
   130     unknown.
   130     unknown.
       
   131     
       
   132     The performance of querying messages is currently significantly less than 
       
   133     optimal for some querying criteria on some platforms.
   131     
   134     
   132     Returns true if the operation can be initiated; otherwise returns false.
   135     Returns true if the operation can be initiated; otherwise returns false.
   133 
   136 
   134     Note: This function should not initiate network activity, instead only message data
   137     Note: This function should not initiate network activity, instead only message data
   135     already stored on the device will be used during evaluation of the function.
   138     already stored on the device will be used during evaluation of the function.
   154     Calling this function may result in the messagesFound() and progressChanged() 
   157     Calling this function may result in the messagesFound() and progressChanged() 
   155     signals being emitted multiple times. An emission of the progressChanged()
   158     signals being emitted multiple times. An emission of the progressChanged()
   156     signal with a total of 0 indicates that the number of progress steps is
   159     signal with a total of 0 indicates that the number of progress steps is
   157     unknown.
   160     unknown.
   158 
   161 
       
   162     The performance of querying messages is currently significantly less than 
       
   163     optimal for some querying criteria on some platforms.
       
   164     
   159     Returns true if the operation can be initiated; otherwise returns false.
   165     Returns true if the operation can be initiated; otherwise returns false.
   160     
   166     
   161     Note: This function should not initiate network activity, instead only message data
   167     Note: This function should not initiate network activity, instead only message data
   162     already stored on the device will be used during evaluation of the function.
   168     already stored on the device will be used during evaluation of the function.
   163     
   169     
   173     Calling this function may result in the progressChanged() 
   179     Calling this function may result in the progressChanged() 
   174     signal  being emitted multiple times. An emission of the progressChanged()
   180     signal  being emitted multiple times. An emission of the progressChanged()
   175     signal with a total of 0 indicates that the number of progress steps is
   181     signal with a total of 0 indicates that the number of progress steps is
   176     unknown.
   182     unknown.
   177     
   183     
       
   184     The performance of counting messages is currently significantly less than optimal 
       
   185     for some filters on some platforms.
       
   186     
   178     Returns true if the operation can be initiated; otherwise returns false.
   187     Returns true if the operation can be initiated; otherwise returns false.
   179     
   188     
   180     Note: This function should not initiate network activity, instead only message data
   189     Note: This function should not initiate network activity, instead only message data
   181     already stored on the device will be used during evaluation of the function.
   190     already stored on the device will be used during evaluation of the function.
   182     
   191     
   192     
   201     
   193     The message will be stored in the standard Outbox folder for the account before
   202     The message will be stored in the standard Outbox folder for the account before
   194     transmission, or moved to that folder if it is already stored in another folder.
   203     transmission, or moved to that folder if it is already stored in another folder.
   195     If transmission is successful, the message will be moved to the standard Sent
   204     If transmission is successful, the message will be moved to the standard Sent
   196     folder for the account.
   205     folder for the account.
       
   206     
       
   207     Currently on the Maemo 5 (Fremantle) and Windows Mobile platforms the service 
       
   208     action object enters the FinishedState when the message is queued for sending 
       
   209     rather than actually sent.
   197   
   210   
   198     Returns true if the operation can be initiated; otherwise returns false.
   211     Returns true if the operation can be initiated; otherwise returns false.
   199     
   212     
   200     \sa QMessage, QMessageAccountId
   213     \sa QMessage, QMessageAccountId
   201 */
   214 */
   261 
   274 
   262     The default application for handling the type of message that \a id identifies should be used.
   275     The default application for handling the type of message that \a id identifies should be used.
   263 
   276 
   264     Returns true if the operation can be initiated; otherwise returns false.
   277     Returns true if the operation can be initiated; otherwise returns false.
   265     
   278     
       
   279     On the Maemo 5 (Fremantle) platform this function is not yet supported for SMS type messages.
       
   280     
   266     On the QMF platform implementation of this function is left as a task for system 
   281     On the QMF platform implementation of this function is left as a task for system 
   267     integrators.
   282     integrators.
   268     
   283     
   269     \sa QMessageId, QMessage::type()
   284     \sa QMessageId, QMessage::type()
   270 */
   285 */