privacy.h File Reference

Privacy API. More...

#include "account.h"

Include dependency graph for privacy.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  PurplePrivacyUiOps
 Privacy core/UI operations. More...

Typedefs

typedef enum _PurplePrivacyType PurplePrivacyType
 Privacy data types.

Enumerations

enum  _PurplePrivacyType {
  PURPLE_PRIVACY_ALLOW_ALL = 1, PURPLE_PRIVACY_DENY_ALL, PURPLE_PRIVACY_ALLOW_USERS, PURPLE_PRIVACY_DENY_USERS,
  PURPLE_PRIVACY_ALLOW_BUDDYLIST
}
 Privacy data types. More...

Functions

void purple_privacy_allow (PurpleAccount *account, const char *who, gboolean local, gboolean restore)
 Allow a user to send messages.
gboolean purple_privacy_check (PurpleAccount *account, const char *who)
 Check the privacy-setting for a user.
void purple_privacy_deny (PurpleAccount *account, const char *who, gboolean local, gboolean restore)
 Block messages from a user.
gboolean purple_privacy_deny_add (PurpleAccount *account, const char *name, gboolean local_only)
 Adds a user to the account's deny list.
gboolean purple_privacy_deny_remove (PurpleAccount *account, const char *name, gboolean local_only)
 Removes a user from the account's deny list.
PurplePrivacyUiOpspurple_privacy_get_ui_ops (void)
 Returns the UI operations structure for the privacy subsystem.
void purple_privacy_init (void)
 Initializes the privacy subsystem.
gboolean purple_privacy_permit_add (PurpleAccount *account, const char *name, gboolean local_only)
 Adds a user to the account's permit list.
gboolean purple_privacy_permit_remove (PurpleAccount *account, const char *name, gboolean local_only)
 Removes a user from the account's permit list.
void purple_privacy_set_ui_ops (PurplePrivacyUiOps *ops)
 Sets the UI operations structure for the privacy subsystem.


Detailed Description

Privacy API.

purple

Purple is the legal property of its developers, whose names are too numerous to list here. Please refer to the COPYRIGHT file distributed with this source distribution.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program 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 General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Definition in file privacy.h.


Enumeration Type Documentation

enum _PurplePrivacyType

Privacy data types.

Enumerator:
PURPLE_PRIVACY_ALLOW_ALL 
PURPLE_PRIVACY_DENY_ALL 
PURPLE_PRIVACY_ALLOW_USERS 
PURPLE_PRIVACY_DENY_USERS 
PURPLE_PRIVACY_ALLOW_BUDDYLIST 

Definition at line 33 of file privacy.h.


Function Documentation

void purple_privacy_allow ( PurpleAccount account,
const char *  who,
gboolean  local,
gboolean  restore 
)

Allow a user to send messages.

If current privacy setting for the account is: PURPLE_PRIVACY_ALLOW_USERS: The user is added to the allow-list. PURPLE_PRIVACY_DENY_USERS : The user is removed from the deny-list. PURPLE_PRIVACY_ALLOW_ALL : No changes made. PURPLE_PRIVACY_DENY_ALL : The privacy setting is changed to PURPLE_PRIVACY_ALLOW_USERS and the user is added to the allow-list. PURPLE_PRIVACY_ALLOW_BUDDYLIST: No changes made if the user is already in the buddy-list. Otherwise the setting is changed to PURPLE_PRIVACY_ALLOW_USERS, all the buddies are added to the allow-list, and the user is also added to the allow-list.

Parameters:
account The account.
who The name of the user.
local Whether the change is local-only.
restore Should the previous allow/deny list be restored if the privacy setting is changed.

gboolean purple_privacy_check ( PurpleAccount account,
const char *  who 
)

Check the privacy-setting for a user.

Parameters:
account The account.
who The name of the user.
Returns:
FALSE if the specified account's privacy settings block the user or TRUE otherwise. The meaning of "block" is protocol-dependent and generally relates to status and/or sending of messages.

void purple_privacy_deny ( PurpleAccount account,
const char *  who,
gboolean  local,
gboolean  restore 
)

Block messages from a user.

If current privacy setting for the account is: PURPLE_PRIVACY_ALLOW_USERS: The user is removed from the allow-list. PURPLE_PRIVACY_DENY_USERS : The user is added to the deny-list. PURPLE_PRIVACY_DENY_ALL : No changes made. PURPLE_PRIVACY_ALLOW_ALL : The privacy setting is changed to PURPLE_PRIVACY_DENY_USERS and the user is added to the deny-list. PURPLE_PRIVACY_ALLOW_BUDDYLIST: If the user is not in the buddy-list, then no changes made. Otherwise, the setting is changed to PURPLE_PRIVACY_ALLOW_USERS, all the buddies are added to the allow-list, and this user is removed from the list.

Parameters:
account The account.
who The name of the user.
local Whether the change is local-only.
restore Should the previous allow/deny list be restored if the privacy setting is changed.

gboolean purple_privacy_deny_add ( PurpleAccount account,
const char *  name,
gboolean  local_only 
)

Adds a user to the account's deny list.

Parameters:
account The account.
name The name of the user to add to the list.
local_only If TRUE, only the local list is updated, and not the server.
Returns:
TRUE if the user was added successfully, or FALSE otherwise.

gboolean purple_privacy_deny_remove ( PurpleAccount account,
const char *  name,
gboolean  local_only 
)

Removes a user from the account's deny list.

Parameters:
account The account.
name The name of the user to add to the list.
local_only If TRUE, only the local list is updated, and not the server.
Returns:
TRUE if the user was removed successfully, or FALSE otherwise.

PurplePrivacyUiOps* purple_privacy_get_ui_ops ( void   ) 

Returns the UI operations structure for the privacy subsystem.

Returns:
The UI operations structure.

gboolean purple_privacy_permit_add ( PurpleAccount account,
const char *  name,
gboolean  local_only 
)

Adds a user to the account's permit list.

Parameters:
account The account.
name The name of the user to add to the list.
local_only If TRUE, only the local list is updated, and not the server.
Returns:
TRUE if the user was added successfully, or FALSE otherwise.

gboolean purple_privacy_permit_remove ( PurpleAccount account,
const char *  name,
gboolean  local_only 
)

Removes a user from the account's permit list.

Parameters:
account The account.
name The name of the user to add to the list.
local_only If TRUE, only the local list is updated, and not the server.
Returns:
TRUE if the user was removed successfully, or FALSE otherwise.

void purple_privacy_set_ui_ops ( PurplePrivacyUiOps ops  ) 

Sets the UI operations structure for the privacy subsystem.

Parameters:
ops The UI operations structure.