man-pages/man3/Purple.3pm.html
2021-03-31 01:06:50 +01:00

149 lines
3.2 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of Purple</TITLE>
</HEAD><BODY>
<H1>Purple</H1>
Section: User Contributed Perl Documentation (3pm)<BR>Updated: 2020-02-10<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
Purple - Perl extension to the libpurple instant messenger library.
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<PRE>
use Purple;
</PRE>
<A NAME="lbAD">&nbsp;</A>
<H2>ABSTRACT</H2>
<PRE>
This module provides the interface for using perl scripts as plugins
in libpurple.
</PRE>
<A NAME="lbAE">&nbsp;</A>
<H2>DESCRIPTION</H2>
This module provides the interface for using perl scripts as plugins
in Purple. With this, developers can write perl scripts that can be
loaded in Purple as plugins. The scripts can interact with IMs, chats,
accounts, the buddy list, libpurple signals, and more.
<P>
The <FONT SIZE="-1">API</FONT> for the perl interface is very similar to that of the Purple C
<FONT SIZE="-1">API,</FONT> which can be viewed at <A HREF="http://developer.pidgin.im/doxygen/">http://developer.pidgin.im/doxygen/</A> or in
the header files in the Purple source tree.
<A NAME="lbAF">&nbsp;</A>
<H2>FUNCTIONS</H2>
<DL COMPACT>
<DT id="1">@accounts = Purple::accounts<DD>
Returns a list of all accounts, online or offline.
<DT id="2">@chats = Purple::chats<DD>
Returns a list of all chats currently open.
<DT id="3">@connections = Purple::connections<DD>
Returns a list of all active connections.
<DT id="4">@conversations = Purple::conversations<DD>
Returns a list of all conversations, both <FONT SIZE="-1">IM</FONT> and chat, currently open.
<DT id="5">@conv_windows = Purple::conv_windows<DD>
Returns a list of all conversation windows currently open.
<DT id="6">@ims = Purple::ims<DD>
Returns a list of all instant messages currently open.
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>SEE ALSO</H2>
Purple C <FONT SIZE="-1">API</FONT> documentation - <A HREF="http://developer.pidgin.im/doxygen/">http://developer.pidgin.im/doxygen/</A>
<P>
Purple website - <A HREF="http://pidgin.im/">http://pidgin.im/</A>
<A NAME="lbAH">&nbsp;</A>
<H2>AUTHOR</H2>
Christian Hammond, &lt;<A HREF="mailto:chipx86@gnupdate.org">chipx86@gnupdate.org</A>&gt;
<A NAME="lbAI">&nbsp;</A>
<H2>COPYRIGHT AND LICENSE</H2>
Copyright 2003 by Christian Hammond
<P>
This library is free software; you can redistribute it and/or modify
it under the terms of the General Public License (<FONT SIZE="-1">GPL</FONT>). For
more information, see <A HREF="http://www.fsf.org/licenses/gpl.txt">http://www.fsf.org/licenses/gpl.txt</A>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="7"><A HREF="#lbAB">NAME</A><DD>
<DT id="8"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="9"><A HREF="#lbAD">ABSTRACT</A><DD>
<DT id="10"><A HREF="#lbAE">DESCRIPTION</A><DD>
<DT id="11"><A HREF="#lbAF">FUNCTIONS</A><DD>
<DT id="12"><A HREF="#lbAG">SEE ALSO</A><DD>
<DT id="13"><A HREF="#lbAH">AUTHOR</A><DD>
<DT id="14"><A HREF="#lbAI">COPYRIGHT AND LICENSE</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:53 GMT, March 31, 2021
</BODY>
</HTML>