qtmobility/src/contacts/qcontactfetchhint.cpp
changeset 5 453da2cfceef
parent 4 90517678cc4f
child 11 06b8e2af4411
equal deleted inserted replaced
4:90517678cc4f 5:453da2cfceef
    61    \o a list of detail definition names which the client is interested
    61    \o a list of detail definition names which the client is interested
    62   in (empty if interested in all detail definitions)
    62   in (empty if interested in all detail definitions)
    63    \o a list of relationship types which the client is interested in
    63    \o a list of relationship types which the client is interested in
    64   (empty if interested in all relationships)
    64   (empty if interested in all relationships)
    65    \o some optimization flags which allow the client to tell the backend if they are
    65    \o some optimization flags which allow the client to tell the backend if they are
    66   not interested in any relationships, any action preferences, or any binary blobs (images etc).
    66   not interested in any relationships or any binary blobs (images etc).
    67   \endlist
    67   \endlist
    68 
    68 
    69   Important note: a client should not make changes to a contact which has been retrieved
    69   Important note: a client should not make changes to a contact which has been retrieved
    70   using a fetch hint other than the default fetch hint.  Doing so will result in information
    70   using a fetch hint other than the default fetch hint.  Doing so will result in information
    71   loss when saving the contact back to the manager (as the "new" restricted contact will
    71   loss when saving the contact back to the manager (as the "new" restricted contact will
    79   not require certain information.  The backend may safely ignore the hint, but then
    79   not require certain information.  The backend may safely ignore the hint, but then
    80   must return the full set of information relating to the optimization hint.
    80   must return the full set of information relating to the optimization hint.
    81 
    81 
    82   \value AllRequired Tells the backend that all information is required
    82   \value AllRequired Tells the backend that all information is required
    83   \value NoRelationships Tells the backend that the client does not require retrieved contacts to include a cache of relationships
    83   \value NoRelationships Tells the backend that the client does not require retrieved contacts to include a cache of relationships
    84   \value NoActionPreferences Tells the backend that the client does not require retrieved contacts to include a cache of action preferences
    84   \omitvalue NoActionPreferences Tells the backend that the client does not require retrieved contacts to include a cache of action preferences
    85   \value NoBinaryBlobs Tells the backend that the client does not require retrieved contacts to include binary blobs such as thumbnail images
    85   \value NoBinaryBlobs Tells the backend that the client does not require retrieved contacts to include binary blobs such as thumbnail images
    86  */
    86  */
    87 
    87 
    88 /*!
    88 /*!
    89   Constructs a new contact fetch hint which requests that the backend fetch all information
    89   Constructs a new contact fetch hint which requests that the backend fetch all information
   171 
   171 
   172 /*!
   172 /*!
   173   Returns the optimization hint flags specified by the client.
   173   Returns the optimization hint flags specified by the client.
   174   These hints may be ignored by the backend, in which case it will return
   174   These hints may be ignored by the backend, in which case it will return
   175   the full set of information accessible in a contact, including
   175   the full set of information accessible in a contact, including
   176   relationships, action preferences, and binary blobs.
   176   relationships and binary blobs.
   177 
   177 
   178   \sa setOptimizationHints()
   178   \sa setOptimizationHints()
   179  */
   179  */
   180 QContactFetchHint::OptimizationHints QContactFetchHint::optimizationHints() const
   180 QContactFetchHint::OptimizationHints QContactFetchHint::optimizationHints() const
   181 {
   181 {
   184 
   184 
   185 /*!
   185 /*!
   186   Sets the optimization hint flags specified by the client to \a hints.
   186   Sets the optimization hint flags specified by the client to \a hints.
   187   These hints may be ignored by the backend, in which case it will return
   187   These hints may be ignored by the backend, in which case it will return
   188   the full set of information accessible in a contact, including
   188   the full set of information accessible in a contact, including
   189   relationships, action preferences, and binary blobs.
   189   relationships and binary blobs.
   190 
   190 
   191   \sa optimizationHints()
   191   \sa optimizationHints()
   192  */
   192  */
   193 void QContactFetchHint::setOptimizationHints(OptimizationHints hints)
   193 void QContactFetchHint::setOptimizationHints(OptimizationHints hints)
   194 {
   194 {