Mercurial > pidgin.yaz
annotate src/protocols/msn/user.h @ 5372:fa0217bec87e
[gaim-migrate @ 5748]
The mobile state should now reflect the server under all cases.
committer: Tailor Script <tailor@pidgin.im>
author | Christian Hammond <chipx86@chipx86.com> |
---|---|
date | Wed, 14 May 2003 07:50:26 +0000 |
parents | ebebc833cf77 |
children | 0436e39c70cf |
rev | line source |
---|---|
5309 | 1 /** |
2 * @file user.h User functions | |
3 * | |
4 * gaim | |
5 * | |
6 * Copyright (C) 2003 Christian Hammond <chipx86@gnupdate.org> | |
7 * | |
8 * This program is free software; you can redistribute it and/or modify | |
9 * it under the terms of the GNU General Public License as published by | |
10 * the Free Software Foundation; either version 2 of the License, or | |
11 * (at your option) any later version. | |
12 * | |
13 * This program is distributed in the hope that it will be useful, | |
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 * GNU General Public License for more details. | |
17 * | |
18 * You should have received a copy of the GNU General Public License | |
19 * along with this program; if not, write to the Free Software | |
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
21 */ | |
22 #ifndef _MSN_USER_H_ | |
23 #define _MSN_USER_H_ | |
24 | |
25 typedef struct _MsnUser MsnUser; | |
26 typedef struct _MsnUsers MsnUsers; | |
27 | |
28 #include "session.h" | |
29 | |
30 /** | |
31 * A user. | |
32 */ | |
33 struct _MsnUser | |
34 { | |
5372
fa0217bec87e
[gaim-migrate @ 5748]
Christian Hammond <chipx86@chipx86.com>
parents:
5363
diff
changeset
|
35 MsnSession *session; /**< The MSN session. */ |
5316
d5690ed70085
[gaim-migrate @ 5688]
Christian Hammond <chipx86@chipx86.com>
parents:
5309
diff
changeset
|
36 |
5372
fa0217bec87e
[gaim-migrate @ 5748]
Christian Hammond <chipx86@chipx86.com>
parents:
5363
diff
changeset
|
37 char *passport; /**< The passport account. */ |
fa0217bec87e
[gaim-migrate @ 5748]
Christian Hammond <chipx86@chipx86.com>
parents:
5363
diff
changeset
|
38 char *name; /**< The friendly name. */ |
5309 | 39 |
5363
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
40 struct |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
41 { |
5372
fa0217bec87e
[gaim-migrate @ 5748]
Christian Hammond <chipx86@chipx86.com>
parents:
5363
diff
changeset
|
42 char *home; /**< Home phone number. */ |
fa0217bec87e
[gaim-migrate @ 5748]
Christian Hammond <chipx86@chipx86.com>
parents:
5363
diff
changeset
|
43 char *work; /**< Work phone number. */ |
fa0217bec87e
[gaim-migrate @ 5748]
Christian Hammond <chipx86@chipx86.com>
parents:
5363
diff
changeset
|
44 char *mobile; /**< Mobile phone number. */ |
5363
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
45 |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
46 } phone; |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
47 |
5372
fa0217bec87e
[gaim-migrate @ 5748]
Christian Hammond <chipx86@chipx86.com>
parents:
5363
diff
changeset
|
48 gboolean allow_pages; /**< Allows mobile messages. */ |
fa0217bec87e
[gaim-migrate @ 5748]
Christian Hammond <chipx86@chipx86.com>
parents:
5363
diff
changeset
|
49 gboolean mobile; /**< Signed up with MSN Mobile. */ |
5309 | 50 |
5372
fa0217bec87e
[gaim-migrate @ 5748]
Christian Hammond <chipx86@chipx86.com>
parents:
5363
diff
changeset
|
51 int group_id; /**< The group ID. */ |
5309 | 52 |
5372
fa0217bec87e
[gaim-migrate @ 5748]
Christian Hammond <chipx86@chipx86.com>
parents:
5363
diff
changeset
|
53 size_t ref_count; /**< The reference count. */ |
fa0217bec87e
[gaim-migrate @ 5748]
Christian Hammond <chipx86@chipx86.com>
parents:
5363
diff
changeset
|
54 |
fa0217bec87e
[gaim-migrate @ 5748]
Christian Hammond <chipx86@chipx86.com>
parents:
5363
diff
changeset
|
55 GHashTable *clientinfo; /**< The client information. */ |
5309 | 56 }; |
57 | |
58 /** | |
59 * A collection of users. | |
60 */ | |
61 struct _MsnUsers | |
62 { | |
63 GList *users; /** The list of users. */ | |
64 }; | |
65 | |
66 /** | |
67 * Creates a new user structure. | |
68 * | |
69 * @param session The MSN session. | |
70 * @param passport The initial passport. | |
71 * @param name The initial friendly name. | |
72 * | |
73 * @return A new user structure. | |
74 */ | |
75 MsnUser *msn_user_new(MsnSession *session, const char *passport, | |
76 const char *name); | |
77 | |
78 /** | |
79 * Destroys a user structure. | |
80 * | |
81 * @param user The user to destroy. | |
82 */ | |
83 void msn_user_destroy(MsnUser *user); | |
84 | |
85 /** | |
86 * Increments the reference count on a user. | |
87 * | |
88 * @param user The user. | |
89 * | |
90 * @return @a user | |
91 */ | |
92 MsnUser *msn_user_ref(MsnUser *user); | |
93 | |
94 /** | |
95 * Decrements the reference count on a user. | |
96 * | |
97 * This will destroy the structure if the count hits 0. | |
98 * | |
99 * @param user The user. | |
100 * | |
101 * @return @a user, or @c NULL if the new count is 0. | |
102 */ | |
103 MsnUser *msn_user_unref(MsnUser *user); | |
104 | |
105 /** | |
106 * Sets the passport account for a user. | |
107 * | |
108 * @param user The user. | |
109 * @param passport The passport account. | |
110 */ | |
111 void msn_user_set_passport(MsnUser *user, const char *passport); | |
112 | |
113 /** | |
114 * Sets the friendly name for a user. | |
115 * | |
116 * @param user The user. | |
117 * @param name The friendly name. | |
118 */ | |
119 void msn_user_set_name(MsnUser *user, const char *name); | |
120 | |
121 /** | |
122 * Sets the group ID for a user. | |
123 * | |
124 * @param user The user. | |
125 * @param id The group ID. | |
126 */ | |
127 void msn_user_set_group_id(MsnUser *user, int id); | |
128 | |
129 /** | |
5363
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
130 * Sets the home phone number for a user. |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
131 * |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
132 * @param user The user. |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
133 * @param number The home phone number. |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
134 */ |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
135 void msn_user_set_home_phone(MsnUser *user, const char *number); |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
136 |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
137 /** |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
138 * Sets the work phone number for a user. |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
139 * |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
140 * @param user The user. |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
141 * @param number The work phone number. |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
142 */ |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
143 void msn_user_set_work_phone(MsnUser *user, const char *number); |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
144 |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
145 /** |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
146 * Sets the mobile phone number for a user. |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
147 * |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
148 * @param user The user. |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
149 * @param number The mobile phone number. |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
150 */ |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
151 void msn_user_set_mobile_phone(MsnUser *user, const char *number); |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
152 |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
153 /** |
5309 | 154 * Returns the passport account for a user. |
155 * | |
156 * @param user The user. | |
157 * | |
158 * @return The passport account. | |
159 */ | |
160 const char *msn_user_get_passport(const MsnUser *user); | |
161 | |
162 /** | |
163 * Returns the friendly name for a user. | |
164 * | |
165 * @param user The user. | |
166 * | |
167 * @return The friendly name. | |
168 */ | |
169 const char *msn_user_get_name(const MsnUser *user); | |
170 | |
171 /** | |
172 * Returns the group ID for a user. | |
173 * | |
174 * @param user The user. | |
175 * | |
176 * @return The group ID. | |
177 */ | |
178 int msn_user_get_group_id(const MsnUser *user); | |
179 | |
180 /** | |
5363
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
181 * Returns the home phone number for a user. |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
182 * |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
183 * @param user The user. |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
184 * |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
185 * @return The user's home phone number. |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
186 */ |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
187 const char *msn_user_get_home_phone(const MsnUser *user); |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
188 |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
189 /** |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
190 * Returns the work phone number for a user. |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
191 * |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
192 * @param user The user. |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
193 * |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
194 * @return The user's work phone number. |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
195 */ |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
196 const char *msn_user_get_work_phone(const MsnUser *user); |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
197 |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
198 /** |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
199 * Returns the mobile phone number for a user. |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
200 * |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
201 * @param user The user. |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
202 * |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
203 * @return The user's mobile phone number. |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
204 */ |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
205 const char *msn_user_get_mobile_phone(const MsnUser *user); |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
206 |
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5316
diff
changeset
|
207 /** |
5316
d5690ed70085
[gaim-migrate @ 5688]
Christian Hammond <chipx86@chipx86.com>
parents:
5309
diff
changeset
|
208 * Sets the client information for a user. |
d5690ed70085
[gaim-migrate @ 5688]
Christian Hammond <chipx86@chipx86.com>
parents:
5309
diff
changeset
|
209 * |
d5690ed70085
[gaim-migrate @ 5688]
Christian Hammond <chipx86@chipx86.com>
parents:
5309
diff
changeset
|
210 * @param user The user. |
d5690ed70085
[gaim-migrate @ 5688]
Christian Hammond <chipx86@chipx86.com>
parents:
5309
diff
changeset
|
211 * @param info The client information. |
d5690ed70085
[gaim-migrate @ 5688]
Christian Hammond <chipx86@chipx86.com>
parents:
5309
diff
changeset
|
212 */ |
d5690ed70085
[gaim-migrate @ 5688]
Christian Hammond <chipx86@chipx86.com>
parents:
5309
diff
changeset
|
213 void msn_user_set_client_info(MsnUser *user, GHashTable *info); |
d5690ed70085
[gaim-migrate @ 5688]
Christian Hammond <chipx86@chipx86.com>
parents:
5309
diff
changeset
|
214 |
d5690ed70085
[gaim-migrate @ 5688]
Christian Hammond <chipx86@chipx86.com>
parents:
5309
diff
changeset
|
215 /** |
d5690ed70085
[gaim-migrate @ 5688]
Christian Hammond <chipx86@chipx86.com>
parents:
5309
diff
changeset
|
216 * Returns the client information for a user. |
d5690ed70085
[gaim-migrate @ 5688]
Christian Hammond <chipx86@chipx86.com>
parents:
5309
diff
changeset
|
217 * |
d5690ed70085
[gaim-migrate @ 5688]
Christian Hammond <chipx86@chipx86.com>
parents:
5309
diff
changeset
|
218 * @param user The user. |
d5690ed70085
[gaim-migrate @ 5688]
Christian Hammond <chipx86@chipx86.com>
parents:
5309
diff
changeset
|
219 * |
d5690ed70085
[gaim-migrate @ 5688]
Christian Hammond <chipx86@chipx86.com>
parents:
5309
diff
changeset
|
220 * @return The client information. |
d5690ed70085
[gaim-migrate @ 5688]
Christian Hammond <chipx86@chipx86.com>
parents:
5309
diff
changeset
|
221 */ |
d5690ed70085
[gaim-migrate @ 5688]
Christian Hammond <chipx86@chipx86.com>
parents:
5309
diff
changeset
|
222 GHashTable *msn_user_get_client_info(const MsnUser *user); |
d5690ed70085
[gaim-migrate @ 5688]
Christian Hammond <chipx86@chipx86.com>
parents:
5309
diff
changeset
|
223 |
d5690ed70085
[gaim-migrate @ 5688]
Christian Hammond <chipx86@chipx86.com>
parents:
5309
diff
changeset
|
224 /** |
5309 | 225 * Creates a new MsnUsers structure. |
226 * | |
227 * @return A new MsnUsers structure. | |
228 */ | |
229 MsnUsers *msn_users_new(void); | |
230 | |
231 /** | |
232 * Destroys a users list. | |
233 * | |
234 * @param users The users list. | |
235 */ | |
236 void msn_users_destroy(MsnUsers *users); | |
237 | |
238 /** | |
239 * Adds a user to a users list. | |
240 * | |
241 * @param users The users list. | |
242 * @param user The user. | |
243 */ | |
244 void msn_users_add(MsnUsers *users, MsnUser *user); | |
245 | |
246 /** | |
247 * Removes a user from a users list. | |
248 * | |
249 * @param users The users list. | |
250 * @param user The user. | |
251 */ | |
252 void msn_users_remove(MsnUsers *users, MsnUser *user); | |
253 | |
254 /** | |
255 * Finds a user with the specified passport. | |
256 * | |
257 * @param users A list of users. | |
258 * @param passport The passport. | |
259 * | |
260 * @return The user if found, or @c NULL otherwise. | |
261 */ | |
262 MsnUser *msn_users_find_with_passport(MsnUsers *users, const char *passport); | |
263 | |
264 #endif /* _MSN_USER_H_ */ |