blob: 2556420e9971e78a0034f363f46523254cc4d4cb (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
/** BEGIN COPYRIGHT BLOCK
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301 USA
*
* Copyright (C) 2007 Red Hat, Inc.
* All rights reserved.
* END COPYRIGHT BLOCK **/
#ifndef __PS_BUDDY_SERVICE_H__
#define __PS_BUDDY_SERVICE_H__
#ifdef HAVE_CONFIG_H
#ifndef AUTOTOOLS_CONFIG_H
#define AUTOTOOLS_CONFIG_H
/* Eliminate warnings when using Autotools */
#undef PACKAGE_BUGREPORT
#undef PACKAGE_NAME
#undef PACKAGE_STRING
#undef PACKAGE_TARNAME
#undef PACKAGE_VERSION
#include <config.h>
#endif /* AUTOTOOLS_CONFIG_H */
#endif /* HAVE_CONFIG_H */
/**
* PSBuddyService.h 1.000 05/16/2002
*
* A pure virtual class defining Buddy Service interface
* to be implemented by the various IM presence service providers.
*
* @author Surendra Rajam
* @version 1.000, 05/16/2002
*/
class EXPORT_DECL PSBuddyService {
public:
/**
* Registers a listener with this class. The listener
* is notified of any changes to the buddies being tracked.
*
* @param a buddy service listener
* @return 0 on success
*/
virtual int RegisterListener(PSListener*) = 0;
/**
* An entry point to start the service. This function is responsible
* for authentication with the backend service.
*
* @param config parameters for the service to start
* @return 0 on success
*/
virtual int SignOn(PSConfig*) = 0;
/**
* Shutdown of the service.
*
* @return 0 on success
*/
virtual int SignOff() = 0;
/**
* Sets a user name for online status tracking.
*
* @param user name to be tracked
* @return 0 on success
*/
virtual int WatchBuddy(const char*) = 0;
/**
* Sets a number of users for online status tracking
*
* @param number of users to be tracked
* @param array of user names
* @return 0 on success
*/
virtual int WatchBuddies(int, char**) = 0;
/**
* Unsets a user name from online status tracking.
*
* @param user name to be tracked
* @return 0 on success
*/
virtual int UnwatchBuddy(const char*) = 0;
/**
* Unsets a number of users from online status tracking
*
* @param number of users to be tracked
* @param array of user names
* @return 0 on success
*/
virtual int UnwatchBuddies(int, char**) = 0;
/**
* Gets the service config entry
*
* @return config object
*/
virtual PSConfig* GetServiceConfig() = 0;
};
#endif // __PS_BUDDY_SERVICE_H__
|
