epoc32/include/authserver/authmgrclient.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@4
     1
/*
williamr@4
     2
* Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     3
* All rights reserved.
williamr@4
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of the License "Eclipse Public License v1.0"
williamr@4
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4
     8
*
williamr@4
     9
* Initial Contributors:
williamr@4
    10
* Nokia Corporation - initial contribution.
williamr@4
    11
*
williamr@4
    12
* Contributors:
williamr@4
    13
*
williamr@4
    14
* Description: 
williamr@4
    15
* RAuthMgrClient - external authentication client session interface
williamr@4
    16
* The defined fuctionality is used by clients to access the authentication
williamr@4
    17
* server for the purpose of managing identities.
williamr@4
    18
* The access to a specific functionality is dependant on the client 
williamr@4
    19
* capabilities and may be restricted.             
williamr@4
    20
*
williamr@4
    21
*/
williamr@4
    22
williamr@4
    23
williamr@4
    24
/**
williamr@4
    25
 @file 
williamr@4
    26
 @publishedAll
williamr@4
    27
 @released
williamr@4
    28
*/
williamr@4
    29
williamr@4
    30
#ifndef AUTHMGRCLIENT_H
williamr@4
    31
#define AUTHMGRCLIENT_H
williamr@4
    32
williamr@4
    33
#include "authserver/authclient.h"
williamr@4
    34
williamr@4
    35
namespace AuthServer
williamr@4
    36
{
williamr@4
    37
williamr@4
    38
/**
williamr@4
    39
 * Client side interface to the authentication server providing identity
williamr@4
    40
 * management services.
williamr@4
    41
 */	
williamr@4
    42
class RAuthMgrClient : public RAuthClient
williamr@4
    43
	{
williamr@4
    44
public:
williamr@4
    45
williamr@4
    46
	IMPORT_C void RegisterIdentityL(CIdentity*& aIdentity,
williamr@4
    47
								   const TDesC& aDescription,  
williamr@4
    48
								   TRequestStatus& aRequest);
williamr@4
    49
williamr@4
    50
	IMPORT_C void RemoveIdentityL(TIdentityId aId);
williamr@4
    51
williamr@4
    52
williamr@4
    53
	IMPORT_C void TrainPlugin(TIdentityId aId,
williamr@4
    54
							  TPluginId aPlugin,
williamr@4
    55
							  TRequestStatus& aRequest);
williamr@4
    56
williamr@4
    57
	IMPORT_C void ForgetPluginL(TIdentityId aId,
williamr@4
    58
					  TPluginId aPlugin);
williamr@4
    59
williamr@4
    60
	IMPORT_C void SetPreferredTypePluginL(TAuthPluginType aPluginType,
williamr@4
    61
										  TPluginId aPluginId);
williamr@4
    62
williamr@4
    63
	IMPORT_C void ResetIdentityL(TIdentityId aId,
williamr@4
    64
								const TDesC& aRegistrationInformation);
williamr@4
    65
williamr@4
    66
	IMPORT_C void ResetIdentityL(TIdentityId aId,
williamr@4
    67
								TAuthPluginType aPluginType,
williamr@4
    68
								const TDesC& aRegistrationInformation);
williamr@4
    69
williamr@4
    70
	IMPORT_C void ResetIdentityL(TIdentityId aId,
williamr@4
    71
								RArray<TPluginId>& aPluginIdList,
williamr@4
    72
								RPointerArray<const HBufC>& aRegistrationInformation);
williamr@4
    73
	};
williamr@4
    74
} // namespace
williamr@4
    75
#endif