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  GaimPrivacyUiOps
 Privacy core/UI operations. More...

Typedefs

typedef enum _GaimPrivacyType GaimPrivacyType
 Privacy data types.

Enumerations

enum  _GaimPrivacyType {
  GAIM_PRIVACY_ALLOW_ALL = 1, GAIM_PRIVACY_DENY_ALL, GAIM_PRIVACY_ALLOW_USERS, GAIM_PRIVACY_DENY_USERS,
  GAIM_PRIVACY_ALLOW_BUDDYLIST
}
 Privacy data types.

Functions

gboolean gaim_privacy_permit_add (GaimAccount *account, const char *name, gboolean local_only)
 Adds a user to the account's permit list.
gboolean gaim_privacy_permit_remove (GaimAccount *account, const char *name, gboolean local_only)
 Removes a user from the account's permit list.
gboolean gaim_privacy_deny_add (GaimAccount *account, const char *name, gboolean local_only)
 Adds a user to the account's deny list.
gboolean gaim_privacy_deny_remove (GaimAccount *account, const char *name, gboolean local_only)
 Removes a user from the account's deny list.
void gaim_privacy_set_ui_ops (GaimPrivacyUiOps *ops)
 Sets the UI operations structure for the privacy subsystem.
GaimPrivacyUiOpsgaim_privacy_get_ui_ops (void)
 Returns the UI operations structure for the privacy subsystem.
void gaim_privacy_init (void)
 Initializes the privacy subsystem.


Detailed Description

Privacy API.

gaim

Gaim 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


Function Documentation

gboolean gaim_privacy_deny_add ( GaimAccount *  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 gaim_privacy_deny_remove ( GaimAccount *  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.

GaimPrivacyUiOps* gaim_privacy_get_ui_ops ( void   ) 

Returns the UI operations structure for the privacy subsystem.

Returns:
The UI operations structure.

gboolean gaim_privacy_permit_add ( GaimAccount *  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 gaim_privacy_permit_remove ( GaimAccount *  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 gaim_privacy_set_ui_ops ( GaimPrivacyUiOps ops  ) 

Sets the UI operations structure for the privacy subsystem.

Parameters:
ops The UI operations structure.


Generated on Sun Feb 18 08:38:33 2007 for gaim by  doxygen 1.5.1