ECalClientView

ECalClientView

Functions

Properties

ECalClient * client Read / Write / Construct Only
gpointer view Read / Write / Construct Only

Signals

void complete Run First
void objects-added Run First
void objects-modified Run First
void objects-removed Run First
void progress Run First

Types and Values

Object Hierarchy

    GObject
    ╰── ECalClientView

Description

Functions

e_cal_client_view_get_client ()

struct _ECalClient *
e_cal_client_view_get_client (ECalClientView *view);

Get the ECalClient associated with this view.

Parameters

view

A ECalClientView object.

 

Returns

the associated client.

Since 3.2


e_cal_client_view_is_running ()

gboolean
e_cal_client_view_is_running (ECalClientView *view);

Retunrs: Whether view is running. Not running views are ignoring all events sent from the server.

Parameters

view

an ECalClientView

 

Since 3.2


e_cal_client_view_set_fields_of_interest ()

void
e_cal_client_view_set_fields_of_interest
                               (ECalClientView *view,
                                const GSList *fields_of_interest,
                                GError **error);

Client can instruct server to which fields it is interested in only, thus the server can return less data over the wire. The server can still return complete objects, this is just a hint to it that the listed fields will be used only. The UID/RID fields are returned always. Initial views has no fields of interest and using NULL for fields_of_interest will unset any previous changes.

Some backends can use summary information of its cache to create artifical objects, which will omit stored object parsing. If this cannot be done then it will simply return object as is stored in the cache.

Parameters

view

An ECalClientView object

 

fields_of_interest

List of field names in which the client is interested

 

error

A GError

 

e_cal_client_view_start ()

void
e_cal_client_view_start (ECalClientView *view,
                         GError **error);

Starts a live query to the calendar/tasks backend.

Parameters

view

An ECalClientView object.

 

error

A Gerror

 

Since 3.2


e_cal_client_view_stop ()

void
e_cal_client_view_stop (ECalClientView *view,
                        GError **error);

Stops a live query to the calendar/tasks backend.

Parameters

view

An ECalClientView object.

 

error

A GError

 

Since 3.2

Types and Values

struct ECalClientView

struct ECalClientView;

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

Since 3.2

Property Details

The “client” property

  “client”                   ECalClient *

Flags: Read / Write / Construct Only


The “view” property

  “view”                     gpointer

Flags: Read / Write / Construct Only

Signal Details

The “complete” signal

void
user_function (ECalClientView *ecalclientview,
               GError         *arg1,
               gpointer        user_data)

Flags: Run First


The “objects-added” signal

void
user_function (ECalClientView *view:,
               gpointer        objects,
               gpointer        user_data)

Parameters

view:

self

 

objects

.

[type GSList][transfer none][element-type long]

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “objects-modified” signal

void
user_function (ECalClientView *view:,
               gpointer        objects,
               gpointer        user_data)

Parameters

view:

self

 

objects

.

[type GSList][transfer none][element-type long]

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “objects-removed” signal

void
user_function (ECalClientView *view:,
               gpointer        objects,
               gpointer        user_data)

Parameters

view:

self

 

objects

.

[type GSList][transfer none][element-type ECalComponentId]

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “progress” signal

void
user_function (ECalClientView *ecalclientview,
               guint           arg1,
               gchar          *arg2,
               gpointer        user_data)

Flags: Run First