ESourceRevisionGuards

ESourceRevisionGuards — ESource extension to configure revision guards

Functions

Properties

gboolean enabled Read / Write / Construct

Types and Values

Object Hierarchy

    GObject
    ╰── ESourceExtension
        ╰── ESourceRevisionGuards

Includes

#include <libedataserver/libedataserver.h>

Description

The ESourceRevisionGuards extension configures whether revisions should be checked on modified objects. If a modified object has a conflicting revision with an existing object, then an E_CLIENT_ERROR_OUT_OF_SYNC error should be produced for that object and the modification should be discarded.

Access the extension as follows:

  #include <libedataserver/libedataserver.h>

  ESourceRevisionGuards *extension;

  extension = e_source_get_extension (source, E_SOURCE_EXTENSION_REVISION_GUARDS);

Functions

e_source_revision_guards_get_enabled ()

gboolean
e_source_revision_guards_get_enabled (ESourceRevisionGuards *extension);

Checks whether revision guards for the given ESource are enabled.

Parameters

extension

An ESourceRevisionGuards

 

Returns

TRUE if the revision guards are enabled.

Since 3.8


e_source_revision_guards_set_enabled ()

void
e_source_revision_guards_set_enabled (ESourceRevisionGuards *extension,
                                      gboolean enabled);

Enables or disables the revision guards for a given ESource.

Revision guards are disabled by default.

Parameters

extension

An ESourceRevisionGuards

 

enabled

Whether to enable or disable the revision guards.

 

Since 3.8

Types and Values

struct ESourceRevisionGuards

struct ESourceRevisionGuards;

Contains only private data that should be read and manipulated using the functions below.

Since 3.8


E_SOURCE_EXTENSION_REVISION_GUARDS

#define E_SOURCE_EXTENSION_REVISION_GUARDS "Revision Guards"

Pass this extension name to e_source_get_extension() to access ESourceRevisionGuards. This is also used as a group name in key files.

Since 3.8

Property Details

The “enabled” property

  “enabled”                  gboolean

Whether to enable or disable the revision guards.

Flags: Read / Write / Construct

Default value: FALSE