## empathy-contact-list

empathy-contact-list

## Synopsis

                        EmpathyContactList;
                        EmpathyContactListIface;
    void                empathy_contact_list_add            (EmpathyContactList *list,
                                                             EmpathyContact *contact,
                                                             const gchar *message);
    void                empathy_contact_list_remove         (EmpathyContactList *list,
                                                             EmpathyContact *contact,
                                                             const gchar *message);
    GList*              empathy_contact_list_get_members    (EmpathyContactList *list);
    GList*              empathy_contact_list_get_pendings   (EmpathyContactList *list);
    GList*              empathy_contact_list_get_all_groups (EmpathyContactList *list);
    GList*              empathy_contact_list_get_groups     (EmpathyContactList *list,
                                                             EmpathyContact *contact);
    void                empathy_contact_list_add_to_group   (EmpathyContactList *list,
                                                             EmpathyContact *contact,
                                                             const gchar *group);
    void                empathy_contact_list_remove_from_group
                                                            (EmpathyContactList *list,
                                                             EmpathyContact *contact,
                                                             const gchar *group);
    void                empathy_contact_list_rename_group   (EmpathyContactList *list,
                                                             const gchar *old_group,
                                                             const gchar *new_group);

## Object Hierarchy

      GInterface
       +----EmpathyContactList

## Known Implementations

EmpathyContactList is implemented by EmpathyContactManager, EmpathyTpContactList and EmpathyTpChatroom.

## Signals

      "groups-changed"                                 : Run Last
      "members-changed"                                : Run Last
      "pendings-changed"                               : Run Last

## Description

## Details

### EmpathyContactList

    typedef struct _EmpathyContactList EmpathyContactList;

### EmpathyContactListIface

    typedef struct {
    	GTypeInterface   base_iface;

    	/* VTabled */
    	void             (*add)               (EmpathyContactList *list,
    					       EmpathyContact     *contact,
    					       const gchar        *message);
    	void             (*remove)            (EmpathyContactList *list,
    					       EmpathyContact     *contact,
    					       const gchar        *message);
    	GList *          (*get_members)       (EmpathyContactList *list);
    	GList *          (*get_pendings)      (EmpathyContactList *list);
    	GList *          (*get_all_groups)    (EmpathyContactList *list);
    	GList *          (*get_groups)        (EmpathyContactList *list,
    					       EmpathyContact     *contact);
    	void             (*add_to_group)      (EmpathyContactList *list,
    					       EmpathyContact     *contact,
    					       const gchar        *group);
    	void             (*remove_from_group) (EmpathyContactList *list,
    					       EmpathyContact     *contact,
    					       const gchar        *group);
    	void             (*rename_group)      (EmpathyContactList *list,
    					       const gchar        *old_group,
    					       const gchar        *new_group);
    } EmpathyContactListIface;

### empathy_contact_list_add ()

    void                empathy_contact_list_add            (EmpathyContactList *list,
                                                             EmpathyContact *contact,
                                                             const gchar *message);

`list` : |
`contact` : |
`message` : |

### empathy_contact_list_remove ()

    void                empathy_contact_list_remove         (EmpathyContactList *list,
                                                             EmpathyContact *contact,
                                                             const gchar *message);

`list` : |
`contact` : |
`message` : |

### empathy_contact_list_get_members ()

    GList*              empathy_contact_list_get_members    (EmpathyContactList *list);

`list` : |
Returns : |

### empathy_contact_list_get_pendings ()

    GList*              empathy_contact_list_get_pendings   (EmpathyContactList *list);

`list` : |
Returns : |

### empathy_contact_list_get_all_groups ()

    GList*              empathy_contact_list_get_all_groups (EmpathyContactList *list);

`list` : |
Returns : |

### empathy_contact_list_get_groups ()

    GList*              empathy_contact_list_get_groups     (EmpathyContactList *list,
                                                             EmpathyContact *contact);

`list` : |
`contact` : |
Returns : |

### empathy_contact_list_add_to_group ()

    void                empathy_contact_list_add_to_group   (EmpathyContactList *list,
                                                             EmpathyContact *contact,
                                                             const gchar *group);

`list` : |
`contact` : |
`group` : |

### empathy_contact_list_remove_from_group ()

    void                empathy_contact_list_remove_from_group
                                                            (EmpathyContactList *list,
                                                             EmpathyContact *contact,
                                                             const gchar *group);

`list` : |
`contact` : |
`group` : |

### empathy_contact_list_rename_group ()

    void                empathy_contact_list_rename_group   (EmpathyContactList *list,
                                                             const gchar *old_group,
                                                             const gchar *new_group);

`list` : |
`old_group` : |
`new_group` : |

## Signal Details

### The "groups-changed" signal

    void                user_function                      (EmpathyContactList *empathycontactlist,
                                                            EmpathyContact     *arg1,
                                                            gchar              *arg2,
                                                            gboolean            arg3,
                                                            gpointer            user_data)               : Run Last

`empathycontactlist` : | the object which received the signal.
`arg1` : |
`arg2` : |
`arg3` : |
`user_data` : | user data set when the signal handler was connected.

### The "members-changed" signal

    void                user_function                      (EmpathyContactList *empathycontactlist,
                                                            EmpathyContact     *arg1,
                                                            EmpathyContact     *arg2,
                                                            guint               arg3,
                                                            gchar              *arg4,
                                                            gboolean            arg5,
                                                            gpointer            user_data)               : Run Last

`empathycontactlist` : | the object which received the signal.
`arg1` : |
`arg2` : |
`arg3` : |
`arg4` : |
`arg5` : |
`user_data` : | user data set when the signal handler was connected.

### The "pendings-changed" signal

    void                user_function                      (EmpathyContactList *empathycontactlist,
                                                            EmpathyContact     *arg1,
                                                            EmpathyContact     *arg2,
                                                            guint               arg3,
                                                            gchar              *arg4,
                                                            gboolean            arg5,
                                                            gpointer            user_data)               : Run Last

`empathycontactlist` : | the object which received the signal.
`arg1` : |
`arg2` : |
`arg3` : |
`arg4` : |
`arg5` : |
`user_data` : | user data set when the signal handler was connected.