(Online version only)
|
API Guide Home (Online version only) |
|
NOTES: Header file for the phone library (CDMA or GSM)
This file defines the Notification Events between the Phone Library (either GSM or CDMA) and applications. These events allow applications to react to changes of state in the Phone Library.
Applications wishing to receive notification events from the Phone Library must register using the PhnLibRegister call. The services parameter to PhnLibRegister is a bitmap identifying the classes of events that are of interest. To unregister for notifications the app can call PhnLibRegister with the services parameter set to zero.
Notifications are sent to applications based on their unique creatorID. Confusion may occur if multiple versions of a single app exist with the same creatorID. In this case notifications will be sent to the latest version of the app (even if this app was not the one that registered). In general, you should try to avoid this situation where possible.
Each notification event is identified by a unique event code (see PhnEventCode). The event code then determines the contents of the remainder of the event.
There are three styles of notifications from the Phone Library:
(1) universal broadcast notifications are sent to all registrants for a given service. (for example, a change in the network registration status)
(2) exclusive broadcast notifications are sent to registrations one at a time. The first app that acknowledges the notification by setting the acknowedge flag will be presumed to own that notification. Only this app should handle and respond to the notification. For example, an incoming call or incoming SMS message will be acknowleged by an app that wants to answer the call or process the SMS message.
(3) direct notifications are sent directly to a specific app with a known interest in some occurence in the phone library. These are typically used after an application has taken ownership of a particular call, message, or dialog. By sending notifications directly to the owning app we avoid confusion with multiple apps sending competing instructions.
Definition in file HsPhoneEvent.h.
Include dependency graph for HsPhoneEvent.h:
Go to the source code of this file.
| #define isValidPhnDataChannelType | ( | x | ) | ((x == phnDataAvailable) || (x == phnDataNotAvailable)) |
Definition at line 1215 of file HsPhoneEvent.h.
| #define isValidPhnEventCode | ( | e | ) | ((e >= phnEvtCardInsertion) && (e < kMaxPhnEvtSupported)) |
Definition at line 632 of file HsPhoneEvent.h.
| #define isValidPhnIndicationKind | ( | i | ) | ((i >= indicationSIMReady) && (i <= indicationSIMChanged)) |
Definition at line 110 of file HsPhoneEvent.h.
| #define isValidPhnMiscDbgUpdateKind | ( | x | ) | ((x >= eDbgUpdateNone) && (x <= eDbgUpdateQuit)) |
Definition at line 1176 of file HsPhoneEvent.h.
| #define isValidPhnModuleButtonType | ( | m | ) | (m < phnButtonLast) |
Definition at line 791 of file HsPhoneEvent.h.
| #define isValidPhnMsgIDType | ( | m | ) | ((m >= kMsgIdReserved) && (m <= kMsgIdUserAck)) |
Definition at line 1202 of file HsPhoneEvent.h.
| #define isValidPhnOpenDialogType | ( | o | ) | (o <= kDialogSendUSSD) |
Definition at line 911 of file HsPhoneEvent.h.
| #define isValidPhnProgressType | ( | p | ) | (p <= kShowSegment) |
Definition at line 890 of file HsPhoneEvent.h.
| #define NAITextLength 72 |
Definition at line 1236 of file HsPhoneEvent.h.
| #define NAITextSize (NAITextLength + 1) |
Definition at line 1237 of file HsPhoneEvent.h.
| #define PasswordLength 16 |
Definition at line 1238 of file HsPhoneEvent.h.
| #define PasswordSize (PasswordLength + 1) |
Definition at line 1239 of file HsPhoneEvent.h.
| #define phnAddressDigitsMax 32 |
Definition at line 75 of file HsPhoneEvent.h.
| #define PhnEventRecord PhnEventType |
Definition at line 1483 of file HsPhoneEvent.h.
| #define phnLibLaunchCmdEvent 0xabad |
Phone Event notification. Used to be 0x2bad, which is less than Palm's custom base. Have to get Palm to allow that.
Definition at line 83 of file HsPhoneEvent.h.
| #define phnLibLaunchCmdRegister 0xabae |
Sent to application to register with GSM library
Definition at line 88 of file HsPhoneEvent.h.
| #define phnNotifyEquipMode 'Heqp' |
GSM notificaiton for equip mode change
Definition at line 80 of file HsPhoneEvent.h.
| #define phnNotifySubscriber 'CLIP' |
GSM notification with caller ID
Definition at line 79 of file HsPhoneEvent.h.
| #define PhnSMSParamsVersion 2 |
Definition at line 773 of file HsPhoneEvent.h.
| #define phnUPEvent 'Hsup' |
Definition at line 1277 of file HsPhoneEvent.h.
| #define phnUserDataMax 255 |
Definition at line 76 of file HsPhoneEvent.h.
| #define phnWAPEvent 'Hwap' |
Definition at line 1248 of file HsPhoneEvent.h.
| #define phnWUEvent 'Hwak' |
Definition at line 1265 of file HsPhoneEvent.h.
| #define UPDataSize 160 |
maximum size of the data sent from this message
Definition at line 1279 of file HsPhoneEvent.h.
| #define UPHeaderEscapeSeq "//" |
start sequence of the header
Definition at line 1273 of file HsPhoneEvent.h.
| #define UPTextHeader "//UP" |
beginning of an UP header
Definition at line 1274 of file HsPhoneEvent.h.
| #define UPTextHeaderLength 4 |
length of the header
Definition at line 1275 of file HsPhoneEvent.h.
| #define WAPMsgLength 160 |
Definition at line 1250 of file HsPhoneEvent.h.
| #define WAPMsgSize (WAPMsgLength + 1) |
Definition at line 1251 of file HsPhoneEvent.h.
| #define WAPNotificationTypeVersion 3 |
Structure passed to the callbacks registered for WAP notifications
Definition at line 1414 of file HsPhoneEvent.h.
| #define WUFieldDelimiter ';' |
wakeup message fields are separated by a semi-colon
Definition at line 1263 of file HsPhoneEvent.h.
| #define WUHeaderEscapeSeq "//" |
start sequence of the header
Definition at line 1259 of file HsPhoneEvent.h.
| #define WUTextHeader "//WU" |
beginning of an wakeup header
Definition at line 1260 of file HsPhoneEvent.h.
| #define WUTextHeaderLength 4 |
length of the header
Definition at line 1261 of file HsPhoneEvent.h.
| typedef Err(* ) ContinuePowerOnOffCallback(UInt16 refNum) |
Definition at line 821 of file HsPhoneEvent.h.
| typedef struct PhnEventType * PhnEventPtr |
| typedef struct PhnOnexMipRRQType * PhnOnexMipRRQPtr |
| typedef char PhnPassword[maxPasswordLen+2] |
Definition at line 865 of file HsPhoneEvent.h.
| typedef struct PhnSATEventHeader PhnSATEventHeader |
Definition at line 987 of file HsPhoneEvent.h.
| typedef UInt8 PhnSMSClass |
SMS Class types
Definition at line 706 of file HsPhoneEvent.h.
| typedef UInt8 PhnSMSType |
SMS Replacement types
Definition at line 688 of file HsPhoneEvent.h.
| typedef UInt16 PhnWAPPushAppId |
Definition at line 1409 of file HsPhoneEvent.h.
| typedef UInt8 PhnWAPPushContent |
Definition at line 1372 of file HsPhoneEvent.h.
| typedef struct UPNotificationEventType UPNotificationEventType |
Definition at line 1352 of file HsPhoneEvent.h.
| typedef struct WAPNotificationEventType WAPNotificationEventType |
Definition at line 1434 of file HsPhoneEvent.h.
| typedef struct WUNotificationEventType WUNotificationEventType |
Definition at line 1318 of file HsPhoneEvent.h.
| enum PhnDataChannelType |
| phnDataAvailable | |
| phnDataNotAvailable | Used by apps that need to know when they can use the data channel |
Definition at line 1208 of file HsPhoneEvent.h.
01209 { 01210 phnDataAvailable, /**< */ 01211 phnDataNotAvailable /**< Used by apps that need to know when they can use the data channel */ 01212 }
| enum PhnEventCode |
PhnEventCode is unique identifier for notifications between the Phone Library and applications. It is used in the eventType field in the header of notification events (PhnEventType).
Definition at line 117 of file HsPhoneEvent.h.
00118 { 00119 phnEvtCardInsertion, /**< 0x0000 < NOT USED. OBSOLETE */ 00120 00121 /** Network Registration has changed. 00122 * 00123 * The Phone Library is responsible for registering the device to 00124 * the carrier network, including handling roaming and losses of service. 00125 * This notification occurs when the network registration state has changed. 00126 * See PhnRegistrationStatus for possible state values. 00127 * 00128 * This notification will be universally broadcast to applications 00129 * registered for any service. 00130 */ 00131 phnEvtRegistration, /**< 0x0001 < Phone able to find service */ 00132 00133 /** Error detected 00134 * 00135 * This notification occurs on various error scenarios in the Phone Library. 00136 * These may occur when unexpected errors are reported from the radio, or when 00137 * an operation in progress has failed. 00138 * 00139 * This notification is universally broadcast to applications in the 00140 * service area where the error was detected (e.g. Voice, SMS, ...). 00141 */ 00142 phnEvtError, /**< 0x0002 < indicator of something important happens to the phone that needs to bring up alert */ 00143 00144 /** phone-related keypress has occured on device 00145 * 00146 * This notification occurs when the user presses a phone-related key on the device. 00147 * Currently the only supported key is the headset button that can be used for 00148 * basic call control. In general, buttons available will be device dependent. 00149 * 00150 * This notification is exclusively broadcast to all applications registered for the 00151 * Voice Service. 00152 */ 00153 phnEvtKeyPress, /**< 0x0003 < Headset button pressed. */ 00154 00155 /** change in power state of radio 00156 * 00157 * This notification occurs when the power state of the radio is changing. Applications 00158 * may want to change their state, and take action based on the expected availability 00159 * of the radio. 00160 * 00161 * This notification is universally broadcast to all registered applications. 00162 */ 00163 phnEvtPower, /**< 0x0004 */ 00164 00165 /** Password Dialog Control 00166 * 00167 * This notification helps an application control the entry of a PIN on a 00168 * device that is locked. 00169 * 00170 * This notification is exclusively broadcast to all registered applications. 00171 * Application that acknowledges the notification is presumed to own handling 00172 * the password situation. 00173 */ 00174 phnEvtPassword, /**< 0x0005 */ 00175 00176 /** outgoing call progress dialog 00177 * 00178 * This notification is sent to help applications display the progress of an 00179 * oubound call operation. 00180 * 00181 * This notification is exclusively broadcast to all registered applications. 00182 * Application that acknowledges the notification is presumed to be the only one 00183 * to take any action on the outgoing call. 00184 */ 00185 phnEvtProgress, /**< 0x0006 */ 00186 00187 /** indication of various changes of state in Phone Library 00188 * 00189 * This notification is sent on various changes of state in the Phone Library. 00190 * Most of these are related to activation and registration with the carrier 00191 * network. Applications that display gauges with state info will often need 00192 * to be updated after this notification. 00193 * 00194 * Indications are often used to direct GUI interactions in applications 00195 * that interact with the user. For example, the Network Search notification 00196 * might cause an app to put up a special Network Search dialog. 00197 * 00198 * See PhnIndicationKind for list of available indications. 00199 * 00200 * The broadcast rules for indications vary depending on the type of indication. 00201 */ 00202 phnEvtIndication, /**< 0x0007 */ 00203 00204 /** incoming call received 00205 * 00206 * This notification is exclusively broadcast to applications registered for 00207 * the Voice Service. First application to acknowledge the notification will 00208 * be presumed to control the call. Normally application would answer the call, 00209 * or forward it to another destination. 00210 * 00211 */ 00212 phnEvtConnectInd, /**< 0x0008 */ 00213 00214 /** call has connected 00215 * 00216 * Despite the name, this event is used BOTH when a call goes into 00217 * connected state (e.g. is answered), and when a call joins a conference. 00218 * 00219 * This notification is exclusively broadcast to applications registered for 00220 * the Voice Service. First application to acknowledge the notification will 00221 * be presumed to control the call or conference. 00222 */ 00223 phnEvtConnectConf, /**< 0x0009 */ 00224 00225 /** Number/name of call has changed 00226 * 00227 * This notification is universally broadcast to all applications registered for 00228 * the Voice Service. 00229 */ 00230 phnEvtSubscriber, /**< 0x000A */ 00231 00232 /** call has disconnected 00233 * 00234 * This notification occurs when the remote party of an active voice call 00235 * disconnects. Note that if the call is in conference (or 3-way calling) mode, then 00236 * a different phnEvtDisconnectConf notification will be sent instead (see below). 00237 * 00238 * This notification is universally broadcast to all applications registered for 00239 * the Voice or Data Services. 00240 */ 00241 phnEvtDisconnectInd, /**< 0x000B */ 00242 00243 /** call in conference (or 3-way calling) mode has disconnected 00244 * 00245 * This notification occurs when a conference call is in progress, and one of the 00246 * remote parties disconnects. 00247 * 00248 * This notification is universally broadcast to all applications registered for 00249 * the Voice Service. 00250 */ 00251 phnEvtDisconnectConf, /**< 0x000C An ACK for a disconnection command on a specific connection ID is received */ 00252 00253 /** Outbound call attempt failed because remote party (or network) reported busy 00254 * 00255 * This notification is universally broadcast to all applications registered for 00256 * the Voice Service. 00257 */ 00258 phnEvtBusy, /**< 0x000D */ 00259 00260 /** Change in Call Status; Application may need to update its state 00261 * 00262 * This notification is sent on various changes in call state in the Phone Library. 00263 * An application receiving this notification should poll for the connection status 00264 * of any calls of interest, and update its own state as needed. 00265 * 00266 * This notification is universally broadcast to all applications registered 00267 * for the Voice Service. 00268 *********************************************************************/ 00269 phnEvtUpdate, /**< 0x000E */ 00270 00271 /** 3-way call mode 00272 * 00273 * This notification occurs when a call goes into conferrence (or 3-way calling) mode. 00274 * 00275 * This notification is universally broadcast to all applications registered 00276 * for the Voice Service. 00277 */ 00278 phnEvtConference, /**< 0x000F */ 00279 00280 /** Incoming VoiceMail Message 00281 * 00282 * This notification occurs when the Phone Library detects that there are 00283 * pending VoiceMail messages available. 00284 * 00285 * This notification is universally broadcast to all applications registered 00286 * for the Voice Service. 00287 */ 00288 phnEvtVoiceMail, /**< 0x0010 */ 00289 00290 /** Incoming SMS message received 00291 * 00292 * This notification occurs when the Phone Library receives an 00293 * incoming SMS (Simple Message Service) message. 00294 * 00295 * This notification will be exclusively broadcast to applications 00296 * registered for the SMS service. The Application that acknowledges 00297 * the notification is assumed to own the message, and should take 00298 * any appropriate actions. 00299 */ 00300 phnEvtMessageInd, /**< 0x0011 */ 00301 00302 /** Incoming segment of SMS Message received 00303 * 00304 * This notification occurs when the Phone Library receives a segment 00305 * of a multi-segment SMS (Simple Message Service) message. Single 00306 * segment SMS messages will generate a MessageInd notification (see 00307 * above). 00308 * 00309 * This notification will be exclusively broadcast to applications 00310 * registered for the SMS service. The Application that acknowledges 00311 * the notification is assumed to own the segment, and should take 00312 * any appropriate actions. 00313 */ 00314 phnEvtSegmentInd, /**< 0x0012 */ 00315 00316 /** Status of outgoing SMS message has changed 00317 * 00318 * This notification occurs when the status of a particular SMS 00319 * message has changed. For example, an SMS message might move from 00320 * the pending queue to the sent queue after being successfully 00321 * delivered. 00322 * 00323 * This notification will be sent directly to the application that 00324 * created the message, and is NOT broadcast based on app registrations. 00325 */ 00326 phnEvtMessageStat, /**< 0x0013 */ 00327 00328 /** SMS message deleted from local DB on device 00329 * 00330 * This notification occurs when an SMS message is deleted from the 00331 * local Database on the device. 00332 * 00333 * This notification will be sent directly to the application that 00334 * created the message, and is NOT broadcast based on app registrations. 00335 */ 00336 phnEvtMessageDel, /**< 0x0014 */ 00337 00338 /** SIM Contains SMS Messages 00339 * 00340 * This notification indicates that the SIM (Subscriber Information 00341 * Module) on a GSM phone contains SMS (Simple Messaging Service) 00342 * messages. This is not an indication of new messages, just that 00343 * messages are stored. This notification is typically sent during 00344 * Phone Library activation. In many cases, the application may want 00345 * to move the SMS messages to a local DB on the device, freeing memory 00346 * for future incoming messages. 00347 * 00348 * This notification will use exclusive broadcast to applications 00349 * registered for the SMS service. The application that acknowledges 00350 * the notification is responsible for taking any action on moving 00351 * the SMS messages on the SIM (if desired). 00352 */ 00353 phnEvtMessageMoved, /**< 0x0015 */ 00354 00355 /** SIM Application Toolkit (SAT) event 00356 * 00357 * The SIM Application Toolkit allows for simple applications that 00358 * can be placed on the SIM (Subscriber Identity Module) in a GSM 00359 * phone. This notification will be sent when a SAT application is 00360 * requesting input/output to/from the user. 00361 * 00362 * This notification will use exclusive broadcast to applications 00363 * registered for the SIM Toolkit Service. The Application that first 00364 * acknowedges the notification will be presumed to own the SAT session, 00365 * and should handle needed user dialog as appropriate. 00366 */ 00367 phnEvtSATNotification, /**< 0x0016 */ 00368 00369 /** USSD input/output requested from network 00370 * 00371 * USSD (Unstructured Supplementary Services Data) is a supplementary 00372 * service to GSM networks that allows simple text dialogs 00373 * with applications based in the network. This notification 00374 * is sent when the network is requesting USSD input/output to/from the user. 00375 * (see +CUSD event in radio documentation for more details) 00376 * 00377 * This notification will use exclusive broadcast to applications 00378 * registered for the Voice Service. The Application that first 00379 * acknowledges the notification will be presumed to own the USSD session. 00380 * Typically, that app will want to display any USSD message to the user, 00381 * and handle any response from the user back to the network. 00382 */ 00383 phnEvtUSSDInd, /**< 0x0017 */ 00384 00385 /** Phone Equipment state has changed 00386 * 00387 * On communicator devices there are pieces of equipment that directly 00388 * impact how the radio is used. Examples of equipment include headset 00389 * jacks, car kits, lids, etc. The equipment modes available will vary 00390 * with the model of communicator being used. This notification will be 00391 * sent when ever the Phone Library detects that an available equipment 00392 * mode has changed. See the type PhnEquipmentMode for the available 00393 * set of mode values. 00394 * 00395 * This notification will be universally broadcast to all applications 00396 * registered for any service. 00397 */ 00398 phnEvtPhoneEquipmentMode, /**< 0x0018 */ 00399 00400 /** GPRS Attach Registration has changed. (GSM/GPRS systems only) 00401 * 00402 * GPRS (General Packet Radio Services) is an extension to the GSM 00403 * wireless network that provides higher speed, always on data connections. 00404 * The radio must attach to the GPRS network before any GPRS sessions 00405 * can be established. This notification will be sent when ever the 00406 * status of the GPRS attach registration changes. See type 00407 * PhnRegistrationStatus for available registration states. 00408 * 00409 * This notification will be universally broadcast to applications 00410 * registered for any service. 00411 */ 00412 phnEvtGPRSRegistration, /**< 0x0019 */ 00413 00414 /** incoming MMS message available 00415 * 00416 * This notification will be sent when the Phone Library receives an 00417 * incoming MMS (Multi-media Message Service) message. 00418 * 00419 * This notification will use exclusive broadcast to applications registered 00420 * for the MMS service. Application that first acknowledges the notification 00421 * will be presumed to own the message. Typically, that app will want 00422 * to notify the user that there is a message available, and move the 00423 * message into a system DB, freeing memory for future messages. 00424 */ 00425 phnEvtMMSInd, /**< 0x001A */ 00426 00427 /************************************************************ 00428 * CDMA Events 00429 *************************************************************/ 00430 00431 00432 /** SMS Memory Full 00433 * 00434 * This notification indicates that memory for SMS messages is 00435 * currently full, and no new SMS messages can be received until 00436 * some memory is freed. A phnEvtMemoryOK notification will be sent 00437 * when memory becomes available. 00438 * 00439 * CURRENTLY USED BY CDMA PHONE LIBRARY ONLY 00440 */ 00441 phnEvtMemoryFull, /**< 0x001B */ 00442 00443 /** SMS Memory no longer full 00444 * 00445 * This notification indicates that memory for SMS messages is 00446 * no longer full, and new SMS messages can be received. 00447 * 00448 * CURRENTLY USED BY CDMA PHONE LIBRARY ONLY 00449 */ 00450 phnEvtMemoryOK, /**< 0x001C - < Memory is not full anymore, can receive messages Description */ 00451 00452 /** WAP Message received via SMS (WAP in IS-637 standard) 00453 * 00454 * NOT CURRENTLY USED (WAP notifications use standard Palm notifications) 00455 */ 00456 phnEvtWAPInd, /**< 0x001D */ 00457 00458 /** Radio Debug Info 00459 * 00460 * Periodically sent from Phone Library to Activation App when 00461 * in debug mode. 00462 * 00463 * CURRENTLY USED BY CDMA PHONE LIBRARY ONLY 00464 */ 00465 phnEvtDebugReport, /**< 0x001E */ 00466 00467 /** System Selection mode has changed 00468 * 00469 * Radio mode has changed (e.g. to PCS mode) 00470 * 00471 * CURRENTLY USED BY CDMA PHONE LIBRARY ONLY 00472 */ 00473 phnEvtSSModeChanged, /**< 0x001F */ 00474 00475 /** Position Info has changed 00476 * 00477 * indication of change in physical location of device. This may 00478 * be determined by GPS, network triangulation (AFLT), or some other 00479 * technique. 00480 * 00481 * \TODO - rename this event & some of its data structures to be cleaner. 00482 * 00483 * CURRENTLY USED BY CDMA PHONE LIBRARY ONLY 00484 */ 00485 phnEvtPDDataChanged, /**< 0x0020 */ 00486 00487 /** 1XRTT Status has changed 00488 * 00489 * 1XRTT is a high speed data protocol used in CDMA radios. This 00490 * notification indicates that the status of the 1XRTT connection 00491 * has changed. 00492 * 00493 * CURRENTLY USED BY CDMA PHONE LIBRARY ONLY 00494 */ 00495 phnEvtOneXStatus, /**< 0x0021 */ 00496 00497 /** Mobile IP connection failed 00498 * 00499 * Mobile IP is a flavor of the TCP/IP protocol for use on mobile 00500 * devices. It allows applications to use a single IP address while 00501 * in motion. This notification occurs when a Mobile IP session 00502 * fails to be established. 00503 * 00504 * CURRENTLY USED BY CDMA PHONE LIBRARY ONLY 00505 */ 00506 phnEvtMIPFailed, /**< 0x0022 */ 00507 00508 /** IOTA Status has changed 00509 * 00510 * Internet Over The Air (IOTA) is a protocol for a network to 00511 * update the radio using an internet connection (as opposed to 00512 * Over The Air (OTA)). This notification occurs as an IOTA 00513 * session changes (e.g. is established, committed, ended, etc). 00514 * 00515 * CURRENTLY GENERATED BY CDMA PHONE LIBRARY ONLY 00516 */ 00517 phnEvtIOTAStatus, /**< 0x0023 */ 00518 00519 /** Data Channel availability has changed 00520 * 00521 * This notification occurs if there is a change in the ability 00522 * for an application to send/receive data using the radio. For 00523 * example on Class B radios, data is not available when a voice 00524 * call is in progress. 00525 * 00526 * \TODO - this notification should be generated by GSM Phone Library too. 00527 * 00528 * CURRENTLY GENERATED BY CDMA PHONE LIBRARY ONLY 00529 */ 00530 phnEvtDataChannel, /**< 0x0024 */ 00531 00532 /** Mobile IP Registration successful 00533 * 00534 * Mobile IP is a flavor of the TCP/IP protocol for use on mobile 00535 * devices. It allows applications to use a single IP address while 00536 * in motion. This notification occurs when a Mobile IP session 00537 * is successfully established. The notification phnEvtMIPFailed 00538 * will occur if the session fails. 00539 * 00540 * CURRENTLY GENERATED BY CDMA PHONE LIBRARY ONLY 00541 */ 00542 phnEvtOneXMipRRQInd, /**< 0x0025 */ 00543 00544 /** 1XRTT Session has failed (mid-session) 00545 * 00546 * 1XRTT is a high speed data protocol used in CDMA radios. This 00547 * notification indicates that the 1XRTT session has failed, and 00548 * is not available. Note that 1XRTT session may be left in Dormant 00549 * state. 00550 * 00551 * CURRENTLY GENERATED BY CDMA PHONE LIBRARY ONLY 00552 */ 00553 phnEvtOneXDataFail, /**< 0x0026 */ 00554 00555 /** Start Dialing of Outbound Call 00556 * 00557 * This notification is sent when an outbound call begins dialing before 00558 * the call is connected. This notification is universally broadcast to 00559 * all applications registered for the Voice service. Notification 00560 * uses same notification data as Connect indication. 00561 */ 00562 phnEvtStartDial, /**< 0x0027 */ 00563 00564 /** Start of incoming call 00565 * 00566 * This notification is sent when an incoming call if first detected. 00567 * This notification is used to perform special pre-call processing 00568 * like turning off of MMS playback before a call. Any processing on 00569 * this notification must be very quick (less than a few hundred miliseconds) 00570 * as it could potentially delay an incoming call from being answered. 00571 * 00572 * APPLICATIONS MUST NOT ANSWER THE CALL OR DO ANY CALL CONTROL BASED 00573 * ON THIS NOTIFICATION. A separate phnEvtConnectInd notification will 00574 * be follow for this purpose. The phnEvtConnectInd notification is normally 00575 * processed by the Phone App, and uses exclusive broadcast. Thus it may 00576 * not be received by all applications. The phnEvtStartIncomingCall 00577 * notification is sent to all applications registered for Voice Service 00578 * using Universal Broadcast. The acknowledgement flag is NOT used. 00579 */ 00580 phnEvtStartIncomingCall, /**< 0x0028 */ 00581 00582 /** Alerting/Preconnected of Outbound Call 00583 * 00584 * This notification is sent when an outbound call is alerting or 00585 * preconnected. This notification is universally broadcast to 00586 * all applications registered for the Voice service. Notification 00587 * uses same notification data as Connect indication. 00588 */ 00589 phnEvtAlertingPreConnected, /**< 0x0029 */ 00590 00591 /** Alerting of Outbound Call (NOT USED, for future implementation) 00592 * 00593 * NOT USED 00594 * This notification is sent when an outbound call is alerting. 00595 * This notification is universally broadcast to 00596 * all applications registered for the Voice service. Notification 00597 * uses same notification data as Connect indication. 00598 */ 00599 phnEvtAlerting, /**< 0x002A */ 00600 00601 /** Preconnected of Outbound Call (NOT USED, for future implementation) 00602 * 00603 * NOT USED 00604 * This notification is sent when an outbound call is preconnected. 00605 * This notification is universally broadcast to 00606 * all applications registered for the Voice service. Notification 00607 * uses same notification data as Connect indication. 00608 */ 00609 phnEvtPreConnected, /**< 0x002B */ 00610 00611 /** Data session status change 00612 * This should replace the OneXStatus, as this will encompass more info 00613 * than OneXStatus 00614 */ 00615 phnEvtDataSessionStatus, /**< 0x002C */ 00616 00617 /** Data session disconnected 00618 * This is sent up when the data call is disconnected. 00619 * We can't use the phnEvtDisconnectInd because the structure uses the 00620 * Err class. 00621 */ 00622 phnEvtDataSessionDisconnected, /**< 0x002D */ 00623 00624 /** Returns the network time and DST obtained from network to date time panel 00625 */ 00626 00627 phnEvtNetworkTime, /**< 0x002E */ 00628 00629 kMaxPhnEvtSupported /**< Must be at last position*/ 00630 } PhnEventCode;
| enum PhnIndicationKind |
unique identifier for Indication notification. This value will be contained in PhnEventType notification events of phnEvtIndication type.
Definition at line 95 of file HsPhoneEvent.h.
00095 { 00096 indicationSIMReady, /**< */ 00097 indicationSIMMessages, /**< */ 00098 indicationNetworkSearch, /**< to display Network search banner */ 00099 indicationPasswordAccepted, /**< */ 00100 indicationNetworkAvailable, /**< */ 00101 indicationStartingRadio, /**< to update UI from radio being off */ 00102 indicationPoweringOffRadio, /**< notify app that the radio is turning off. */ 00103 indicationResettingRadio, /**< tell the app that the radio is resetting. */ 00104 indicationAuthFailure, /**< notify app that network authentication failed. */ 00105 indicationSIMChanged, /**< sent when the GSM library detects that the IMSI value has changed */ 00106 indicationInitComplete, /**< sent when the GSM library is done with it initialization when the radio is powered on */ 00107 indicationOtaspMsg /**< sent otasp msg from network */ 00108 } PhnIndicationKind;
| enum PhnMiscDbgUpdateKind |
Definition at line 1168 of file HsPhoneEvent.h.
01169 { 01170 eDbgUpdateNone, /**< */ 01171 eDbgUpdateYes, /**< */ 01172 eDbgUpdateQuit /**< */ 01173 }
| enum PhnModuleButtonType |
Phone buttons
| phnButtonHeadset | |
| phnButtonRedial | |
| phnButtonAnswerCall | |
| phnButtonRejectCall | |
| phnButtonIgnoreCall | |
| phnButtonHoldCall | |
| phnButtonConferenceCall | |
| phnButtonLast |
Definition at line 780 of file HsPhoneEvent.h.
00780 { 00781 phnButtonHeadset, /**< */ 00782 phnButtonRedial, /**< */ 00783 phnButtonAnswerCall, /**< */ 00784 phnButtonRejectCall, /**< */ 00785 phnButtonIgnoreCall, /**< */ 00786 phnButtonHoldCall, /**< */ 00787 phnButtonConferenceCall, /**< */ 00788 phnButtonLast /**< */ 00789 } PhnModuleButtonType;
| enum PhnMsgIDType |
| kMsgIdReserved | |
| kMsgIdDeliverMT | |
| kMsgIdSubmitMO | |
| kMsgIdcancelMO | |
| kMsgIdDeliveryMTAck | |
| kMsgIdUserAck |
Definition at line 1191 of file HsPhoneEvent.h.
01192 { 01193 kMsgIdReserved, /**< */ 01194 kMsgIdDeliverMT, /**< */ 01195 kMsgIdSubmitMO, /**< */ 01196 kMsgIdcancelMO, /**< */ 01197 kMsgIdDeliveryMTAck, /**< */ 01198 kMsgIdUserAck /**< */ 01199 }
| enum PhnOpenDialogType |
Definition at line 896 of file HsPhoneEvent.h.
00896 { 00897 kDialogSetBarring, /**< */ 00898 kDialogGetBarring, /**< */ 00899 kDialogSetForwarding, /**< */ 00900 kDialogGetForwarding, /**< */ 00901 kDialogSetCallWaiting, /**< */ 00902 kDialogGetCallWaiting, /**< */ 00903 kDialogGetOperatorList, /**< */ 00904 kDialogSetOperator, /**< */ 00905 kDialogOperatorSelection, /**< */ 00906 kDialogImmediateSend, /**< */ 00907 kDialogDeferredSend, /**< */ 00908 kDialogSendUSSD /**< */ 00909 } PhnOpenDialogType;
| enum PhnProgressType |
Definition at line 882 of file HsPhoneEvent.h.
00882 { 00883 kOpenDialog, /**< */ 00884 kCloseDialog, /**< */ 00885 kSetText, /**< */ 00886 kSetRecipient, /**< */ 00887 kShowSegment /**< */ 00888 } PhnProgressType;
| enum PhnSMSClassEnum |
Definition at line 707 of file HsPhoneEvent.h.
00708 { 00709 classUnknown = 0, /**< */ 00710 class0, /**< immediate display */ 00711 class1, /**< */ 00712 class2, /**< */ 00713 class3 /**< */ 00714 } PhnSMSClassEnum;
| enum PhnSMSTypeEnum |
Definition at line 689 of file HsPhoneEvent.h.
00690 { 00691 defaultType = 0, 00692 discardType0 = 0x40, /**< Type 0 messages should be discarded. */ 00693 replaceType1 = 0x41, /**< Replace Short Message Type 1. */ 00694 replaceType2 = 0x42, /**< Replace Short Message Type 2. */ 00695 replaceType3 = 0x43, /**< Replace Short Message Type 3. */ 00696 replaceType4 = 0x44, /**< Replace Short Message Type 4. */ 00697 replaceType5 = 0x45, /**< Replace Short Message Type 5. */ 00698 replaceType6 = 0x46, /**< Replace Short Message Type 6. */ 00699 replaceType7 = 0x47 /**< Replace Short Message Type 7. */ 00700 00701 } PhnSMSTypeEnum;
| enum PhnWAPPushAppIdType |
WAP push message - message type http://www.wapforum.org/wina/push-app-id.htm
Definition at line 1377 of file HsPhoneEvent.h.
01377 { 01378 //URN //Number // Description 01379 kWAPAnyApp = 0x00, /**< Any Application */ 01380 kWAPPushSIA = 0x01, /**< WAP Push SIA */ 01381 kWAPWmlUa = 0x02, /**< WML User Agent */ 01382 kWAPWtaUa = 0x03, /**< WTA User Agent */ 01383 kWAPMmsUa = 0x04, /**< This ID will used for application dispatching to MMS User Agent in the handling of MMS notfication using WAP Push. See WAP-206-MMSCTR for more detail. */ 01384 kWAPPushSyncml = 0x05, /**< SyncML PUSH Application ID: used to push a SyncML Alert from a SyncML server side. The SyncML Alert is an indication for starting a SyncML session e.g., for data synchronization. Requested by the WAP WAG Synchronisation Drafting Committee. */ 01385 kWAPLocUa = 0x06, /**< This ID is used for application dispatching to Location User Agent in the handling of Location Invocation document. See WAP-257-LOCPROT for details. Requested by the WAP WAG Location Drafting Committee. */ 01386 kWAPSyncmlDm = 0x07, /**< This ID is used for SyncML Device Management. Requested by the SyncML Device Management Expert Group. */ 01387 kWAPDrmUa = 0x08, /**< This ID is used for DRM User Agent. Requested by the WAP WAG Download DC. */ 01388 kWAPEmnUa = 0x09, /**< This ID is used for Email Notification (EMN) User Agent. Requested by the WAP WAG PUSH DC. */ 01389 kWAPWvUa = 0x0A, /**< This ID is used for Wireless Village (EMN) User Agent. Requested by Wireless Village. */ 01390 01391 // Registered Values ----------------------------- 01392 kWAPMsLocalcontentUa = 0x8000, /**< An application to receive pages to be stored and access locally. These are not wta channels. Usually the pages will be downloaded as multi-part mime. */ 01393 kWAPMsIMclientUa = 0x8001, /**< An application which will act as an instant messaging client on a phone. */ 01394 kWAPdocomoImodeMailUa = 0x8002, /**< Used to identify the i-mode mail application user agent on a mobile device. */ 01395 kWAPdocomoImodeMrUa = 0x8003, /**< Used to identify the i-mode message request application user agent on a mobile device. */ 01396 kWAPdocomoImodeMfUa = 0x8004, /**< Used to identify the i-mode message free application user agent on a mobile device. */ 01397 kWAPMotorolaLocationUa = 0x8005, /**< An application that receives message notifications from the location server. */ 01398 kWAPMotorolaNowUa = 0x8006, /**< An application that presents personalized information to the user. */ 01399 kWAPMotorolaOtaprovUa = 0x8007, /**< An application that receives provisioning messages from the server. */ 01400 kWAPMotorolaBrowserUa = 0x8008, /**< A web browsing application. */ 01401 kWAPMotorolaSplashUa = 0x8009, /**< An application that receives splash screen content from the server. */ 01402 kWAPUnused = 0x800A, /**< */ 01403 kWAPNaiMvswCommand = 0x800B, /**< Used by administrators to issue commands to individual devices. */ 01404 // unused 0x800C through 0x800F /**< */ 01405 kWAPopenwaveIotaUa = 0x8010 /**< Used for application dispatching to the IP-based OTA Provisioning Service Agent in the handling of IOTA notfications using WAP Push. */ 01406 } PhnWAPPushAppIdType;
WAP push message - message content type
Definition at line 1361 of file HsPhoneEvent.h.
01361 { 01362 kWAPContentTypeUnknown = 0, /**< */ 01363 kWAPContentTypeIOTA, /**< */ 01364 kWAPContentTypeMMS, /**< */ 01365 kWAPContentTypeMMSText, /**< */ 01366 kWAPContentTypeServiceLoad, /**< */ 01367 kWAPContentTypeServiceLoadText, /**< */ 01368 kWAPContentTypeServiceIndicator, /**< */ 01369 kWAPContentTypeServiceIndicatorText /**< */ 01370 } PhnWAPPushContentType;
| Top | Palm Developer Network © 2004-2008, Palm, Inc. All rights reserved. Generated on Fri Jun 13 10:07:17 2008 for Palm API Guide |