1 /*

     2  * vcard-manager.h - vCard lookup helper for Gabble connections

     3  *

     4  * Copyright (C) 2006 Collabora Ltd.

     5  * 

     6  *

     7  * This library is free software; you can redistribute it and/or

     8  * modify it under the terms of the GNU Lesser General Public

     9  * License as published by the Free Software Foundation; either

    10  * version 2.1 of the License, or (at your option) any later version.

    11  *

    12  * This library is distributed in the hope that it will be useful,

    13  * but WITHOUT ANY WARRANTY; without even the implied warranty of

    14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

    15  * Lesser General Public License for more details.

    16  *

    17  * You should have received a copy of the GNU Lesser General Public

    18  * License along with this library; if not, write to the Free Software

    19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    20  */

    21 

    22 #ifndef __GABBLE_VCARD_MANAGER_H__

    23 #define __GABBLE_VCARD_MANAGER_H__

    24 

    25 #include <glib-object.h>

    26 #include "loudmouth/loudmouth.h"

    27 

    28 #include "gabble-types.h"

    29 

    30 G_BEGIN_DECLS

    31 

    32 typedef struct _GabbleVCardManagerClass GabbleVCardManagerClass;

    33 typedef struct _GabbleVCardManagerRequest GabbleVCardManagerRequest;

    34 

    35 /**

    36  * GabbleVCardManagerError:

    37  * @GABBLE_VCARD_MANAGER_ERROR_CANCELLED: The vCard request was cancelled

    38  * @GABBLE_VCARD_MANAGER_ERROR_TIMEOUT: The vCard request timed out

    39  * @GABBLE_VCARD_MANAGER_ERROR_UNKNOWN: An unknown error occured

    40  */

    41 typedef enum

    42 {

    43   GABBLE_VCARD_MANAGER_ERROR_CANCELLED,

    44   GABBLE_VCARD_MANAGER_ERROR_TIMEOUT,

    45   GABBLE_VCARD_MANAGER_ERROR_UNKNOWN

    46 } GabbleVCardManagerError;

    47 

    48 GQuark gabble_vcard_manager_error_quark (void);

    49 #define GABBLE_VCARD_MANAGER_ERROR gabble_vcard_manager_error_quark ()

    50 

    51 IMPORT_C GType gabble_vcard_manager_get_type(void);

    52 

    53 /* TYPE MACROS */

    54 #define GABBLE_TYPE_VCARD_MANAGER \

    55   (gabble_vcard_manager_get_type())

    56 #define GABBLE_VCARD_MANAGER(obj) \

    57   (G_TYPE_CHECK_INSTANCE_CAST((obj), GABBLE_TYPE_VCARD_MANAGER, GabbleVCardManager))

    58 #define GABBLE_VCARD_MANAGER_CLASS(klass) \

    59   (G_TYPE_CHECK_CLASS_CAST((klass), GABBLE_TYPE_VCARD_MANAGER, GabbleVCardManagerClass))

    60 #define GABBLE_IS_VCARD_MANAGER(obj) \

    61   (G_TYPE_CHECK_INSTANCE_TYPE((obj), GABBLE_TYPE_VCARD_MANAGER))

    62 #define GABBLE_IS_VCARD_MANAGER_CLASS(klass) \

    63   (G_TYPE_CHECK_CLASS_TYPE((klass), GABBLE_TYPE_VCARD_MANAGER))

    64 #define GABBLE_VCARD_MANAGER_GET_CLASS(obj) \

    65   (G_TYPE_INSTANCE_GET_CLASS ((obj), GABBLE_TYPE_VCARD_MANAGER, GabbleVCardManagerClass))

    66 

    67 struct _GabbleVCardManagerClass {

    68     GObjectClass parent_class;

    69 };

    70 

    71 struct _GabbleVCardManager {

    72     GObject parent;

    73     gpointer priv;

    74 };

    75 

    76 typedef void (*GabbleVCardManagerCb)(GabbleVCardManager *self,

    77                                     GabbleVCardManagerRequest *request,

    78                                     GabbleHandle handle,

    79                                     LmMessageNode *vcard,

    80                                     GError *error,

    81                                     gpointer user_data);

    82 

    83 GabbleVCardManager *gabble_vcard_manager_new (GabbleConnection *);

    84 

    85 GQuark gabble_vcard_manager_cache_quark (void);

    86 

    87 GabbleVCardManagerRequest *gabble_vcard_manager_request (GabbleVCardManager *,

    88                                                        GabbleHandle,

    89                                                        guint timeout,

    90                                                        GabbleVCardManagerCb,

    91                                                        gpointer user_data,

    92                                                        GObject *object,

    93                                                        GError **error);

    94 

    95 GabbleVCardManagerRequest *gabble_vcard_manager_replace (GabbleVCardManager *,

    96                                                        LmMessageNode *,

    97                                                        guint timeout,

    98                                                        GabbleVCardManagerCb,

    99                                                        gpointer user_data,

   100                                                        GObject *object,

   101                                                        GError **error);

   102 

   103 GabbleVCardManagerRequest *gabble_vcard_manager_edit (GabbleVCardManager *,

   104                                                     guint timeout,

   105                                                     GabbleVCardManagerCb,

   106                                                     gpointer user_data,

   107                                                     GObject *object,

   108                                                     GError **error,

   109                                                     ...)

   110                                                    G_GNUC_NULL_TERMINATED;

   111 

   112 void gabble_vcard_manager_cancel_request (GabbleVCardManager *manager,

   113                                           GabbleVCardManagerRequest *request);

   114 

   115 const gchar *gabble_vcard_manager_get_cached_alias (GabbleVCardManager *,

   116                                                    GabbleHandle);

   117 gboolean gabble_vcard_manager_has_cached_alias (GabbleVCardManager *manager,

   118                                                 GabbleHandle handle);

   119 

   120 G_END_DECLS

   121 

   122 #endif