plugins/perl/common/Gaim.pm

changeset 6598
13f98c3c9362
parent 6594
7217bb99c3f5
child 6601
e2993cf5c8a6
equal deleted inserted replaced
6597:c5302002f8c2 6598:13f98c3c9362
63 63
64 use Gaim; 64 use Gaim;
65 65
66 =head1 ABSTRACT 66 =head1 ABSTRACT
67 67
68 This module provides the interface for using perl scripts as plugins 68 This module provides the interface for using perl scripts as plugins
69 in Gaim. 69 in Gaim.
70 70
71 =head1 DESCRIPTION 71 =head1 DESCRIPTION
72 72
73 This module provides the interface for using perl scripts as plugins 73 This module provides the interface for using perl scripts as plugins
74 in Gaim. With this, developers can write perl scripts that can be 74 in Gaim. With this, developers can write perl scripts that can be
76 accounts, the buddy list, gaim signals, and more. 76 accounts, the buddy list, gaim signals, and more.
77 77
78 The API for the perl interface is very similar to that of the Gaim C 78 The API for the perl interface is very similar to that of the Gaim C
79 API, which can be viewed at http://gaim.sourceforge.net/api/ or in 79 API, which can be viewed at http://gaim.sourceforge.net/api/ or in
80 the header files in the Gaim source tree. 80 the header files in the Gaim source tree.
81
82 =head1 FUNCTIONS
83
84 =over
85
86 =item @accounts = Gaim::accounts
87
88 Returns a list of all accounts, online or offline.
89
90 =item @chats = Gaim::chats
91
92 Returns a list of all chats currently open.
93
94 =item @connections = Gaim:connections
95
96 Returns a list of all active connections.
97
98 =item @conversations = Gaim::conversations
99
100 Returns a list of all conversations, both IM and chat, currently open.
101
102 =item @conv_windows = Gaim::conv_windows
103
104 Returns a list of all conversation windows currently open.
105
106 =item @ims = Gaim::ims
107
108 Returns a list of all instant messages currently open.
109
110 =back
81 111
82 =head1 SEE ALSO 112 =head1 SEE ALSO
83 113
84 Gaim C API documentation - http//gaim.sourceforge.net/api/ 114 Gaim C API documentation - http//gaim.sourceforge.net/api/
85 115

mercurial