#include <privacymanager.h>
This class implements a manager for privacy lists as defined in section 10 of RFC 3921.
- Author
- Jakob Schröter js@ca.nosp@m.maya.nosp@m..net
- Since
- 0.3
Definition at line 34 of file privacymanager.h.
◆ PrivacyManager()
◆ ~PrivacyManager()
◆ handleIq()
bool handleIq |
( |
const IQ & |
iq | ) |
|
|
virtual |
Reimplement this function if you want to be notified about incoming IQs.
- Parameters
-
iq | The complete IQ stanza. |
- Returns
- Indicates whether a request of type 'get' or 'set' has been handled. This includes the obligatory 'result' answer. If you return false, an 'error' will be sent back.
- Since
- 1.0
Implements IqHandler.
Definition at line 236 of file privacymanager.cpp.
◆ handleIqID()
void handleIqID |
( |
const IQ & |
iq, |
|
|
int |
context |
|
) |
| |
|
virtual |
Reimplement this function if you want to be notified about incoming IQs with a specific value of the id
attribute. You have to enable tracking of those IDs using Client::trackID(). This is usually useful for IDs that generate a empty positive reply, i.e. <iq type='result' id='reg'/> where a namespace filter wouldn't work.
- Parameters
-
iq | The complete IQ stanza. |
context | A value to restore context, stored with ClientBase::trackID(). |
- Note
- Only IQ stanzas of type 'result' or 'error' can arrive here.
- Since
- 1.0
Implements IqHandler.
Definition at line 249 of file privacymanager.cpp.
◆ registerPrivacyListHandler()
◆ removeList()
std::string removeList |
( |
const std::string & |
name | ) |
|
|
inline |
Removes a list by its name.
- Parameters
-
name | The name of the list to remove. |
Definition at line 73 of file privacymanager.h.
◆ removePrivacyListHandler()
void removePrivacyListHandler |
( |
| ) |
|
|
inline |
◆ requestList()
std::string requestList |
( |
const std::string & |
name | ) |
|
|
inline |
Triggers the retrieval of the named privacy lists.
- Parameters
-
name | The name of the list to retrieve. |
Definition at line 66 of file privacymanager.h.
◆ requestListNames()
std::string requestListNames |
( |
| ) |
|
|
inline |
Triggers the request of the privacy lists currently stored on the server.
Definition at line 59 of file privacymanager.h.
◆ setActive()
std::string setActive |
( |
const std::string & |
name | ) |
|
|
inline |
Sets the named list as active, i.e. active for this session
- Parameters
-
name | The name of the list to set active. |
Definition at line 93 of file privacymanager.h.
◆ setDefault()
std::string setDefault |
( |
const std::string & |
name | ) |
|
|
inline |
Sets the named list as the default list, i.e. active by default after login.
- Parameters
-
name | The name of the list to set as default. |
Definition at line 80 of file privacymanager.h.
◆ store()
Stores the given list on the server. If a list with the given name exists, the existing list is overwritten.
- Parameters
-
name | The list's name. |
list | A non empty list of privacy items which describe the list. |
Definition at line 223 of file privacymanager.cpp.
◆ unsetActive()
std::string unsetActive |
( |
| ) |
|
|
inline |
This function declines the use of any active list.
Definition at line 99 of file privacymanager.h.
◆ unsetDefault()
std::string unsetDefault |
( |
| ) |
|
|
inline |
This function declines the use of any default list.
Definition at line 86 of file privacymanager.h.
The documentation for this class was generated from the following files: