|
1 // Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies). |
|
2 // All rights reserved. |
|
3 // This component and the accompanying materials are made available |
|
4 // under the terms of "Eclipse Public License v1.0" |
|
5 // which accompanies this distribution, and is available |
|
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
7 // |
|
8 // Initial Contributors: |
|
9 // Nokia Corporation - initial contribution. |
|
10 // |
|
11 // Contributors: |
|
12 // |
|
13 // Description: |
|
14 // This file contains all the interfaces classes that can be implemented by |
|
15 // the Licensee LTSY relating to CellBroadcast related features. |
|
16 // |
|
17 |
|
18 |
|
19 |
|
20 |
|
21 /** |
|
22 @file |
|
23 @internalAll |
|
24 */ |
|
25 |
|
26 |
|
27 #ifndef MLTSYDISPATCHCELLBROADCASTINTERFACE_H_ |
|
28 #define MLTSYDISPATCHCELLBROADCASTINTERFACE_H_ |
|
29 |
|
30 #include <ctsy/ltsy/mltsydispatchinterface.h> |
|
31 #include <etelmm.h> |
|
32 |
|
33 |
|
34 namespace DispatcherCellBroadcast |
|
35 { |
|
36 |
|
37 /** |
|
38 * This namespace contains all types relating to the Cell Broadcast dispatcher. |
|
39 */ |
|
40 |
|
41 |
|
42 struct TWcdmaCbsMsgBase |
|
43 { |
|
44 /* |
|
45 * Number of Pages |
|
46 */ |
|
47 TInt iNumberOfPages; |
|
48 |
|
49 /* |
|
50 * Message Type |
|
51 */ |
|
52 TUint8 iMessageType; |
|
53 |
|
54 /* |
|
55 * Message ID |
|
56 */ |
|
57 TUint16 iMessageId; |
|
58 |
|
59 /* |
|
60 * Serial Number |
|
61 */ |
|
62 TUint16 iSerialNum; |
|
63 |
|
64 /* |
|
65 * Data Coding Scheme |
|
66 */ |
|
67 TUint8 iDCS; |
|
68 |
|
69 /* |
|
70 * Info length |
|
71 */ |
|
72 TUint8 iInfoLength; |
|
73 }; |
|
74 |
|
75 } |
|
76 |
|
77 class MLtsyDispatchCellBroadcastSetBroadcastFilterSetting : public MLtsyDispatchInterface |
|
78 { |
|
79 public: |
|
80 |
|
81 static const TInt KLtsyDispatchCellBroadcastSetBroadcastFilterSettingApiId = KDispatchCellBroadcastFuncUnitId + 1; |
|
82 |
|
83 /** |
|
84 * The CTSY Dispatcher shall invoke this function on receiving the EMobileBroadcastMessagingSetFilterSetting |
|
85 * request from the CTSY. |
|
86 * |
|
87 * It is a request call that is completed by invoking |
|
88 * CCtsyDispatcherCallback::CallbackCellBroadcastSetBroadcastFilterSettingComp() |
|
89 * |
|
90 * Implementation of this interface sets a new value for the filter setting. |
|
91 * The filter specifies which broadcast messages are accepted and which are rejected |
|
92 * |
|
93 * |
|
94 * @param aFilterSetting struct settings for a filter to accept/reject messages |
|
95 * |
|
96 * @return KErrNone on success, otherwise another error code indicating the |
|
97 * failure. |
|
98 * |
|
99 * @see RMobileBroadcastMessaging::SetFilterSetting() |
|
100 */ |
|
101 virtual TInt HandleSetBroadcastFilterSettingReqL(RMobileBroadcastMessaging::TMobilePhoneBroadcastFilter aFilterSetting) = 0; |
|
102 |
|
103 }; // class MLtsyDispatchCellBroadcastSetBroadcastFilterSetting |
|
104 |
|
105 |
|
106 |
|
107 class MLtsyDispatchCellBroadcastActivateBroadcastReceiveMessage : public MLtsyDispatchInterface |
|
108 { |
|
109 public: |
|
110 |
|
111 static const TInt KLtsyDispatchCellBroadcastActivateBroadcastReceiveMessageApiId = KDispatchCellBroadcastFuncUnitId + 2; |
|
112 |
|
113 /** |
|
114 * The CTSY Dispatcher shall invoke this function on receiving the EMobileBroadcastMessagingReceiveMessage |
|
115 * request from the CTSY. |
|
116 * |
|
117 * It is a request call that is completed by invoking |
|
118 * CCtsyDispatcherCallback::CallbackCellBroadcastActivateBroadcastReceiveMessageComp() |
|
119 * |
|
120 * RMobileBroadcastMessaging::ReceiveMessage will be completed when a new incoming broadcast message has been received |
|
121 * via CallbackCellBroadcastGsmBroadcastNotifyMessageReceivedInd() or CallbackCellBroadcastWcdmaBroadcastMessageReceivedInd() |
|
122 * |
|
123 * @param aFilterSetting struct settings for a filter to accept/reject messages |
|
124 * |
|
125 * @return KErrNone on success, otherwise another error code indicating the |
|
126 * failure. |
|
127 * |
|
128 * @see RMobileBroadcastMessaging::ReceiveMessage() |
|
129 * @see CCtsyDispatcherCallback::CallbackCellBroadcastGsmBroadcastNotifyMessageReceivedInd() |
|
130 * @see CCtsyDispatcherCallback::CallbackCellBroadcastWcdmaBroadcastMessageReceivedInd() |
|
131 */ |
|
132 virtual TInt HandleActivateBroadcastReceiveMessageReqL(RMobileBroadcastMessaging::TMobilePhoneBroadcastFilter aFilterSetting) = 0; |
|
133 |
|
134 }; // class MLtsyDispatchCellBroadcastActivateBroadcastReceiveMessage |
|
135 |
|
136 |
|
137 |
|
138 class MLtsyDispatchCellBroadcastReceiveMessageCancel : public MLtsyDispatchInterface |
|
139 { |
|
140 public: |
|
141 |
|
142 static const TInt KLtsyDispatchCellBroadcastReceiveMessageCancelApiId = KDispatchCellBroadcastFuncUnitId + 3; |
|
143 |
|
144 /** |
|
145 * The CTSY Dispatcher shall invoke this function on receiving the EMobileBroadcastMessagingReceiveMessageCancel |
|
146 * request from the CTSY. |
|
147 * |
|
148 * It is a request call that is completed by invoking |
|
149 * CCtsyDispatcherCallback::CallbackCellBroadcastReceiveMessageCancelComp() |
|
150 * |
|
151 * |
|
152 * @param aFilterSetting struct settings for a filter to accept/reject messages |
|
153 * |
|
154 * @return KErrNone on success, otherwise another error code indicating the |
|
155 * failure. |
|
156 * |
|
157 * @see RMobileBroadcastMessaging::ReceiveMessage() |
|
158 * @see RMobileBroadcastMessaging::Close() |
|
159 */ |
|
160 virtual TInt HandleReceiveMessageCancelReqL(RMobileBroadcastMessaging::TMobilePhoneBroadcastFilter aFilterSetting ) = 0; |
|
161 |
|
162 }; // class MLtsyDispatchCellBroadcastReceiveMessageCancel |
|
163 |
|
164 class MLtsyDispatchCellBroadcastStartSimCbTopicBrowsing : public MLtsyDispatchInterface |
|
165 { |
|
166 public: |
|
167 |
|
168 static const TInt KLtsyDispatchCellBroadcastStartSimCbTopicBrowsingApiId = KDispatchCellBroadcastFuncUnitId + 4; |
|
169 |
|
170 /** |
|
171 * The CTSY Dispatcher shall invoke this function on receiving the ECustomStartSimCbTopicBrowsingIPC |
|
172 * request from the CTSY. |
|
173 * |
|
174 * It is a request call that is completed by invoking |
|
175 * CCtsyDispatcherCallback::CallbackCellBroadcastStartSimCbTopicBrowsingComp() |
|
176 * |
|
177 * |
|
178 * @return KErrNone on success, otherwise another error code indicating the |
|
179 * failure. |
|
180 */ |
|
181 virtual TInt HandleStartSimCbTopicBrowsingReqL() = 0; |
|
182 |
|
183 }; // class MLtsyDispatchCellBroadcastStartSimCbTopicBrowsing |
|
184 |
|
185 class MLtsyDispatchCellBroadcastDeleteSimCbTopic : public MLtsyDispatchInterface |
|
186 { |
|
187 public: |
|
188 |
|
189 static const TInt KLtsyDispatchCellBroadcastDeleteSimCbTopicApiId = KDispatchCellBroadcastFuncUnitId + 5; |
|
190 |
|
191 /** |
|
192 * The CTSY Dispatcher shall invoke this function on receiving the ECustomDeleteSimCbTopicIPC |
|
193 * request from the CTSY. |
|
194 * |
|
195 * It is a request call that is completed by invoking |
|
196 * CCtsyDispatcherCallback::CallbackCellBroadcastDeleteSimCbTopicComp() |
|
197 * |
|
198 * |
|
199 * @return KErrNone on success, otherwise another error code indicating the |
|
200 * failure. |
|
201 */ |
|
202 virtual TInt HandleDeleteSimCbTopicReqL(TUint aIndex, TBool aDeleteFlag) = 0; |
|
203 |
|
204 }; // class MLtsyDispatchCellBroadcastDeleteSimCbTopic |
|
205 |
|
206 |
|
207 #endif /*MLTSYDISPATCHCELLBROADCASTINTERFACE_H_*/ |