source: protocols/yahoo/yahoo2.h @ 12fe5ea

Last change on this file since 12fe5ea was 6f10697, checked in by dequis <dx@…>, at 2015-01-16T19:50:23Z

Fix incorrect Free Software Foundation address

  • Property mode set to 100644
File size: 9.2 KB
Line 
1/*
2 * libyahoo2: yahoo2.h
3 *
4 * Copyright (C) 2002-2004, Philip S Tellis <philip.tellis AT gmx.net>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
19 *
20 */
21
22#ifndef YAHOO2_H
23#define YAHOO2_H
24
25#ifdef __cplusplus
26extern "C" {
27#endif
28
29/* *** BitlBee: *** */
30#include "bitlbee.h"
31#undef free
32#define free( x )               g_free( x )
33#undef malloc
34#define malloc( x )             g_malloc( x )
35#undef calloc
36#define calloc( x, y )          g_calloc( x, y )
37#undef realloc
38#define realloc( x, y )         g_realloc( x, y )
39#undef strdup
40#define strdup( x )             g_strdup( x )
41#undef strndup
42#define strndup( x,y )          g_strndup( x,y )
43#undef snprintf
44// #define snprintf( x... )     g_snprintf( x )
45#undef strcasecmp
46#define strcasecmp( x,y )       g_strcasecmp( x,y )
47#undef strncasecmp
48#define strncasecmp( x,y,z )    g_strncasecmp( x,y,z )
49
50
51#include "yahoo2_types.h"
52
53/* returns the socket descriptor object for a given pager connection. shouldn't be needed */
54        void *yahoo_get_fd(int id);
55
56/* says how much logging to do */
57/* see yahoo2_types.h for the different values */
58        int yahoo_set_log_level(enum yahoo_log_level level);
59        enum yahoo_log_level yahoo_get_log_level(void);
60
61/* these functions should be self explanatory */
62/* who always means the buddy you're acting on */
63/* id is the successful value returned by yahoo_init */
64
65/* init returns a connection id used to identify the connection hereon */
66/* or 0 on failure */
67/* you must call init before calling any other function */
68/*
69 * The optional parameters to init are key/value pairs that specify
70 * server settings to use.  This list must be NULL terminated - even
71 * if the list is empty.  If a parameter isn't set, a default value
72 * will be used.  Parameter keys are strings, parameter values are
73 * either strings or ints, depending on the key.  Values passed in
74 * are copied, so you can use const/auto/static/pointers/whatever
75 * you want.  Parameters are:
76 *      NAME                    TYPE            DEFAULT
77 *      pager_host              char *          scs.msg.yahoo.com
78 *      pager_port              int             5050
79 *      filetransfer_host       char *          filetransfer.msg.yahoo.com
80 *      filetransfer_port       int             80
81 *      webcam_host             char *          webcam.yahoo.com
82 *      webcam_port             int             5100
83 *      webcam_description      char *          ""
84 *      local_host              char *          ""
85 *      conn_type               int             Y_WCM_DSL
86 *
87 * You should set at least local_host if you intend to use webcams
88 */
89        int yahoo_init_with_attributes(const char *username,
90                const char *password, ...);
91
92/* yahoo_init does the same as yahoo_init_with_attributes, assuming defaults
93 * for all attributes */
94        int yahoo_init(const char *username, const char *password);
95
96/* release all resources held by this session */
97/* you need to call yahoo_close for a session only if
98 * yahoo_logoff is never called for it (ie, it was never logged in) */
99        void yahoo_close(int id);
100/* login logs in to the server */
101/* initial is of type enum yahoo_status.  see yahoo2_types.h */
102        void yahoo_login(int id, int initial);
103        void yahoo_logoff(int id);
104/* reloads status of all buddies */
105        void yahoo_refresh(int id);
106/* activates/deactivates an identity */
107        void yahoo_set_identity_status(int id, const char *identity,
108                int active);
109/* regets the entire buddy list from the server */
110        void yahoo_get_list(int id);
111/* download buddy contact information from your yahoo addressbook */
112        void yahoo_get_yab(int id);
113/* add/modify an address book entry.  if yab->dbid is set, it will */
114/* modify that entry else it creates a new entry */
115        void yahoo_set_yab(int id, struct yab *yab);
116        void yahoo_keepalive(int id);
117        void yahoo_chat_keepalive(int id);
118
119/* from is the identity you're sending from.  if NULL, the default is used */
120/* utf8 is whether msg is a utf8 string or not. */
121        void yahoo_send_im(int id, const char *from, const char *who,
122                const char *msg, int utf8, int picture);
123//      void yahoo_send_buzz(int id, const char *from, const char *who);
124/* if type is true, send typing notice, else send stopped typing notice */
125        void yahoo_send_typing(int id, const char *from, const char *who,
126                int typ);
127
128/* used to set away/back status. */
129/* away says whether the custom message is an away message or a sig */
130        void yahoo_set_away(int id, enum yahoo_status state, const char *msg,
131                int away);
132
133        void yahoo_add_buddy(int id, const char *who, const char *group,
134                const char *msg);
135        void yahoo_remove_buddy(int id, const char *who, const char *group);
136        void yahoo_confirm_buddy(int id, const char *who, int reject,
137                const char *msg);
138        void yahoo_stealth_buddy(int id, const char *who, int unstealth);
139/* if unignore is true, unignore, else ignore */
140        void yahoo_ignore_buddy(int id, const char *who, int unignore);
141        void yahoo_change_buddy_group(int id, const char *who,
142                const char *old_group, const char *new_group);
143        void yahoo_group_rename(int id, const char *old_group,
144                const char *new_group);
145
146        void yahoo_conference_invite(int id, const char *from, YList *who,
147                const char *room, const char *msg);
148        void yahoo_conference_addinvite(int id, const char *from,
149                const char *who, const char *room, const YList *members,
150                const char *msg);
151        void yahoo_conference_decline(int id, const char *from, YList *who,
152                const char *room, const char *msg);
153        void yahoo_conference_message(int id, const char *from, YList *who,
154                const char *room, const char *msg, int utf8);
155        void yahoo_conference_logon(int id, const char *from, YList *who,
156                const char *room);
157        void yahoo_conference_logoff(int id, const char *from, YList *who,
158                const char *room);
159
160/* Get a list of chatrooms */
161        void yahoo_get_chatrooms(int id, int chatroomid);
162/* join room with specified roomname and roomid */
163        void yahoo_chat_logon(int id, const char *from, const char *room,
164                const char *roomid);
165/* Send message "msg" to room with specified roomname, msgtype is 1-normal message or 2-/me mesage */
166        void yahoo_chat_message(int id, const char *from, const char *room,
167                const char *msg, const int msgtype, const int utf8);
168/* Log off chat */
169        void yahoo_chat_logoff(int id, const char *from);
170
171/* requests a webcam feed */
172/* who is the person who's webcam you would like to view */
173/* if who is null, then you're the broadcaster */
174        void yahoo_webcam_get_feed(int id, const char *who);
175        void yahoo_webcam_close_feed(int id, const char *who);
176
177/* sends an image when uploading */
178/* image points to a JPEG-2000 image, length is the length of the image */
179/* in bytes. The timestamp is the time in milliseconds since we started the */
180/* webcam. */
181        void yahoo_webcam_send_image(int id, unsigned char *image,
182                unsigned int length, unsigned int timestamp);
183
184/* this function should be called if we want to allow a user to watch the */
185/* webcam. Who is the user we want to accept. */
186/* Accept user (accept = 1), decline user (accept = 0) */
187        void yahoo_webcam_accept_viewer(int id, const char *who, int accept);
188
189/* send an invitation to a user to view your webcam */
190        void yahoo_webcam_invite(int id, const char *who);
191
192/* will set up a connection and initiate file transfer.
193 * callback will be called with the fd that you should write
194 * the file data to
195 */
196        void yahoo_send_file(int id, const char *who, const char *msg,
197                const char *name, unsigned long size,
198                yahoo_get_fd_callback callback, void *data);
199
200/*
201 * Respond to a file transfer request. Be sure to provide the callback data
202 * since that is your only chance to recognize future callbacks
203 */
204        void yahoo_send_file_transfer_response(int client_id, int response,
205                char *id, void *data);
206
207
208/* send a search request
209 */
210        void yahoo_search(int id, enum yahoo_search_type t, const char *text,
211                enum yahoo_search_gender g, enum yahoo_search_agerange ar,
212                int photo, int yahoo_only);
213
214/* continue last search
215 * should be called if only (start+found >= total)
216 *
217 * where the above three are passed to ext_yahoo_got_search_result
218 */
219        void yahoo_search_again(int id, int start);
220
221/* these should be called when input is available on a fd */
222/* registered by ext_yahoo_add_handler */
223/* if these return negative values, errno may be set */
224        int yahoo_read_ready(int id, void *fd, void *data);
225        int yahoo_write_ready(int id, void *fd, void *data);
226
227/* utility functions. these do not hit the server */
228        enum yahoo_status yahoo_current_status(int id);
229        const YList *yahoo_get_buddylist(int id);
230        const YList *yahoo_get_ignorelist(int id);
231        const YList *yahoo_get_identities(int id);
232/* 'which' could be y, t, c or login.  This may change in later versions. */
233        const char *yahoo_get_cookie(int id, const char *which);
234
235/* returns the url used to get user profiles - you must append the user id */
236/* as of now this is http://profiles.yahoo.com/ */
237/* You'll have to do urlencoding yourself, but see yahoo_httplib.h first */
238        const char *yahoo_get_profile_url(void);
239
240        void yahoo_buddyicon_request(int id, const char *who);
241
242#include "yahoo_httplib.h"
243
244#ifdef __cplusplus
245}
246#endif
247#endif
Note: See TracBrowser for help on using the repository browser.