KolabFolderSummary

KolabFolderSummary — Summary information for a Kolab PIM folder

Stability Level

Unstable, unless otherwise indicated

Synopsis

enum                KolabFolderSummaryCharFieldID;
enum                KolabFolderSummaryUintFieldID;
enum                KolabFolderSummaryUint64FieldID;
enum                KolabFolderSummaryIntFieldID;
enum                KolabFolderSummaryBoolFieldID;
                    KolabFolderSummary;
KolabFolderSummary* kolab_folder_summary_new            (void);
KolabFolderSummary* kolab_folder_summary_clone          (const KolabFolderSummary *summary);
void                kolab_folder_summary_free           (KolabFolderSummary *summary);
void                kolab_folder_summary_gdestroy       (gpointer data);
gboolean            kolab_folder_summary_check          (const KolabFolderSummary *summary);
void                kolab_folder_summary_set_char_field (KolabFolderSummary *summary,
                                                         KolabFolderSummaryCharFieldID field_id,
                                                         gchar *value);
const gchar*        kolab_folder_summary_get_char_field (const KolabFolderSummary *summary,
                                                         KolabFolderSummaryCharFieldID field_id);
void                kolab_folder_summary_set_uint_field (KolabFolderSummary *summary,
                                                         KolabFolderSummaryUintFieldID field_id,
                                                         guint value);
guint               kolab_folder_summary_get_uint_field (const KolabFolderSummary *summary,
                                                         KolabFolderSummaryUintFieldID field_id);
void                kolab_folder_summary_set_uint64_field
                                                        (KolabFolderSummary *summary,
                                                         KolabFolderSummaryUint64FieldID field_id,
                                                         guint64 value);
guint64             kolab_folder_summary_get_uint64_field
                                                        (const KolabFolderSummary *summary,
                                                         KolabFolderSummaryUint64FieldID field_id);
void                kolab_folder_summary_set_int_field  (KolabFolderSummary *summary,
                                                         KolabFolderSummaryIntFieldID field_id,
                                                         gint value);
gint                kolab_folder_summary_get_int_field  (const KolabFolderSummary *summary,
                                                         KolabFolderSummaryIntFieldID field_id);
void                kolab_folder_summary_set_bool_field (KolabFolderSummary *summary,
                                                         KolabFolderSummaryBoolFieldID field_id,
                                                         gboolean value);
gboolean            kolab_folder_summary_get_bool_field (const KolabFolderSummary *summary,
                                                         KolabFolderSummaryBoolFieldID field_id);
void                kolab_folder_summary_dump           (const KolabFolderSummary *summary);

Description

A KolabFolderSummary is stored permanently in the KolabMailInfoDb for each known Kolab PIM folder.

Details

enum KolabFolderSummaryCharFieldID

typedef enum {
	KOLAB_FOLDER_SUMMARY_CHAR_FIELD_FOLDERNAME = 0,
	/* LAST */
	KOLAB_FOLDER_SUMMARY_CHAR_LAST_FIELD
} KolabFolderSummaryCharFieldID;

enum KolabFolderSummaryUintFieldID

typedef enum {
	/* Kolab intern */
	KOLAB_FOLDER_SUMMARY_UINT_FIELD_CACHE_LOCATION = 0, /* KolabObjectCacheLocation */
	KOLAB_FOLDER_SUMMARY_UINT_FIELD_CACHE_STATUS,		/* KolabObjectCacheStatus */
	KOLAB_FOLDER_SUMMARY_UINT_FIELD_FOLDER_TYPE,		/* KolabFolderTypeID */
	KOLAB_FOLDER_SUMMARY_UINT_FIELD_FOLDER_CONTEXT,		/* KolabFolderContextID */
	/* LAST */
	KOLAB_FOLDER_SUMMARY_UINT_LAST_FIELD
}  KolabFolderSummaryUintFieldID;

enum KolabFolderSummaryUint64FieldID

typedef enum {
	KOLAB_FOLDER_SUMMARY_UINT64_FIELD_UIDVALIDITY = 0, /* IMAP folder uidvalidity (always updated) */
	KOLAB_FOLDER_SUMMARY_UINT64_FIELD_UIDVALIDITY_SYNC, /* IMAP folder uidvalidity (updated only after sync) */
	/* LAST */
	KOLAB_FOLDER_SUMMARY_UINT64_LAST_FIELD
} KolabFolderSummaryUint64FieldID;

enum KolabFolderSummaryIntFieldID

typedef enum {
	/* LAST */
	KOLAB_FOLDER_SUMMARY_INT_LAST_FIELD
} KolabFolderSummaryIntFieldID;

enum KolabFolderSummaryBoolFieldID

typedef enum {
	/* LAST */
	KOLAB_FOLDER_SUMMARY_BOOL_LAST_FIELD
} KolabFolderSummaryBoolFieldID;

KolabFolderSummary

typedef struct {
	gchar   *sdata_char[KOLAB_FOLDER_SUMMARY_CHAR_LAST_FIELD];
	guint    sdata_uint[KOLAB_FOLDER_SUMMARY_UINT_LAST_FIELD];
	guint64  sdata_uint64[KOLAB_FOLDER_SUMMARY_UINT64_LAST_FIELD];
#if 0
	gint     sdata_int[KOLAB_FOLDER_SUMMARY_INT_LAST_FIELD];
	gboolean sdata_bool[KOLAB_FOLDER_SUMMARY_BOOL_LAST_FIELD];
#endif
} KolabFolderSummary;

kolab_folder_summary_new ()

KolabFolderSummary* kolab_folder_summary_new            (void);

kolab_folder_summary_clone ()

KolabFolderSummary* kolab_folder_summary_clone          (const KolabFolderSummary *summary);

kolab_folder_summary_free ()

void                kolab_folder_summary_free           (KolabFolderSummary *summary);

kolab_folder_summary_gdestroy ()

void                kolab_folder_summary_gdestroy       (gpointer data);

kolab_folder_summary_check ()

gboolean            kolab_folder_summary_check          (const KolabFolderSummary *summary);

kolab_folder_summary_set_char_field ()

void                kolab_folder_summary_set_char_field (KolabFolderSummary *summary,
                                                         KolabFolderSummaryCharFieldID field_id,
                                                         gchar *value);

kolab_folder_summary_get_char_field ()

const gchar*        kolab_folder_summary_get_char_field (const KolabFolderSummary *summary,
                                                         KolabFolderSummaryCharFieldID field_id);

kolab_folder_summary_set_uint_field ()

void                kolab_folder_summary_set_uint_field (KolabFolderSummary *summary,
                                                         KolabFolderSummaryUintFieldID field_id,
                                                         guint value);

kolab_folder_summary_get_uint_field ()

guint               kolab_folder_summary_get_uint_field (const KolabFolderSummary *summary,
                                                         KolabFolderSummaryUintFieldID field_id);

kolab_folder_summary_set_uint64_field ()

void                kolab_folder_summary_set_uint64_field
                                                        (KolabFolderSummary *summary,
                                                         KolabFolderSummaryUint64FieldID field_id,
                                                         guint64 value);

kolab_folder_summary_get_uint64_field ()

guint64             kolab_folder_summary_get_uint64_field
                                                        (const KolabFolderSummary *summary,
                                                         KolabFolderSummaryUint64FieldID field_id);

kolab_folder_summary_set_int_field ()

void                kolab_folder_summary_set_int_field  (KolabFolderSummary *summary,
                                                         KolabFolderSummaryIntFieldID field_id,
                                                         gint value);

kolab_folder_summary_get_int_field ()

gint                kolab_folder_summary_get_int_field  (const KolabFolderSummary *summary,
                                                         KolabFolderSummaryIntFieldID field_id);

kolab_folder_summary_set_bool_field ()

void                kolab_folder_summary_set_bool_field (KolabFolderSummary *summary,
                                                         KolabFolderSummaryBoolFieldID field_id,
                                                         gboolean value);

kolab_folder_summary_get_bool_field ()

gboolean            kolab_folder_summary_get_bool_field (const KolabFolderSummary *summary,
                                                         KolabFolderSummaryBoolFieldID field_id);

kolab_folder_summary_dump ()

void                kolab_folder_summary_dump           (const KolabFolderSummary *summary);

See Also

KolabMailInfoDb, KolabMailSummary