pidgin/pidgin
Clone
Summary
Browse
Changes
Graph
Remove doc references to deleted UI ops.
2019-12-19, Elliott Sales de Andrade
474bc477bda8
Remove doc references to deleted UI ops.
<?xml version='1.0' encoding="ISO-8859-1"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
]>
<chapter
id=
"chapter-signals-conversation"
>
<title>
Conversation
signals
</title>
<refsect1
id=
"conversations.signals"
role=
"signal_proto"
>
<title
role=
"signal_proto.title"
>
List
of
signals
</title>
<synopsis>
"
<link
linkend=
"conversations-writing-im-msg"
>
writing-im-msg
</link>
"
"
<link
linkend=
"conversations-wrote-im-msg"
>
wrote-im-msg
</link>
"
"
<link
linkend=
"conversations-sending-im-msg"
>
sending-im-msg
</link>
"
"
<link
linkend=
"conversations-sent-im-msg"
>
sent-im-msg
</link>
"
"
<link
linkend=
"conversations-receiving-im-msg"
>
receiving-im-msg
</link>
"
"
<link
linkend=
"conversations-received-im-msg"
>
received-im-msg
</link>
"
"
<link
linkend=
"conversations-blocked-im-msg"
>
blocked-im-msg
</link>
"
"
<link
linkend=
"conversations-writing-chat-msg"
>
writing-chat-msg
</link>
"
"
<link
linkend=
"conversations-wrote-chat-msg"
>
wrote-chat-msg
</link>
"
"
<link
linkend=
"conversations-sending-chat-msg"
>
sending-chat-msg
</link>
"
"
<link
linkend=
"conversations-sent-chat-msg"
>
sent-chat-msg
</link>
"
"
<link
linkend=
"conversations-receiving-chat-msg"
>
receiving-chat-msg
</link>
"
"
<link
linkend=
"conversations-received-chat-msg"
>
received-chat-msg
</link>
"
"
<link
linkend=
"conversations-conversation-created"
>
conversation-created
</link>
"
"
<link
linkend=
"conversations-conversation-updated"
>
conversation-updated
</link>
"
"
<link
linkend=
"conversations-deleting-conversation"
>
deleting-conversation
</link>
"
"
<link
linkend=
"conversations-buddy-typing"
>
buddy-typing
</link>
"
"
<link
linkend=
"conversations-buddy-typing-stopped"
>
buddy-typing-stopped
</link>
"
"
<link
linkend=
"conversations-chat-user-joining"
>
chat-user-joining
</link>
"
"
<link
linkend=
"conversations-chat-user-joined"
>
chat-user-joined
</link>
"
"
<link
linkend=
"conversations-chat-user-flags"
>
chat-user-flags
</link>
"
"
<link
linkend=
"conversations-chat-user-leaving"
>
chat-user-leaving
</link>
"
"
<link
linkend=
"conversations-chat-user-left"
>
chat-user-left
</link>
"
"
<link
linkend=
"conversations-chat-inviting-user"
>
chat-inviting-user
</link>
"
"
<link
linkend=
"conversations-chat-invited-user"
>
chat-invited-user
</link>
"
"
<link
linkend=
"conversations-chat-invited"
>
chat-invited
</link>
"
"
<link
linkend=
"conversations-chat-invite-blocked"
>
chat-invite-blocked
</link>
"
"
<link
linkend=
"conversations-chat-joined"
>
chat-joined
</link>
"
"
<link
linkend=
"conversations-chat-join-failed"
>
chat-join-failed
</link>
"
"
<link
linkend=
"conversations-chat-left"
>
chat-left
</link>
"
"
<link
linkend=
"conversations-chat-topic-changed"
>
chat-topic-changed
</link>
"
"
<link
linkend=
"conversations-cleared-message-history"
>
cleared-message-history
</link>
"
"
<link
linkend=
"conversations-conversation-extended-menu"
>
conversation-extended-menu
</link>
"
"
<link
linkend=
"conversations-sent-attention"
>
sent-attention
</link>
"
"
<link
linkend=
"conversations-got-attention"
>
got-attention
</link>
"
</synopsis>
</refsect1>
<refsect1
id=
"conversations.signal-details"
role=
"signals"
>
<title
role=
"signals.title"
>
Signal
details
</title>
<refsect2
id=
"conversations-writing-im-msg"
role=
"signal"
>
<title>
The
<literal>
"
writing-im-msg
"
</literal>
signal
</title>
<programlisting>
gboolean
user_function
(PurpleAccount
*account,
const
char
*who,
char
**message,
PurpleIMConversation
*im,
PurpleMessageFlags
flags,
gpointer
user_data)
</programlisting>
<para>
Emitted
before
a
message
is
written
in
an
IM
conversation.
If
the
message
is
changed,
then
the
changed
message
is
displayed
and
logged
instead
of
the
original
message.
</para>
<note><para>
Make
sure
to
free
<literal>
*message
</literal>
before
you
replace
it!
</para></note>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
account
</parameter>
 
:
</term>
<listitem><simpara>
The
account.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
who
</parameter>
 
:
</term>
<listitem><simpara>
The
name
of
the
user.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
message
</parameter>
 
:
</term>
<listitem><simpara>
A
pointer
to
the
message.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
im
</parameter>
 
:
</term>
<listitem><simpara>
The
IM
conversation.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
flags
</parameter>
 
:
</term>
<listitem><simpara>
Flags
for
this
message.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>
Returns
</emphasis>
 
:
</term>
<listitem><simpara><literal>
TRUE
</literal>
if
the
message
should
be
canceled,
or
<literal>
FALSE
</literal>
otherwise.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-wrote-im-msg"
role=
"signal"
>
<title>
The
<literal>
"
wrote-im-msg
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleAccount
*account,
const
char
*who,
char
*message,
PurpleIMConversation
*im,
PurpleMessageFlags
flags,
gpointer
user_data)
</programlisting>
<para>
Emitted
after
a
message
is
written
and
possibly
displayed
in
a
conversation.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
account
</parameter>
 
:
</term>
<listitem><simpara>
The
account.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
who
</parameter>
 
:
</term>
<listitem><simpara>
The
name
of
the
user.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
message
</parameter>
 
:
</term>
<listitem><simpara>
The
message.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
im
</parameter>
 
:
</term>
<listitem><simpara>
The
IM
conversation.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
flags
</parameter>
 
:
</term>
<listitem><simpara>
Flags
for
this
message.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-sending-im-msg"
role=
"signal"
>
<title>
The
<literal>
"
sending-im-msg
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleAccount
*account,
const
char
*receiver,
char
**message,
gpointer
user_data)
</programlisting>
<para>
Emitted
before
sending
an
IM
to
a
user.
<literal>
message
</literal>
is
a
pointer
to
the
message
string,
so
the
plugin
can
replace
the
message
before
being
sent.
</para>
<note><para>
Make
sure
to
free
<literal>
*message
</literal>
before
you
replace
it!
</para></note>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
account
</parameter>
 
:
</term>
<listitem><simpara>
The
account
the
message
is
being
sent
on.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
receiver
</parameter>
 
:
</term>
<listitem><simpara>
The
username
of
the
receiver.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
message
</parameter>
 
:
</term>
<listitem><simpara>
A
pointer
to
the
outgoing
message.
This
can
be
modified.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-sent-im-msg"
role=
"signal"
>
<title>
The
<literal>
"
sent-im-msg
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleAccount
*account,
const
char
*receiver,
const
char
*message,
gpointer
user_data)
</programlisting>
<para>
Emitted
after
sending
an
IM
to
a
user.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
account
</parameter>
 
:
</term>
<listitem><simpara>
The
account
the
message
was
sent
on.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
receiver
</parameter>
 
:
</term>
<listitem><simpara>
The
username
of
the
receiver.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
message
</parameter>
 
:
</term>
<listitem><simpara>
The
message
that
was
sent.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-receiving-im-msg"
role=
"signal"
>
<title>
The
<literal>
"
receiving-im-msg
"
</literal>
signal
</title>
<programlisting>
gboolean
user_function
(PurpleAccount
*account,
char
**sender,
char
**message,
PurpleIMConversation
*im,
PurpleMessageFlags
*flags,
gpointer
user_data)
</programlisting>
<para>
Emitted
when
an
IM
is
received.
The
callback
can
replace
the
name
of
the
sender,
the
message,
or
the
flags
by
modifying
the
pointer
to
the
strings
and
integer.
This
can
also
be
used
to
cancel
a
message
by
returning
<literal>
TRUE
</literal>
.
</para>
<note><para>
Make
sure
to
free
<literal>
*sender
</literal>
and
<literal>
*message
</literal>
before
you
replace
them!
</para></note>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
account
</parameter>
 
:
</term>
<listitem><simpara>
The
account
the
message
was
received
on.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
sender
</parameter>
 
:
</term>
<listitem><simpara>
A
pointer
to
the
username
of
the
sender.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
message
</parameter>
 
:
</term>
<listitem><simpara>
A
pointer
to
the
message
that
was
sent.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
im
</parameter>
 
:
</term>
<listitem><simpara>
The
IM
conversation.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
flags
</parameter>
 
:
</term>
<listitem><simpara>
A
pointer
to
the
IM
message
flags.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>
Returns
</emphasis>
 
:
</term>
<listitem><simpara><literal>
TRUE
</literal>
if
the
message
should
be
canceled,
or
<literal>
FALSE
</literal>
otherwise.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-received-im-msg"
role=
"signal"
>
<title>
The
<literal>
"
received-im-msg
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleAccount
*account,
char
*sender,
char
*message,
PurpleIMConversation
*im,
PurpleMessageFlags
flags,
gpointer
user_data)
</programlisting>
<para>
Emitted
after
an
IM
is
received.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
account
</parameter>
 
:
</term>
<listitem><simpara>
The
account
the
message
was
received
on.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
sender
</parameter>
 
:
</term>
<listitem><simpara>
The
username
of
the
sender.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
message
</parameter>
 
:
</term>
<listitem><simpara>
The
message
that
was
sent.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
im
</parameter>
 
:
</term>
<listitem><simpara>
The
IM
conversation.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
flags
</parameter>
 
:
</term>
<listitem><simpara>
The
IM
message
flags.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-blocked-im-msg"
role=
"signal"
>
<title>
The
<literal>
"
blocked-im-msg
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleAccount
*account,
const
char
*sender,
const
char
*message,
PurpleMessageFlags
flags,
time_t
when,
gpointer
user_data)
</programlisting>
<para>
Emitted
after
an
IM
is
blocked
due
to
privacy
settings.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
account
</parameter>
 
:
</term>
<listitem><simpara>
The
account
the
message
was
received
on.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
sender
</parameter>
 
:
</term>
<listitem><simpara>
The
username
of
the
sender.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
message
</parameter>
 
:
</term>
<listitem><simpara>
The
message
that
was
blocked.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
flags
</parameter>
 
:
</term>
<listitem><simpara>
The
IM
message
flags.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
when
</parameter>
 
:
</term>
<listitem><simpara>
The
time
the
message
was
sent.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-writing-chat-msg"
role=
"signal"
>
<title>
The
<literal>
"
writing-chat-msg
"
</literal>
signal
</title>
<programlisting>
gboolean
user_function
(PurpleAccount
*account,
const
char
*who,
char
**message,
PurpleChatConversation
*chat,
PurpleMessageFlags
flags,
gpointer
user_data)
</programlisting>
<para>
Emitted
before
a
message
is
written
in
a
chat
conversation.
If
the
message
is
changed,
then
the
changed
message
is
displayed
and
logged
instead
of
the
original
message.
</para>
<note><para>
Make
sure
to
free
<literal>
*message
</literal>
before
you
replace
it!
</para></note>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
account
</parameter>
 
:
</term>
<listitem><simpara>
The
account.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
who
</parameter>
 
:
</term>
<listitem><simpara>
The
name
of
the
user.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
message
</parameter>
 
:
</term>
<listitem><simpara>
A
pointer
to
the
message.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
chat
</parameter>
 
:
</term>
<listitem><simpara>
The
chat
conversation.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
flags
</parameter>
 
:
</term>
<listitem><simpara>
Flags
for
this
message.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>
Returns
</emphasis>
 
:
</term>
<listitem><simpara><literal>
TRUE
</literal>
if
the
message
should
be
canceled,
or
<literal>
FALSE
</literal>
otherwise.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-wrote-chat-msg"
role=
"signal"
>
<title>
The
<literal>
"
wrote-chat-msg
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleAccount
*account,
const
char
*who,
char
*message,
PurpleChatConversation
*chat,
PurpleMessageFlags
flags,
gpointer
user_data)
</programlisting>
<para>
Emitted
after
a
message
is
written
and
possibly
displayed
in
a
chat.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
account
</parameter>
 
:
</term>
<listitem><simpara>
The
account.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
who
</parameter>
 
:
</term>
<listitem><simpara>
The
name
of
the
user.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
message
</parameter>
 
:
</term>
<listitem><simpara>
The
message.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
chat
</parameter>
 
:
</term>
<listitem><simpara>
The
chat
conversation.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
flags
</parameter>
 
:
</term>
<listitem><simpara>
Flags
for
this
message.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-sending-chat-msg"
role=
"signal"
>
<title>
The
<literal>
"
sending-chat-msg
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleAccount
*account,
char
**message,
int
id,
gpointer
user_data)
</programlisting>
<para>
Emitted
before
sending
a
message
to
a
chat.
<literal>
message
</literal>
is
a
pointer
to
the
message
string,
so
the
plugin
can
replace
the
message
before
being
sent.
</para>
<note><para>
Make
sure
to
free
<literal>
*message
</literal>
before
you
replace
it!
</para></note>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
account
</parameter>
 
:
</term>
<listitem><simpara>
The
account
the
message
is
being
sent
on.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
message
</parameter>
 
:
</term>
<listitem><simpara>
A
pointer
to
the
message
that
will
be
sent.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
id
</parameter>
 
:
</term>
<listitem><simpara>
The
ID
of
the
chat.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-sent-chat-msg"
role=
"signal"
>
<title>
The
<literal>
"
sent-chat-msg
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleAccount
*account,
const
char
*message,
int
id,
gpointer
user_data)
</programlisting>
<para>
Emitted
after
sending
a
message
to
a
chat.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
account
</parameter>
 
:
</term>
<listitem><simpara>
The
account
the
message
was
sent
on.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
message
</parameter>
 
:
</term>
<listitem><simpara>
The
message
that
was
sent.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
id
</parameter>
 
:
</term>
<listitem><simpara>
The
ID
of
the
chat.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-receiving-chat-msg"
role=
"signal"
>
<title>
The
<literal>
"
receiving-chat-msg
"
</literal>
signal
</title>
<programlisting>
gboolean
user_function
(PurpleAccount
*account,
char
**sender,
char
**message,
PurpleChatConversation
*chat,
int
*flags,
gpointer
user_data)
</programlisting>
<para>
Emitted
when
a
chat
message
is
received.
The
callback
can
replace
the
name
of
the
sender,
the
message,
or
the
flags
by
modifying
the
pointer
to
the
strings.
This
can
also
be
used
to
cancel
displaying
a
message
by
returning
<literal>
TRUE
</literal>
.
</para>
<note><para>
Make
sure
to
free
<literal>
*sender
</literal>
and
<literal>
*message
</literal>
before
you
replace
them!
</para></note>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
account
</parameter>
 
:
</term>
<listitem><simpara>
The
account
the
message
was
received
on.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
sender
</parameter>
 
:
</term>
<listitem><simpara>
A
pointer
to
the
username
of
the
sender.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
message
</parameter>
 
:
</term>
<listitem><simpara>
A
pointer
to
the
message
that
was
sent.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
chat
</parameter>
 
:
</term>
<listitem><simpara>
The
chat
conversation.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
flags
</parameter>
 
:
</term>
<listitem><simpara>
A
pointer
to
the
chat
message
flags.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>
Returns
</emphasis>
 
:
</term>
<listitem><simpara><literal>
TRUE
</literal>
if
the
message
should
be
canceled,
or
<literal>
FALSE
</literal>
otherwise.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-received-chat-msg"
role=
"signal"
>
<title>
The
<literal>
"
received-chat-msg
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleAccount
*account,
char
*sender,
char
*message,
PurpleChatConversation
*chat,
PurpleMessageFlags
flags,
gpointer
user_data)
</programlisting>
<para>
Emitted
after
a
chat
message
is
received.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
account
</parameter>
 
:
</term>
<listitem><simpara>
The
account
the
message
was
received
on.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
sender
</parameter>
 
:
</term>
<listitem><simpara>
The
username
of
the
sender.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
message
</parameter>
 
:
</term>
<listitem><simpara>
The
message
that
was
sent.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
chat
</parameter>
 
:
</term>
<listitem><simpara>
The
chat
conversation.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
flags
</parameter>
 
:
</term>
<listitem><simpara>
The
chat
message
flags.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-conversation-created"
role=
"signal"
>
<title>
The
<literal>
"
conversation-created
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleConversation
*conv,
gpointer
user_data)
</programlisting>
<para>
Emitted
when
a
new
conversation
is
created.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
conv
</parameter>
 
:
</term>
<listitem><simpara>
The
new
conversation.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-conversation-updated"
role=
"signal"
>
<title>
The
<literal>
"
conversation-updated
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleConversation
*conv,
PurpleConvUpdateType
type,
gpointer
user_data)
</programlisting>
<para>
Emitted
when
a
conversation
is
updated.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
conv
</parameter>
 
:
</term>
<listitem><simpara>
The
conversation
that
was
updated.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
type
</parameter>
 
:
</term>
<listitem><simpara>
The
type
of
update
that
was
made.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-deleting-conversation"
role=
"signal"
>
<title>
The
<literal>
"
deleting-conversation
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleConversation
*conv,
gpointer
user_data)
</programlisting>
<para>
Emitted
just
before
a
conversation
is
to
be
destroyed.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
conv
</parameter>
 
:
</term>
<listitem><simpara>
The
conversation
that's
about
to
be
destroyed.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-buddy-typing"
role=
"signal"
>
<title>
The
<literal>
"
buddy-typing
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleAccount
*account,
const
char
*name,
gpointer
user_data)
</programlisting>
<para>
Emitted
when
a
buddy
starts
typing
in
a
conversation
window.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
account
</parameter>
 
:
</term>
<listitem><simpara>
The
account
of
the
user
which
is
typing.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
name
</parameter>
 
:
</term>
<listitem><simpara>
The
name
of
the
user
which
is
typing.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-buddy-typing-stopped"
role=
"signal"
>
<title>
The
<literal>
"
buddy-typing-stopped
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleAccount
*account,
const
char
*name,
gpointer
user_data)
</programlisting>
<para>
Emitted
when
a
buddy
stops
typing
in
a
conversation
window.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
account
</parameter>
 
:
</term>
<listitem><simpara>
The
account
of
the
user
which
stopped
typing.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
name
</parameter>
 
:
</term>
<listitem><simpara>
The
name
of
the
user
which
stopped
typing.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-chat-user-joining"
role=
"signal"
>
<title>
The
<literal>
"
chat-user-joining
"
</literal>
signal
</title>
<programlisting>
gboolean
user_function
(PurpleChatConversation
*chat,
const
char
*name,
PurpleChatUserFlags
flags,
gpointer
user_data)
</programlisting>
<para>
Emitted
when
a
buddy
is
joining
a
chat,
before
the
list
of
users
in
the
chat
updates
to
include
the
new
user.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
chat
</parameter>
 
:
</term>
<listitem><simpara>
The
chat
conversation.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
name
</parameter>
 
:
</term>
<listitem><simpara>
The
name
of
the
user
that
is
joining
the
conversation.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
flags
</parameter>
 
:
</term>
<listitem><simpara>
The
flags
of
the
user
that
is
joining
the
conversation.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>
Returns
</emphasis>
 
:
</term>
<listitem><simpara><literal>
TRUE
</literal>
if
the
join
should
be
hidden,
or
<literal>
FALSE
</literal>
otherwise.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-chat-user-joined"
role=
"signal"
>
<title>
The
<literal>
"
chat-user-joined
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleChatConversation
*chat,
const
char
*name,
PurpleChatUserFlags
flags,
gboolean
new_arrival,
gpointer
user_data)
</programlisting>
<para>
Emitted
when
a
buddy
joined
a
chat,
after
the
users
list
is
updated.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
chat
</parameter>
 
:
</term>
<listitem><simpara>
The
chat
conversation.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
name
</parameter>
 
:
</term>
<listitem><simpara>
The
name
of
the
user
that
has
joined
the
conversation.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
flags
</parameter>
 
:
</term>
<listitem><simpara>
The
flags
of
the
user
that
has
joined
the
conversation.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
new_arrival
</parameter>
 
:
</term>
<listitem><simpara>
If
the
buddy
is
a
new
arrival.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-chat-join-failed"
role=
"signal"
>
<title>
The
<literal>
"
chat-join-failed
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleConnection
*gc,
GHashTable
*components,
gpointer
user_data)
</programlisting>
<para>
Emitted
when
an
account
fails
to
join
a
chat
room.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
gc
</parameter>
 
:
</term>
<listitem><simpara>
The
PurpleConnection
of
the
account
which
failed
to
join
the
chat.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
data
</parameter>
 
:
</term>
<listitem><simpara>
The
components
passed
to
purple_serv_join_chat()
originally.
The
hash
function
should
be
g_str_hash()
and
the
equal
function
should
be
g_str_equal().
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-chat-user-flags"
role=
"signal"
>
<title>
The
<literal>
"
chat-user-flags
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleChatUser
*chatuser,
PurpleChatUserFlags
oldflags,
PurpleChatUserFlags
newflags,
gpointer
user_data)
</programlisting>
<para>
Emitted
when
a
user
in
a
chat
changes
flags.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
chatuser
</parameter>
 
:
</term>
<listitem><simpara>
The
chat
user
whose
flags
changed.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
oldflags
</parameter>
 
:
</term>
<listitem><simpara>
The
old
flags.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
newflags
</parameter>
 
:
</term>
<listitem><simpara>
The
new
flags.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-chat-user-leaving"
role=
"signal"
>
<title>
The
<literal>
"
chat-user-leaving
"
</literal>
signal
</title>
<programlisting>
gboolean
user_function
(PurpleChatConversation
*chat,
const
char
*name,
const
char
*reason,
gpointer
user_data)
</programlisting>
<para>
Emitted
when
a
user
is
leaving
a
chat,
before
the
user
list
is
updated.
This
may
include
an
optional
reason
why
the
user
is
leaving.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
chat
</parameter>
 
:
</term>
<listitem><simpara>
The
chat
conversation.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
name
</parameter>
 
:
</term>
<listitem><simpara>
The
name
of
the
user
that
is
leaving
the
chat.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
reason
</parameter>
 
:
</term>
<listitem><simpara>
The
optional
reason
why
the
user
is
leaving.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>
Returns
</emphasis>
 
:
</term>
<listitem><simpara><literal>
TRUE
</literal>
if
the
leave
should
be
hidden,
or
<literal>
FALSE
</literal>
otherwise.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-chat-user-left"
role=
"signal"
>
<title>
The
<literal>
"
chat-user-left
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleChatConversation
*chat,
const
char
*name,
const
char
*reason,
gpointer
user_data)
</programlisting>
<para>
Emitted
when
a
user
leaves
a
chat,
after
the
user
list
is
updated.
This
may
include
an
optional
reason
why
the
user
is
leaving.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
chat
</parameter>
 
:
</term>
<listitem><simpara>
The
chat
conversation.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
name
</parameter>
 
:
</term>
<listitem><simpara>
The
name
of
the
user
that
left
the
chat.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
reason
</parameter>
 
:
</term>
<listitem><simpara>
The
optional
reason
why
the
user
left
the
chat.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-chat-inviting-user"
role=
"signal"
>
<title>
The
<literal>
"
chat-inviting-user
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleChatConversation
*chat,
const
char
*name,
char
**invite_message,
gpointer
user_data)
</programlisting>
<para>
Emitted
when
a
user
is
being
invited
to
the
chat.
The
callback
can
replace
the
invite
message
to
the
invitee
by
modifying
the
pointer
to
the
invite
message.
</para>
<note><para>
Make
sure
to
free
<literal>
*invite_message
</literal>
before
you
replace
it!
</para></note>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
chat
</parameter>
 
:
</term>
<listitem><simpara>
The
chat
conversation.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
name
</parameter>
 
:
</term>
<listitem><simpara>
The
name
of
the
user
being
invited.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
invite_message
</parameter>
 
:
</term>
<listitem><simpara>
A
pointer
to
the
reason
why
a
user
is
being
invited.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-chat-invited-user"
role=
"signal"
>
<title>
The
<literal>
"
chat-invited-user
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleChatConversation
*conv,
const
char
*name,
const
char
*invite_message,
gpointer
user_data)
</programlisting>
<para>
Emitted
when
a
user
invited
another
user
to
a
chat.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
chat
</parameter>
 
:
</term>
<listitem><simpara>
The
chat
conversation.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
name
</parameter>
 
:
</term>
<listitem><simpara>
The
name
of
the
user
that
was
invited.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
invite_message
</parameter>
 
:
</term>
<listitem><simpara>
The
message
to
be
sent
to
the
user
when
invited.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-chat-invited"
role=
"signal"
>
<title>
The
<literal>
"
chat-invited
"
</literal>
signal
</title>
<programlisting>
gint
user_function
(PurpleAccount
*account,
const
char
*inviter,
const
char
*chat,
const
char
*invite_messageconst
GHashTable
*components,
gpointer
user_data)
</programlisting>
<para>
Emitted
when
an
account
was
invited
to
a
chat.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
account
</parameter>
 
:
</term>
<listitem><simpara>
The
account
being
invited.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
inviter
</parameter>
 
:
</term>
<listitem><simpara>
The
username
of
the
person
inviting
the
account.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
chat
</parameter>
 
:
</term>
<listitem><simpara>
The
name
of
the
chat
you're
being
invited
to.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
invite_message
</parameter>
 
:
</term>
<listitem><simpara>
The
optional
invite
message.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
components
</parameter>
 
:
</term>
<listitem><simpara>
The
components
necessary
if
you
want
to
call
purple_serv_join_chat().
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>
Returns
</emphasis>
 
:
</term>
<listitem><simpara>
Less
than
zero
if
the
invitation
should
be
rejected,
greater
than
zero
if
the
invitation
should
be
accepted.
If
zero
is
returned,
the
default
behavior
will
be
maintained:
the
user
will
be
prompted.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-chat-invite-blocked"
role=
"signal"
>
<title>
The
<literal>
"
chat-invite-blocked
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleAccount
*account,
const
char
*inviter,
const
char
*name,
const
char
*message,
GHashTable
*data)
</programlisting>
<para>
Emitted
when
an
invitation
to
join
a
chat
is
blocked.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
account
</parameter>
 
:
</term>
<listitem><simpara>
The
account
the
invitation
was
sent
to.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
inviter
</parameter>
 
:
</term>
<listitem><simpara>
The
name
of
the
person
sending
the
invitation.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
name
</parameter>
 
:
</term>
<listitem><simpara>
The
name
of
the
chat
invited
to.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
message
</parameter>
 
:
</term>
<listitem><simpara>
The
invitation
message
sent.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
data
</parameter>
 
:
</term>
<listitem><simpara>
Hashtable
containing
data
about
the
invited
chat.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-chat-joined"
role=
"signal"
>
<title>
The
<literal>
"
chat-joined
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleChatConversation
*chat,
gpointer
user_data)
</programlisting>
<para>
Emitted
when
an
account
joins
a
chat
room.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
chat
</parameter>
 
:
</term>
<listitem><simpara>
The
conversation
that
joined
the
chat
room.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-chat-left"
role=
"signal"
>
<title>
The
<literal>
"
chat-left
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleChatConversation
*chat,
gpointer
user_data)
</programlisting>
<para>
Emitted
when
an
account
leaves
a
chat
room.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
chat
</parameter>
 
:
</term>
<listitem><simpara>
The
conversation
that
left
the
chat
room.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-chat-topic-changed"
role=
"signal"
>
<title>
The
<literal>
"
chat-topic-changed
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleChatConversation
*chat,
const
char
*who,
const
char
*topic,
gpointer
user_data)
</programlisting>
<para>
Emitted
when
the
topic
is
changed
in
a
chat.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
chat
</parameter>
 
:
</term>
<listitem><simpara>
The
chat
conversation
whose
topic
changed.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
who
</parameter>
 
:
</term>
<listitem><simpara>
The
name
of
the
person
that
changed
the
topic.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
topic
</parameter>
 
:
</term>
<listitem><simpara>
The
new
topic.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-conversation-extended-menu"
role=
"signal"
>
<title>
The
<literal>
"
conversation-extended-menu
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleConversation
*conv,
GList
**list,
gpointer
user_data)
</programlisting>
<para>
Emitted
when
the
UI
requests
a
list
of
plugin
actions
for
a
conversation.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
conv
</parameter>
 
:
</term>
<listitem><simpara>
The
conversation.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
list
</parameter>
 
:
</term>
<listitem><simpara>
A
pointer
to
the
list
of
actions.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-cleared-message-history"
role=
"signal"
>
<title>
The
<literal>
"
cleared-message-history
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleConversation
*conv,
gpointer
user_data)
</programlisting>
<para>
Emitted
when
the
conversation
history
is
cleared.
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
conv
</parameter>
 
:
</term>
<listitem><simpara>
The
conversation.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-sent-attention"
role=
"signal"
>
<title>
The
<literal>
"
sent-attention
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleAccount
*account,
const
char
*who,
PurpleConversation
*conv,
guint
type,
gpointer
user_data)
</programlisting>
<para>
Emitted
when
receiving
an
attention
message
(buzz,
nudge,
etc.).
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
account
</parameter>
 
:
</term>
<listitem><simpara>
The
account.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
who
</parameter>
 
:
</term>
<listitem><simpara>
The
name
of
the
person
receiving
the
attention.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
conv
</parameter>
 
:
</term>
<listitem><simpara>
The
conversation.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
type
</parameter>
 
:
</term>
<listitem><simpara>
The
attention
type
(an
index
starting
at
0).
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2
id=
"conversations-got-attention"
role=
"signal"
>
<title>
The
<literal>
"
got-attention
"
</literal>
signal
</title>
<programlisting>
void
user_function
(PurpleAccount
*account,
const
char
*who,
PurpleConversation
*conv,
guint
type,
gpointer
user_data)
</programlisting>
<para>
Emitted
when
receiving
an
attention
message
(buzz,
nudge,
etc.).
</para>
<variablelist
role=
"params"
>
<varlistentry>
<term><parameter>
account
</parameter>
 
:
</term>
<listitem><simpara>
The
account.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
who
</parameter>
 
:
</term>
<listitem><simpara>
The
name
of
the
person
sending
the
attention.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
conv
</parameter>
 
:
</term>
<listitem><simpara>
The
conversation.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
type
</parameter>
 
:
</term>
<listitem><simpara>
The
attention
type
(an
index
starting
at
0).
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>
user_data
</parameter>
 
:
</term>
<listitem><simpara>
user
data
set
when
the
signal
handler
was
connected.
</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
</chapter>