|
1 /** |
|
2 * Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: MUpnpTmServerObserver interface definition |
|
15 * |
|
16 */ |
|
17 |
|
18 #ifndef __UPNPTMSERVEROBSERVER_H__ |
|
19 #define __UPNPTMSERVEROBSERVER_H__ |
|
20 |
|
21 #include <terminalmodeconsts.h> |
|
22 #include <upnptmclienticonpref.h> |
|
23 |
|
24 /** |
|
25 * This is the main callback interface which the Terminal Mode Server application |
|
26 * needs to implement to handle the soap action requests from the Terminal Mode Clients. |
|
27 * It also provides a method to fetch client's icon preferences from AutomotiveServer. |
|
28 * |
|
29 */ |
|
30 class MUpnpTmServerObserver |
|
31 { |
|
32 public: |
|
33 /** |
|
34 * Method to intimate Automotive Server about the arrival of GetApplicationList soap action. |
|
35 * This is a synchronous call and the implementing class must return immediately |
|
36 * @param aProfileId Profile ID of the client profile whose parameter settings will be |
|
37 * applied for generating the application list |
|
38 * @return Returns Terminal Mode Error code |
|
39 */ |
|
40 virtual TTerminalModeErrorCode OnGetApplicationList( TUint aProfileId ) = 0; |
|
41 /** |
|
42 * Method to launch an app through the Automotive Server. |
|
43 * This is a synchronous call and the implementing class must return after |
|
44 * launching the app. |
|
45 * @param aAppId The App ID as registered with the Terminal Mode Service. |
|
46 * @param aUrl[out] AS provides the actual URL where the application is running. |
|
47 * @param aProfileId Profile ID of the client profile whose parameter settings will be |
|
48 * applied for launching and executing the application |
|
49 * @return Returns Terminal Mode Error code |
|
50 */ |
|
51 virtual TTerminalModeErrorCode OnLaunchApp( TUint aAppId, RBuf8& aUrl, TUint aProfileId = 0 ) = 0; |
|
52 /** |
|
53 * Method to terminate an app that is already running. |
|
54 * @param aAppID The ID of the App as registered with the Terminal Mode Service. |
|
55 * @param aProfileId Profile ID of the client profile whose parameter settings will be |
|
56 * applied to the application during execution |
|
57 * @return Returns Terminal Mode Error code |
|
58 */ |
|
59 virtual TTerminalModeErrorCode OnTerminateApp( TUint aAppId, TUint aProfileId = 0 ) = 0; |
|
60 /** |
|
61 * Method through which the Terminal Mode Service Service can retrieve the status of a |
|
62 * given app. |
|
63 * @param aAppID The ID of the App as registered with the Terminal Mode Service. |
|
64 * @param aProfileId [out]Profile ID of the client profile |
|
65 * @param aStatusType [out]The App Status object to be populated |
|
66 * @return Returns Terminal Mode Error code |
|
67 */ |
|
68 virtual TTerminalModeErrorCode OnGetAppStatus( TUint aAppId, TUint& aProfileId ,RBuf8& aStatusType ) = 0; |
|
69 /** |
|
70 * AutomotiveServer returns the the value of the state variable MaxNumProfiles |
|
71 * in response to the GetMaxNumProfiles action |
|
72 * @param aProfileIdCount[out] The maximum number of client profiles that are supported |
|
73 * simultaneously by the TmClientProfile service. |
|
74 * @return Returns TerminalModeError code |
|
75 */ |
|
76 virtual TTerminalModeErrorCode OnGetMaxNumProfiles( TUint& aProfileIdCount ) = 0; |
|
77 /** |
|
78 * Method to intimate AutomotiveServer whenever the control point invokes action to register |
|
79 * a client profile and notify the Terminal Mode device about its preferences, settings |
|
80 * and capabilities. |
|
81 * @param aProfileId The identifier of the profile record where the client profile |
|
82 * settings must be stored |
|
83 * @param aClientProfile Profile information about Terminal Mode client and its capabilities |
|
84 * which needs to be updated in the profile record |
|
85 * @param aResultProfile[out] The updated client profile. |
|
86 * @return Returns Terminal Mode Error code |
|
87 */ |
|
88 virtual TTerminalModeErrorCode OnSetClientProfile( TUint aProfileId, const TDesC8& aClientProfile, |
|
89 RBuf8& aResultProfile ) = 0; |
|
90 /** |
|
91 * Method to intimate AutomotiveServer whenever the control point invokes action to |
|
92 * to access the contents of a client profile stored in the Terminal Mode device |
|
93 * @param aProfileId The identifier of the profile record where the client profile |
|
94 * settings must be stored |
|
95 * @param aClientProfile[out] Client profile corresponding to the profileID input variable |
|
96 * @return Returns Terminal Mode Error code |
|
97 */ |
|
98 virtual TTerminalModeErrorCode OnGetClientProfile( TUint aProfileId, RBuf8& aClientProfile ) = 0; |
|
99 /** |
|
100 * Method to fetch the Terminal Mode Client( Car Kit )'s icon preferences from the |
|
101 * AutomotiveServer for a particular client profile corresponding to the profileID supplied. |
|
102 * In case client profile has no icon preferences associated with it, AutomotiveServer |
|
103 * returns the Client Icon Preference object with default values. |
|
104 * This method is invoked whenever the http request for a particular application icon |
|
105 * comes to Terminal Mode Service. |
|
106 * @param aProfileId ProfileID corresponding to a particular client profile. |
|
107 * @return Returns reference to the Client Icon Preference object. |
|
108 * @see CUpnpTmClientIconPref |
|
109 */ |
|
110 virtual const CUpnpTmClientIconPref& GetClientIconPrefsL( TUint aProfileId ) = 0; |
|
111 }; |
|
112 |
|
113 #endif // __UPNPTMSERVEROBSERVER_H__ |
|
114 |