sl@0: /**
sl@0: * Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: * All rights reserved.
sl@0: * This component and the accompanying materials are made available
sl@0: * under the terms of "Eclipse Public License v1.0"
sl@0: * which accompanies this distribution, and is available
sl@0: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: *
sl@0: * Initial Contributors:
sl@0: * Nokia Corporation - initial contribution.
sl@0: *
sl@0: * Contributors:
sl@0: *
sl@0: * Description:
sl@0: * Declaration of Types and Constants for Secure Backup and Restore
sl@0: * 
sl@0: *
sl@0: */
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0:  @file
sl@0: */
sl@0: #ifndef __SBDEFS_H__
sl@0: #define __SBDEFS_H__
sl@0: 
sl@0: #include <e32std.h>
sl@0: #include <f32file.h>
sl@0: 
sl@0: namespace conn
sl@0: 	{
sl@0: 	/** Secure Backup and Restore publish and subscribe key
sl@0: 
sl@0: 	Secure Backup and Restore uses a Publish and Subscribe key to publish
sl@0: 	the current backup / restore state.
sl@0:  
sl@0: 	The key is a system key so the category to be used when subscribing is KUidSystemCategoryValue
sl@0: 	The key to be used is KUidBackupRestoreKey.
sl@0: 	The value is a bit-wise OR of a TBURPartType value and a TBackupIncType value
sl@0: 	This means that a normal state (i.e. non-backup or restore) is EBURNormal | ENoBackup but
sl@0: 	If the key has not been set (i.e. == 0) then no backup or restore is in progress either
sl@0: 
sl@0: 	@released
sl@0: 	@publishedAll
sl@0: 	*/
sl@0: 	const TUint KUidBackupRestoreKey = 0x10202792 ;
sl@0: 
sl@0: 
sl@0: 	/** TBURPartType Bitmask
sl@0: 	@released
sl@0: 	@publishedAll
sl@0: 	*/
sl@0: 	const TUint KBURPartTypeMask = 0xff;
sl@0: 
sl@0: 	enum TBURPartType
sl@0: 		/** 
sl@0: 		The backup / restore state of a device.
sl@0: 
sl@0: 		@released
sl@0: 		@publishedAll
sl@0: 		*/
sl@0: 		{
sl@0: 		EBURUnset          = 0x00000000, /*!< 0x00000000: The backup / restore mode has not been set */
sl@0: 		EBURNormal         = 0x00000001, /*!< 0x00000001: The device as a whole is not engaged in a backup or restore */
sl@0: 		EBURBackupFull     = 0x00000002, /*!< 0x00000002: The device as a whole is engaged in a backup of all components data */
sl@0: 		EBURBackupPartial  = 0x00000004, /*!< 0x00000004: The device as a whole is engaged in a backup of selected components data */
sl@0: 		EBURRestoreFull    = 0x00000008, /*!< 0x00000008: The device as a whole is engaged in a restore of all components data */
sl@0: 		EBURRestorePartial = 0x00000010  /*!< 0x00000010: The device as a whole is engaged in a restore of all components data */
sl@0: 		};
sl@0: 
sl@0: 	/** TBackupIncType Bitmask
sl@0: 	@released
sl@0: 	@publishedAll
sl@0: 	*/
sl@0: 	const TUint KBackupIncTypeMask = 0xffffff00;
sl@0: 
sl@0: 	enum TBackupIncType
sl@0: 		/** 
sl@0: 		The type of a backup.
sl@0: 
sl@0: 		@released
sl@0: 		@publishedAll
sl@0: 		*/
sl@0: 		{
sl@0: 		ENoBackup        = 0x00000000, /*!< 0x00000000: No backup is in progress */
sl@0: 		EBackupBase      = 0x00000100, /*!< 0x00000100: The backup is a base backup, i.e. it includes all files / data */
sl@0: 		EBackupIncrement = 0x00000200  /*!< 0x00000200: The backup is an incremental backup, i.e. it includes only files / data that have changed since a previous backup */
sl@0: 		};
sl@0: 
sl@0: 	} // end namespace
sl@0: #endif