QOrganizerItemSaveRequest Class
The QOrganizerItemSaveRequest class allows a client to asynchronously request that certain organizer items be saved to a backend. More...
Header: | #include <QOrganizerItemSaveRequest> |
Inherits: | QOrganizerAbstractRequest |
Public Functions
QOrganizerItemSaveRequest(QObject * parent = 0) | |
~QOrganizerItemSaveRequest() | |
QList<QOrganizerItemDetail::DetailType> | detailMask() const |
QMap<int, QOrganizerManager::Error> | errorMap() const |
QList<QOrganizerItem> | items() const |
void | setDetailMask(const QList<QOrganizerItemDetail::DetailType> & detailMask) |
void | setItem(const QOrganizerItem & item) |
void | setItems(const QList<QOrganizerItem> & items) |
- 9 public functions inherited from QOrganizerAbstractRequest
Additional Inherited Members
- 3 public slots inherited from QOrganizerAbstractRequest
- 2 signals inherited from QOrganizerAbstractRequest
Detailed Description
The QOrganizerItemSaveRequest class allows a client to asynchronously request that certain organizer items be saved to a backend.
Member Function Documentation
QOrganizerItemSaveRequest::QOrganizerItemSaveRequest(QObject * parent = 0)
Constructs a new organizer item save request whose parent is the specified parent.
QOrganizerItemSaveRequest::~QOrganizerItemSaveRequest()
Frees memory in use by this request.
QList<QOrganizerItemDetail::DetailType> QOrganizerItemSaveRequest::detailMask() const
Returns the list of definitions that this request will operate on.
If the list is empty, the request will operate on all details.
See also setDetailMask().
QMap<int, QOrganizerManager::Error> QOrganizerItemSaveRequest::errorMap() const
Returns the map of input definition list indices to errors which occurred.
QList<QOrganizerItem> QOrganizerItemSaveRequest::items() const
Returns the list of organizer items which will be saved if called prior to calling start(), otherwise returns the list of organizer items as they were saved in the organizer item store.
See also setItems().
void QOrganizerItemSaveRequest::setDetailMask(const QList<QOrganizerItemDetail::DetailType> & detailMask)
Set the list of detail types to restrict saving to detailMask. This allows you to perform partial save (and remove) operations on existing items.
If detailMask is empty (the default), no restrictions will apply, and the passed in items will be saved as is. Otherwise, only details whose types are in the list will be saved. If a detail type is present in the list, but there are no corresponding details in the item passed into this request, any existing details in the manager for that item will be removed.
This is useful if you've used a fetch hint to fetch a partial item from a manager so that you can save changes to the details you actually fetched without removing the details you didn't.
Additionally, when performing synchronization operations with other managers that don't support the full range of details, you can restrict the update operation to only those details so that you don't lose the extra details that are supported in this manager.
Note: Some managers do not support partial updates natively, in which case the QtOrganizer framework will emulate the functionality (fetching the whole item, applying the new restricted details, and saving the item back).
See also detailMask().
void QOrganizerItemSaveRequest::setItem(const QOrganizerItem & item)
Sets the organizer item to be saved to item. Equivalent to calling:
setItems(QList<QOrganizerItem>() << item);
void QOrganizerItemSaveRequest::setItems(const QList<QOrganizerItem> & items)
Sets the list of organizer items to be saved to items.
See also items().