<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="libempathy-empathy-contact-list">
<refmeta>
<refentrytitle role="top_of_page" id="libempathy-empathy-contact-list.top_of_page">empathy-contact-list</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBEMPATHY Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>empathy-contact-list</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="libempathy-empathy-contact-list.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<anchor id="EmpathyContactList"/>
<synopsis>
                    <link linkend="EmpathyContactList-struct">EmpathyContactList</link>;
                    <link linkend="EmpathyContactListIface">EmpathyContactListIface</link>;
<link linkend="void">void</link>                <link linkend="empathy-contact-list-add">empathy_contact_list_add</link>            (<link linkend="EmpathyContactList">EmpathyContactList</link> *list,
                                                         <link linkend="EmpathyContact">EmpathyContact</link> *contact,
                                                         const <link linkend="gchar">gchar</link> *message);
<link linkend="void">void</link>                <link linkend="empathy-contact-list-remove">empathy_contact_list_remove</link>         (<link linkend="EmpathyContactList">EmpathyContactList</link> *list,
                                                         <link linkend="EmpathyContact">EmpathyContact</link> *contact,
                                                         const <link linkend="gchar">gchar</link> *message);
<link linkend="GList">GList</link>*              <link linkend="empathy-contact-list-get-members">empathy_contact_list_get_members</link>    (<link linkend="EmpathyContactList">EmpathyContactList</link> *list);
<link linkend="GList">GList</link>*              <link linkend="empathy-contact-list-get-pendings">empathy_contact_list_get_pendings</link>   (<link linkend="EmpathyContactList">EmpathyContactList</link> *list);
<link linkend="GList">GList</link>*              <link linkend="empathy-contact-list-get-all-groups">empathy_contact_list_get_all_groups</link> (<link linkend="EmpathyContactList">EmpathyContactList</link> *list);
<link linkend="GList">GList</link>*              <link linkend="empathy-contact-list-get-groups">empathy_contact_list_get_groups</link>     (<link linkend="EmpathyContactList">EmpathyContactList</link> *list,
                                                         <link linkend="EmpathyContact">EmpathyContact</link> *contact);
<link linkend="void">void</link>                <link linkend="empathy-contact-list-add-to-group">empathy_contact_list_add_to_group</link>   (<link linkend="EmpathyContactList">EmpathyContactList</link> *list,
                                                         <link linkend="EmpathyContact">EmpathyContact</link> *contact,
                                                         const <link linkend="gchar">gchar</link> *group);
<link linkend="void">void</link>                <link linkend="empathy-contact-list-remove-from-group">empathy_contact_list_remove_from_group</link>
                                                        (<link linkend="EmpathyContactList">EmpathyContactList</link> *list,
                                                         <link linkend="EmpathyContact">EmpathyContact</link> *contact,
                                                         const <link linkend="gchar">gchar</link> *group);
<link linkend="void">void</link>                <link linkend="empathy-contact-list-rename-group">empathy_contact_list_rename_group</link>   (<link linkend="EmpathyContactList">EmpathyContactList</link> *list,
                                                         const <link linkend="gchar">gchar</link> *old_group,
                                                         const <link linkend="gchar">gchar</link> *new_group);
<link linkend="void">void</link>                <link linkend="empathy-contact-list-remove-group">empathy_contact_list_remove_group</link>   (<link linkend="EmpathyContactList">EmpathyContactList</link> *list,
                                                         const <link linkend="gchar">gchar</link> *group);
</synopsis>
</refsynopsisdiv>

<refsect1 id="libempathy-empathy-contact-list.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GInterface">GInterface</link>
   +----EmpathyContactList
</synopsis>

</refsect1>

<refsect1 id="libempathy-empathy-contact-list.prerequisites" role="prerequisites">
<title role="prerequisites.title">Prerequisites</title>
<para>
EmpathyContactList requires
 <link linkend="GObject">GObject</link>.</para>

</refsect1>



<refsect1 id="libempathy-empathy-contact-list.implementations" role="implementations">
<title role="implementations.title">Known Implementations</title>
<para>
EmpathyContactList is implemented by
 <link linkend="EmpathyContactManager">EmpathyContactManager</link>,  <link linkend="EmpathyTpContactList">EmpathyTpContactList</link> and  <link linkend="EmpathyTpChat">EmpathyTpChat</link>.</para>

</refsect1>


<refsect1 id="libempathy-empathy-contact-list.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
  &quot;<link linkend="EmpathyContactList-groups-changed">groups-changed</link>&quot;                                 : Run Last
  &quot;<link linkend="EmpathyContactList-members-changed">members-changed</link>&quot;                                : Run Last
  &quot;<link linkend="EmpathyContactList-pendings-changed">pendings-changed</link>&quot;                               : Run Last
</synopsis>
</refsect1>


<refsect1 id="libempathy-empathy-contact-list.description" role="desc">
<title role="desc.title">Description</title>
<para>

</para>
</refsect1>

<refsect1 id="libempathy-empathy-contact-list.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="EmpathyContactList-struct" role="struct">
<title>EmpathyContactList</title>
<indexterm zone="EmpathyContactList-struct"><primary>EmpathyContactList</primary></indexterm><programlisting>typedef struct _EmpathyContactList EmpathyContactList;</programlisting>
<para>

</para></refsect2>
<refsect2 id="EmpathyContactListIface" role="struct">
<title>EmpathyContactListIface</title>
<indexterm zone="EmpathyContactListIface"><primary>EmpathyContactListIface</primary></indexterm><programlisting>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);
	void		 (*remove_group)      (EmpathyContactList *list,
					       const gchar	  *group);
} EmpathyContactListIface;
</programlisting>
<para>

</para></refsect2>
<refsect2 id="empathy-contact-list-add" role="function">
<title>empathy_contact_list_add ()</title>
<indexterm zone="empathy-contact-list-add"><primary>empathy_contact_list_add</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_contact_list_add            (<link linkend="EmpathyContactList">EmpathyContactList</link> *list,
                                                         <link linkend="EmpathyContact">EmpathyContact</link> *contact,
                                                         const <link linkend="gchar">gchar</link> *message);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>contact</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>message</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-contact-list-remove" role="function">
<title>empathy_contact_list_remove ()</title>
<indexterm zone="empathy-contact-list-remove"><primary>empathy_contact_list_remove</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_contact_list_remove         (<link linkend="EmpathyContactList">EmpathyContactList</link> *list,
                                                         <link linkend="EmpathyContact">EmpathyContact</link> *contact,
                                                         const <link linkend="gchar">gchar</link> *message);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>contact</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>message</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-contact-list-get-members" role="function">
<title>empathy_contact_list_get_members ()</title>
<indexterm zone="empathy-contact-list-get-members"><primary>empathy_contact_list_get_members</primary></indexterm><programlisting><link linkend="GList">GList</link>*              empathy_contact_list_get_members    (<link linkend="EmpathyContactList">EmpathyContactList</link> *list);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-contact-list-get-pendings" role="function">
<title>empathy_contact_list_get_pendings ()</title>
<indexterm zone="empathy-contact-list-get-pendings"><primary>empathy_contact_list_get_pendings</primary></indexterm><programlisting><link linkend="GList">GList</link>*              empathy_contact_list_get_pendings   (<link linkend="EmpathyContactList">EmpathyContactList</link> *list);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-contact-list-get-all-groups" role="function">
<title>empathy_contact_list_get_all_groups ()</title>
<indexterm zone="empathy-contact-list-get-all-groups"><primary>empathy_contact_list_get_all_groups</primary></indexterm><programlisting><link linkend="GList">GList</link>*              empathy_contact_list_get_all_groups (<link linkend="EmpathyContactList">EmpathyContactList</link> *list);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-contact-list-get-groups" role="function">
<title>empathy_contact_list_get_groups ()</title>
<indexterm zone="empathy-contact-list-get-groups"><primary>empathy_contact_list_get_groups</primary></indexterm><programlisting><link linkend="GList">GList</link>*              empathy_contact_list_get_groups     (<link linkend="EmpathyContactList">EmpathyContactList</link> *list,
                                                         <link linkend="EmpathyContact">EmpathyContact</link> *contact);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>contact</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-contact-list-add-to-group" role="function">
<title>empathy_contact_list_add_to_group ()</title>
<indexterm zone="empathy-contact-list-add-to-group"><primary>empathy_contact_list_add_to_group</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_contact_list_add_to_group   (<link linkend="EmpathyContactList">EmpathyContactList</link> *list,
                                                         <link linkend="EmpathyContact">EmpathyContact</link> *contact,
                                                         const <link linkend="gchar">gchar</link> *group);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>contact</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>group</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-contact-list-remove-from-group" role="function">
<title>empathy_contact_list_remove_from_group ()</title>
<indexterm zone="empathy-contact-list-remove-from-group"><primary>empathy_contact_list_remove_from_group</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_contact_list_remove_from_group
                                                        (<link linkend="EmpathyContactList">EmpathyContactList</link> *list,
                                                         <link linkend="EmpathyContact">EmpathyContact</link> *contact,
                                                         const <link linkend="gchar">gchar</link> *group);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>contact</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>group</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-contact-list-rename-group" role="function">
<title>empathy_contact_list_rename_group ()</title>
<indexterm zone="empathy-contact-list-rename-group"><primary>empathy_contact_list_rename_group</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_contact_list_rename_group   (<link linkend="EmpathyContactList">EmpathyContactList</link> *list,
                                                         const <link linkend="gchar">gchar</link> *old_group,
                                                         const <link linkend="gchar">gchar</link> *new_group);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>old_group</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_group</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-contact-list-remove-group" role="function">
<title>empathy_contact_list_remove_group ()</title>
<indexterm zone="empathy-contact-list-remove-group"><primary>empathy_contact_list_remove_group</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_contact_list_remove_group   (<link linkend="EmpathyContactList">EmpathyContactList</link> *list,
                                                         const <link linkend="gchar">gchar</link> *group);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>group</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>

<refsect1 id="libempathy-empathy-contact-list.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="EmpathyContactList-groups-changed"><title>The <literal>&quot;groups-changed&quot;</literal> signal</title>
<indexterm zone="EmpathyContactList-groups-changed"><primary>EmpathyContactList::groups-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EmpathyContactList">EmpathyContactList</link> *empathycontactlist,
                                                        <link linkend="EmpathyContact">EmpathyContact</link>     *arg1,
                                                        <link linkend="gchar">gchar</link>              *arg2,
                                                        <link linkend="gboolean">gboolean</link>            arg3,
                                                        <link linkend="gpointer">gpointer</link>            user_data)               : Run Last</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>empathycontactlist</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg2</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg3</parameter>&nbsp;:</term>
<listitem><simpara>

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="EmpathyContactList-members-changed"><title>The <literal>&quot;members-changed&quot;</literal> signal</title>
<indexterm zone="EmpathyContactList-members-changed"><primary>EmpathyContactList::members-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EmpathyContactList">EmpathyContactList</link> *empathycontactlist,
                                                        <link linkend="EmpathyContact">EmpathyContact</link>     *arg1,
                                                        <link linkend="EmpathyContact">EmpathyContact</link>     *arg2,
                                                        <link linkend="guint">guint</link>               arg3,
                                                        <link linkend="gchar">gchar</link>              *arg4,
                                                        <link linkend="gboolean">gboolean</link>            arg5,
                                                        <link linkend="gpointer">gpointer</link>            user_data)               : Run Last</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>empathycontactlist</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg2</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg3</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg4</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg5</parameter>&nbsp;:</term>
<listitem><simpara>

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="EmpathyContactList-pendings-changed"><title>The <literal>&quot;pendings-changed&quot;</literal> signal</title>
<indexterm zone="EmpathyContactList-pendings-changed"><primary>EmpathyContactList::pendings-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EmpathyContactList">EmpathyContactList</link> *empathycontactlist,
                                                        <link linkend="EmpathyContact">EmpathyContact</link>     *arg1,
                                                        <link linkend="EmpathyContact">EmpathyContact</link>     *arg2,
                                                        <link linkend="guint">guint</link>               arg3,
                                                        <link linkend="gchar">gchar</link>              *arg4,
                                                        <link linkend="gboolean">gboolean</link>            arg5,
                                                        <link linkend="gpointer">gpointer</link>            user_data)               : Run Last</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>empathycontactlist</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg2</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg3</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg4</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg5</parameter>&nbsp;:</term>
<listitem><simpara>

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>



</refentry>
