|
1 /* |
|
2 * Copyright (c) 2007 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: Handles all the Synchronous operations with the Location |
|
15 * Centre Client Session |
|
16 * |
|
17 */ |
|
18 |
|
19 |
|
20 #ifndef LCSYNCOPERATION_H |
|
21 #define LCSYNCOPERATION_H |
|
22 |
|
23 // SYSTEM INCLUDES |
|
24 #include <e32base.h> |
|
25 |
|
26 // USER INCLUDES |
|
27 |
|
28 // FORWARD DECLARATIONS |
|
29 class RLcClientSession; |
|
30 class CLcBasicAppInfo; |
|
31 class CLcLocationAppInfoArray; |
|
32 class TLcLocationAppFilter; |
|
33 |
|
34 /** |
|
35 * Handles all the Synchronous operations to the Location Centre Server. |
|
36 * |
|
37 * @lib lcservice.lib |
|
38 * @since S60 v5.0 |
|
39 */ |
|
40 NONSHARABLE_CLASS( LcSyncOperation ) |
|
41 { |
|
42 public: |
|
43 /** |
|
44 * Gets a filtered list of Location based Applications. |
|
45 * |
|
46 * @param[in] aSession Reference to the Location Centre Client Session. |
|
47 * @param[in] aLocationAppFilter Filtering parameters. |
|
48 * @return CLcLocationAppInfoArray* Array of Location based Applications and |
|
49 * Contents/Services. |
|
50 */ |
|
51 static CLcLocationAppInfoArray* GetLocationApplicationsL( |
|
52 RLcClientSession& aSession, |
|
53 const TLcLocationAppFilter& aLocationAppFilter ); |
|
54 |
|
55 /** |
|
56 * Gets a filtered list of Location based Applications. |
|
57 * |
|
58 * The Client application can configure the list of Location based |
|
59 * Applications returned. This can be achieved by passing the list of Location |
|
60 * based Applications which the Client wants to be included/excluded in the |
|
61 * list. |
|
62 * |
|
63 * The ownership of the array of identifiers is not transferred. |
|
64 * |
|
65 * @param[in] aSession Reference to the Location Centre Client Session. |
|
66 * @param[in] aAppArray Array of Location based Applications and Contents |
|
67 * or Services which need to be included or excluded. |
|
68 * @param[in] aIncludeFlag Boolean flag which defines whether the set of |
|
69 * Location based Applications should be included or |
|
70 * excluded. |
|
71 * @return CLcLocationAppInfoArray object containing a list |
|
72 * of applications registered with Location Centre. |
|
73 */ |
|
74 static CLcLocationAppInfoArray* GetLocationApplicationsL( |
|
75 RLcClientSession& aSession, |
|
76 const RArray<TPtrC>& aAppArray, |
|
77 TBool aIncludeFlag ); |
|
78 |
|
79 /** |
|
80 * Gets the Location Application Information corresponding to the Location |
|
81 * based Application or Content/Service based on the Identifer name. |
|
82 * |
|
83 * @param[in] aSession Reference to the Location Centre Client Session. |
|
84 * @param[in] aIdentifier Name of the Location based Identifier whose |
|
85 * information is requested. |
|
86 */ |
|
87 static CLcBasicAppInfo* GetLocationAppInfoL( |
|
88 RLcClientSession& aSession, |
|
89 const TDesC& aIdentifier ); |
|
90 |
|
91 /** |
|
92 * Parses the Location Application information present in the Read stream. |
|
93 * |
|
94 * Other documentation present in the corresponding function for |
|
95 * CLcService class. |
|
96 */ |
|
97 static CLcLocationAppInfoArray* ParseLocAppBufferL( RReadStream& aReadStream ); |
|
98 }; |
|
99 |
|
100 #endif // LCSYNCOPERATION_H |