save_component_sync


Description:

public virtual bool save_component_sync (bool overwrite_existing, ConflictResolution conflict_resolution, SList<Component> instances, string? extra, OperationFlags opflags, out string out_new_uid, out string out_new_extra, Cancellable? cancellable = null) throws Error

Saves one component into the remote side.

The instances contain the master object and all the detached instances of the same component (all have the same UID). When the overwrite_existing is true, then the descendant can overwrite an object with the same UID on the remote side (usually used for modify). The conflict_resolution defines what to do when the remote side had made any changes to the object since the last update.

The descendant can use merge_instances to merge the instances into one VCALENDAR component, which will contain also used time zones.

The components in instances have already converted locally stored attachments into inline attachments, thus it's not needed to call inline_local_attachments_sync by the descendant.

The out_new_uid can be populated with a UID of the saved component as the server assigned it to it. This UID, if set, is loaded from the remote side afterwards, also to see whether any changes had been made to the component by the remote side.

The out_new_extra can be populated with a new extra data to save with the component. Left it null , to keep the same value as the extra.

The descendant can use an OUT_OF_SYNC error to indicate that the save failed due to made changes on the remote side, and let the this to resolve this conflict based on the conflict_resolution on its own. The OUT_OF_SYNC error should not be used when the descendant is able to resolve the conflicts itself.

It is mandatory to implement this virtual method by the writable descendant.

Parameters:

this

an CalMetaBackend

overwrite_existing

true when can overwrite existing components, false otherwise

conflict_resolution

one of ConflictResolution, what to do on conflicts

instances

instances of the component to save

extra

extra data saved with the components in an CalCache

opflags

bit-or of OperationFlags

out_new_uid

return location for the UID of the saved component

out_new_extra

return location for the extra data to store with the component

cancellable

optional Cancellable object, or null

Returns:

Whether succeeded.