videoplayerapp/videoplayerengine/tsrc/testvideoiadupdatewrapper/stub/inc/iaupdate.h
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/videoplayerapp/videoplayerengine/tsrc/testvideoiadupdatewrapper/stub/inc/iaupdate.h Tue Oct 05 09:26:49 2010 +0300
@@ -0,0 +1,179 @@
+/*
+* Copyright (c) 2007-2008 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description: This file contains the header file of the CIAUpdate class
+*
+*/
+
+
+#ifndef IA_UPDATE_H
+#define IA_UPDATE_H
+
+#include <e32base.h>
+#include <e32std.h>
+
+#define private public
+#include "videoiadupdatewrapper.h"
+#undef private
+
+class CIAUpdateManager;
+class CIAUpdateParameters;
+class MIAUpdateObserver;
+
+/**
+ * CIAUpdate object provides methods to handle update actions.
+ * Updating will be targeted to the update items that qualify the requirements
+ * given in CIAUpdateParameters objects. In asynchronous actions, the callback
+ * functions of MIAUpdateObserver object will be informed about the progress
+ * of update actions.
+ *
+ * @see MIAUpdateObserver
+ * @see CIAUpdateParameters
+ *
+ * @since S60 v3.2
+ */
+
+class CIAUpdate : public CBase
+ {
+public:
+
+ /**
+ * @param aObserver Callback functions of the observer are called
+ * when operations that are started from this interface progress.
+ * @return CIAUpdate* Pointer to the created CIAUpdate object that
+ * can be used for update actions.
+ *
+ * @since S60 v3.2
+ */
+ static CIAUpdate* NewL( MIAUpdateObserver& ){return new CIAUpdate;};
+
+ /**
+ * Destructor
+ *
+ * @since S60 v3.2
+ */
+ virtual ~CIAUpdate(){};
+
+
+ /**
+ * Checks if any updates are available.
+ * This function is asynchronic.
+ *
+ * @note Update check is directed to items that match:
+ * - CIAUpdateParameters::Uid OR
+ * - CIAUpdateParameters::SearchCriteria
+ * @note Uid describes either package UID or SID.
+ * UID is assumed to be SID if update items are not found
+ * with the given UID. Then, corresponding package UID is
+ * searched from the installed application registry.
+ * If corresponding package UID is found, then update items
+ * are rechecked.
+ * @note If Uid is given, then search criteria is omitted.
+ * @note If none of the parameters that are mentioned above is not set,
+ * then all the updates are checked.
+ *
+ * @note CIAUpdateParameters::ShowProgress defines if a ready-made
+ * wait dialog should be shown in case the operation takes longer time.
+ * This happens e.g. if the updates are refreshed from the server.
+ *
+ * @param aUpdateParameters Defines the update targets.
+ *
+ * @since S60 v3.2
+ */
+ void CheckUpdates( const CIAUpdateParameters& ){};
+
+
+ /**
+ * Starts IAD UI.
+ *
+ * UI will show the update items that qualify the requirements given
+ * in aUpdateParameters.
+ *
+ * Even if the updating is handled in the IAD UI, the observer is informed
+ * about the progression of operations. So, the calling application
+ * may continue correctly after updates are finished.
+ *
+ * @note IAD UI will show update items that match:
+ * - CIAUpdateParameters::Uid
+ * - CIAUpdateParameters::SearchCriteria
+ * @note Uid describes either package UID or SID.
+ * UID is assumed to be SID if update items are not found
+ * with the given UID. Then, corresponding package UID is
+ * searched from the installed application registry.
+ * If corresponding package UID is found, then update items
+ * are rechecked.
+ * @note If Uid is given, then search criteria is omitted.
+ * @note If none of the parameters that are mentioned above is not set,
+ * then all the updates are shown in the UI.
+ *
+ * @note When update finishes, the following values are used
+ * for command line execution:
+ * - CIAUpdateParameters::CommandLineExecutable
+ * - CIAUpdateParameters::CommandLineArguments
+ * @note If CIAUpdateParameters::CommandLineExecutable is not set,
+ * then no command line execution is done.
+ *
+ * @param aUpdateParameters Defines the update targets.
+ *
+ * @since S60 v3.2
+ */
+ void ShowUpdates( const CIAUpdateParameters& ){};
+
+
+ /**
+ * All the items that qualify the requirements given in
+ * aUpdateParameters will be updated without opening the IAD UI.
+ * This function is asynchronic.
+ *
+ * @note Update is directed to items that match:
+ * - CIAUpdateParameters::Uid
+ * - CIAUpdateParameters::SearchCriteria
+ * @note Uid describes either package UID or SID.
+ * UID is assumed to be SID if update items are not found
+ * with the given UID. Then, corresponding package UID is
+ * searched from the installed application registry.
+ * If corresponding package UID is found, then update items
+ * are rechecked.
+ * @note If Uid is given, then search criteria is omitted.
+ * @note If none of the parameters that are mentioned above is not set,
+ * then everything is updated.
+ *
+ * @note When update finishes, the following values are used
+ * for command line execution:
+ * - CIAUpdateParameters::CommandLineExecutable
+ * - CIAUpdateParameters::CommandLineArguments
+ * @note If CIAUpdateParameters::CommandLineExecutable is not set,
+ * then no command line execution is done.
+ *
+ * @param aUpdateParameters Defines the update targets.
+ *
+ * @since S60 v3.2
+ */
+ void Update( const CIAUpdateParameters& ){};
+
+
+ /**
+ * This function is provided as a convenience method
+ * that has localized texts for the query dialog.
+ * This function does not start any update.
+ * This function is asynchronic.
+ *
+ * @note The observer is informed when the update query operation has completed.
+ *
+ * @since S60 v3.2
+ */
+ void UpdateQuery(){};
+
+ };
+
+#endif // IA_UPDATE_H