<?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="EmpathyTpChat">
<refmeta>
<refentrytitle role="top_of_page" id="EmpathyTpChat.top_of_page">EmpathyTpChat</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBEMPATHY Library</refmiscinfo>
</refmeta>

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

<refsynopsisdiv id="EmpathyTpChat.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="EmpathyTpChat-struct">EmpathyTpChat</link>;
<link linkend="EmpathyTpChat">EmpathyTpChat</link>*      <link linkend="empathy-tp-chat-new">empathy_tp_chat_new</link>                 (<link linkend="TpChannel">TpChannel</link> *channel);
const <link linkend="gchar">gchar</link>*        <link linkend="empathy-tp-chat-get-id">empathy_tp_chat_get_id</link>              (<link linkend="EmpathyTpChat">EmpathyTpChat</link> *chat);
<link linkend="EmpathyContact">EmpathyContact</link>*     <link linkend="empathy-tp-chat-get-remote-contact">empathy_tp_chat_get_remote_contact</link>  (<link linkend="EmpathyTpChat">EmpathyTpChat</link> *chat);
<link linkend="McAccount">McAccount</link>*          <link linkend="empathy-tp-chat-get-account">empathy_tp_chat_get_account</link>         (<link linkend="EmpathyTpChat">EmpathyTpChat</link> *chat);
<link linkend="TpChannel">TpChannel</link>*          <link linkend="empathy-tp-chat-get-channel">empathy_tp_chat_get_channel</link>         (<link linkend="EmpathyTpChat">EmpathyTpChat</link> *chat);
<link linkend="gboolean">gboolean</link>            <link linkend="empathy-tp-chat-is-ready">empathy_tp_chat_is_ready</link>            (<link linkend="EmpathyTpChat">EmpathyTpChat</link> *chat);
<link linkend="guint">guint</link>               <link linkend="empathy-tp-chat-get-members-count">empathy_tp_chat_get_members_count</link>   (<link linkend="EmpathyTpChat">EmpathyTpChat</link> *chat);
<link linkend="void">void</link>                <link linkend="empathy-tp-chat-set-acknowledge">empathy_tp_chat_set_acknowledge</link>     (<link linkend="EmpathyTpChat">EmpathyTpChat</link> *chat,
                                                         <link linkend="gboolean">gboolean</link> acknowledge);
<link linkend="void">void</link>                <link linkend="empathy-tp-chat-emit-pendings">empathy_tp_chat_emit_pendings</link>       (<link linkend="EmpathyTpChat">EmpathyTpChat</link> *chat);
<link linkend="void">void</link>                <link linkend="empathy-tp-chat-send">empathy_tp_chat_send</link>                (<link linkend="EmpathyTpChat">EmpathyTpChat</link> *chat,
                                                         <link linkend="EmpathyMessage">EmpathyMessage</link> *message);
<link linkend="void">void</link>                <link linkend="empathy-tp-chat-set-state">empathy_tp_chat_set_state</link>           (<link linkend="EmpathyTpChat">EmpathyTpChat</link> *chat,
                                                         <link linkend="TpChannelChatState">TpChannelChatState</link> state);
<link linkend="void">void</link>                <link linkend="empathy-tp-chat-set-property">empathy_tp_chat_set_property</link>        (<link linkend="EmpathyTpChat">EmpathyTpChat</link> *chat,
                                                         const <link linkend="gchar">gchar</link> *name,
                                                         const <link linkend="GValue">GValue</link> *value);
</synopsis>
</refsynopsisdiv>

<refsect1 id="EmpathyTpChat.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----EmpathyTpChat
</synopsis>

</refsect1>



<refsect1 id="EmpathyTpChat.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
EmpathyTpChat implements
 <link linkend="EmpathyContactList">EmpathyContactList</link>.</para>

</refsect1>


<refsect1 id="EmpathyTpChat.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
  &quot;<link linkend="EmpathyTpChat--acknowledge">acknowledge</link>&quot;              <link linkend="gboolean">gboolean</link>              : Read / Write
  &quot;<link linkend="EmpathyTpChat--channel">channel</link>&quot;                  <link linkend="TpChannel">TpChannel</link>*            : Read / Write / Construct Only
  &quot;<link linkend="EmpathyTpChat--ready">ready</link>&quot;                    <link linkend="gboolean">gboolean</link>              : Read
  &quot;<link linkend="EmpathyTpChat--remote-contact">remote-contact</link>&quot;           <link linkend="EmpathyContact">EmpathyContact</link>*       : Read
</synopsis>
</refsect1>

<refsect1 id="EmpathyTpChat.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
  &quot;<link linkend="EmpathyTpChat-chat-state-changed">chat-state-changed</link>&quot;                             : Run Last
  &quot;<link linkend="EmpathyTpChat-destroy">destroy</link>&quot;                                        : Run Last
  &quot;<link linkend="EmpathyTpChat-message-received">message-received</link>&quot;                               : Run Last
  &quot;<link linkend="EmpathyTpChat-property-changed">property-changed</link>&quot;                               : Run Last
  &quot;<link linkend="EmpathyTpChat-send-error">send-error</link>&quot;                                     : Run Last
</synopsis>
</refsect1>


<refsect1 id="EmpathyTpChat.description" role="desc">
<title role="desc.title">Description</title>
<para>

</para>
</refsect1>

<refsect1 id="EmpathyTpChat.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="EmpathyTpChat-struct" role="struct">
<title>EmpathyTpChat</title>
<indexterm zone="EmpathyTpChat-struct"><primary>EmpathyTpChat</primary></indexterm><programlisting>typedef struct _EmpathyTpChat EmpathyTpChat;</programlisting>
<para>

</para></refsect2>
<refsect2 id="empathy-tp-chat-new" role="function">
<title>empathy_tp_chat_new ()</title>
<indexterm zone="empathy-tp-chat-new"><primary>empathy_tp_chat_new</primary></indexterm><programlisting><link linkend="EmpathyTpChat">EmpathyTpChat</link>*      empathy_tp_chat_new                 (<link linkend="TpChannel">TpChannel</link> *channel);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>channel</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-tp-chat-get-id" role="function">
<title>empathy_tp_chat_get_id ()</title>
<indexterm zone="empathy-tp-chat-get-id"><primary>empathy_tp_chat_get_id</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        empathy_tp_chat_get_id              (<link linkend="EmpathyTpChat">EmpathyTpChat</link> *chat);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>chat</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-tp-chat-get-remote-contact" role="function">
<title>empathy_tp_chat_get_remote_contact ()</title>
<indexterm zone="empathy-tp-chat-get-remote-contact"><primary>empathy_tp_chat_get_remote_contact</primary></indexterm><programlisting><link linkend="EmpathyContact">EmpathyContact</link>*     empathy_tp_chat_get_remote_contact  (<link linkend="EmpathyTpChat">EmpathyTpChat</link> *chat);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>chat</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-tp-chat-get-account" role="function">
<title>empathy_tp_chat_get_account ()</title>
<indexterm zone="empathy-tp-chat-get-account"><primary>empathy_tp_chat_get_account</primary></indexterm><programlisting><link linkend="McAccount">McAccount</link>*          empathy_tp_chat_get_account         (<link linkend="EmpathyTpChat">EmpathyTpChat</link> *chat);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>chat</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-tp-chat-get-channel" role="function">
<title>empathy_tp_chat_get_channel ()</title>
<indexterm zone="empathy-tp-chat-get-channel"><primary>empathy_tp_chat_get_channel</primary></indexterm><programlisting><link linkend="TpChannel">TpChannel</link>*          empathy_tp_chat_get_channel         (<link linkend="EmpathyTpChat">EmpathyTpChat</link> *chat);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>chat</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-tp-chat-is-ready" role="function">
<title>empathy_tp_chat_is_ready ()</title>
<indexterm zone="empathy-tp-chat-is-ready"><primary>empathy_tp_chat_is_ready</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            empathy_tp_chat_is_ready            (<link linkend="EmpathyTpChat">EmpathyTpChat</link> *chat);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>chat</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-tp-chat-get-members-count" role="function">
<title>empathy_tp_chat_get_members_count ()</title>
<indexterm zone="empathy-tp-chat-get-members-count"><primary>empathy_tp_chat_get_members_count</primary></indexterm><programlisting><link linkend="guint">guint</link>               empathy_tp_chat_get_members_count   (<link linkend="EmpathyTpChat">EmpathyTpChat</link> *chat);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>chat</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-tp-chat-set-acknowledge" role="function">
<title>empathy_tp_chat_set_acknowledge ()</title>
<indexterm zone="empathy-tp-chat-set-acknowledge"><primary>empathy_tp_chat_set_acknowledge</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_tp_chat_set_acknowledge     (<link linkend="EmpathyTpChat">EmpathyTpChat</link> *chat,
                                                         <link linkend="gboolean">gboolean</link> acknowledge);</programlisting>
<para>

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


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-tp-chat-emit-pendings" role="function">
<title>empathy_tp_chat_emit_pendings ()</title>
<indexterm zone="empathy-tp-chat-emit-pendings"><primary>empathy_tp_chat_emit_pendings</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_tp_chat_emit_pendings       (<link linkend="EmpathyTpChat">EmpathyTpChat</link> *chat);</programlisting>
<para>

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


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-tp-chat-send" role="function">
<title>empathy_tp_chat_send ()</title>
<indexterm zone="empathy-tp-chat-send"><primary>empathy_tp_chat_send</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_tp_chat_send                (<link linkend="EmpathyTpChat">EmpathyTpChat</link> *chat,
                                                         <link linkend="EmpathyMessage">EmpathyMessage</link> *message);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>chat</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-tp-chat-set-state" role="function">
<title>empathy_tp_chat_set_state ()</title>
<indexterm zone="empathy-tp-chat-set-state"><primary>empathy_tp_chat_set_state</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_tp_chat_set_state           (<link linkend="EmpathyTpChat">EmpathyTpChat</link> *chat,
                                                         <link linkend="TpChannelChatState">TpChannelChatState</link> state);</programlisting>
<para>

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


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-tp-chat-set-property" role="function">
<title>empathy_tp_chat_set_property ()</title>
<indexterm zone="empathy-tp-chat-set-property"><primary>empathy_tp_chat_set_property</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_tp_chat_set_property        (<link linkend="EmpathyTpChat">EmpathyTpChat</link> *chat,
                                                         const <link linkend="gchar">gchar</link> *name,
                                                         const <link linkend="GValue">GValue</link> *value);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>chat</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
<listitem><simpara>


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

</refsect1>
<refsect1 id="EmpathyTpChat.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="EmpathyTpChat--acknowledge"><title>The <literal>&quot;acknowledge&quot;</literal> property</title>
<indexterm zone="EmpathyTpChat--acknowledge"><primary>EmpathyTpChat:acknowledge</primary></indexterm><programlisting>  &quot;acknowledge&quot;              <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
<para>Wheter or not received messages should be acknowledged.</para><para>Default value: FALSE</para>
</refsect2>
<refsect2 id="EmpathyTpChat--channel"><title>The <literal>&quot;channel&quot;</literal> property</title>
<indexterm zone="EmpathyTpChat--channel"><primary>EmpathyTpChat:channel</primary></indexterm><programlisting>  &quot;channel&quot;                  <link linkend="TpChannel">TpChannel</link>*            : Read / Write / Construct Only</programlisting>
<para>The text channel for the chat.</para></refsect2>
<refsect2 id="EmpathyTpChat--ready"><title>The <literal>&quot;ready&quot;</literal> property</title>
<indexterm zone="EmpathyTpChat--ready"><primary>EmpathyTpChat:ready</primary></indexterm><programlisting>  &quot;ready&quot;                    <link linkend="gboolean">gboolean</link>              : Read</programlisting>
<para>This object can't be used until this becomes true.</para><para>Default value: FALSE</para>
</refsect2>
<refsect2 id="EmpathyTpChat--remote-contact"><title>The <literal>&quot;remote-contact&quot;</literal> property</title>
<indexterm zone="EmpathyTpChat--remote-contact"><primary>EmpathyTpChat:remote-contact</primary></indexterm><programlisting>  &quot;remote-contact&quot;           <link linkend="EmpathyContact">EmpathyContact</link>*       : Read</programlisting>
<para>The remote contact if there is no group iface on the channel.</para></refsect2>

</refsect1>

<refsect1 id="EmpathyTpChat.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="EmpathyTpChat-chat-state-changed"><title>The <literal>&quot;chat-state-changed&quot;</literal> signal</title>
<indexterm zone="EmpathyTpChat-chat-state-changed"><primary>EmpathyTpChat::chat-state-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EmpathyTpChat">EmpathyTpChat</link>  *empathytpchat,
                                                        <link linkend="EmpathyContact">EmpathyContact</link> *arg1,
                                                        <link linkend="guint">guint</link>           arg2,
                                                        <link linkend="gpointer">gpointer</link>        user_data)          : Run Last</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>empathytpchat</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>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="EmpathyTpChat-destroy"><title>The <literal>&quot;destroy&quot;</literal> signal</title>
<indexterm zone="EmpathyTpChat-destroy"><primary>EmpathyTpChat::destroy</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EmpathyTpChat">EmpathyTpChat</link> *empathytpchat,
                                                        <link linkend="gpointer">gpointer</link>       user_data)          : Run Last</programlisting>
<para>

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

</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="EmpathyTpChat-message-received"><title>The <literal>&quot;message-received&quot;</literal> signal</title>
<indexterm zone="EmpathyTpChat-message-received"><primary>EmpathyTpChat::message-received</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EmpathyTpChat">EmpathyTpChat</link>  *empathytpchat,
                                                        <link linkend="EmpathyMessage">EmpathyMessage</link> *arg1,
                                                        <link linkend="gpointer">gpointer</link>        user_data)          : Run Last</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>empathytpchat</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>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="EmpathyTpChat-property-changed"><title>The <literal>&quot;property-changed&quot;</literal> signal</title>
<indexterm zone="EmpathyTpChat-property-changed"><primary>EmpathyTpChat::property-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EmpathyTpChat">EmpathyTpChat</link> *empathytpchat,
                                                        <link linkend="gchar">gchar</link>         *arg1,
                                                        <link linkend="GValue">GValue</link>        *arg2,
                                                        <link linkend="gpointer">gpointer</link>       user_data)          : Run Last</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>empathytpchat</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>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="EmpathyTpChat-send-error"><title>The <literal>&quot;send-error&quot;</literal> signal</title>
<indexterm zone="EmpathyTpChat-send-error"><primary>EmpathyTpChat::send-error</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EmpathyTpChat">EmpathyTpChat</link>  *empathytpchat,
                                                        <link linkend="EmpathyMessage">EmpathyMessage</link> *arg1,
                                                        <link linkend="guint">guint</link>           arg2,
                                                        <link linkend="gpointer">gpointer</link>        user_data)          : Run Last</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>empathytpchat</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>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>



</refentry>
