(Online version only)
|
API Guide Home (Online version only) |
|
NOTES: All implementations of the Handspring Phone Library support a common API. This API is broken up into various categories for easier management. This file defines the SMS category. These API calls are used to interact with the wireless network.
Definition in file HsPhoneNetworkTypes.h.
Include dependency graph for HsPhoneNetworkTypes.h:
Go to the source code of this file.
| #define isValidDataService | ( | x | ) | (x < phnDataServiceLast) |
Definition at line 601 of file HsPhoneNetworkTypes.h.
| #define isValidGSMDialClirStatus | ( | d | ) | ((d >= gsmDialCLIRNotProvisioned) && (d <= gsmDialCLIRTemporaryAllowed)) |
Definition at line 79 of file HsPhoneNetworkTypes.h.
| #define isValidGSMRegistrationMode | ( | r | ) | (r <= gsmRegModeManualAutomatic) |
Definition at line 177 of file HsPhoneNetworkTypes.h.
| #define isValidPacketDataEndStatus | ( | x | ) | (x < phnPacketDataEndStatusLast) |
Definition at line 623 of file HsPhoneNetworkTypes.h.
| #define isValidPhnBandSelection | ( | f | ) | (f <= band1900_850) |
Definition at line 507 of file HsPhoneNetworkTypes.h.
| #define isValidPhnBarFacilityType | ( | b | ) | (b <= phnBarAll) |
Definition at line 228 of file HsPhoneNetworkTypes.h.
| #define isValidPhnCLIRStatus | ( | s | ) | ((s >= clirNotProvisioned) && (s <= clirTemporaryAllowed)) |
Definition at line 67 of file HsPhoneNetworkTypes.h.
| #define isValidPhnForwardModeType | ( | f | ) | (f <= phnForwardModeErasure) |
Definition at line 268 of file HsPhoneNetworkTypes.h.
| #define isValidPhnForwardType | ( | f | ) | (f < phnForwardLast) |
Definition at line 209 of file HsPhoneNetworkTypes.h.
| #define isValidPhnMIPSessionType | ( | m | ) | (m <= phnMIPSession) |
Definition at line 569 of file HsPhoneNetworkTypes.h.
| #define isValidPhnMsgBoxType | ( | n | ) | (n < PhnMsgBoxTypeMAX) |
Definition at line 112 of file HsPhoneNetworkTypes.h.
| #define isValidPhnOneXProtRevType | ( | p | ) | (p <= phnOneXStatusPRev7) |
Definition at line 541 of file HsPhoneNetworkTypes.h.
| #define isValidPhnOperatorStatus | ( | s | ) | ((s >= phnOpUnknown) && (s <= phnOpForbidden)) |
Definition at line 91 of file HsPhoneNetworkTypes.h.
| #define isValidPhnPacketDataSessionType | ( | p | ) | (p <= phnPacketDataSessionActive) |
Definition at line 555 of file HsPhoneNetworkTypes.h.
| #define isValidPhnRegistrationStatus | ( | r | ) | (r <= registrationRoaming) |
Definition at line 253 of file HsPhoneNetworkTypes.h.
| #define isValidRoamMode | ( | x | ) | (x < phnRoamPrefLast) |
Definition at line 522 of file HsPhoneNetworkTypes.h.
| #define kMaxImeiLen 24 |
Definition at line 441 of file HsPhoneNetworkTypes.h.
| #define kMaxMMISequenceLen 64 |
Definition at line 356 of file HsPhoneNetworkTypes.h.
| #define kMaxPhoneNumberLen 16 |
workaround for differing header files in sdk-3.5 and sdk-internal Max length of phone number
Definition at line 38 of file HsPhoneNetworkTypes.h.
| #define MAX_LONGOPERATORNAME_LENGTH 24 |
Operator info
Definition at line 144 of file HsPhoneNetworkTypes.h.
| #define MAX_SHORTOPERATORNAME_LENGTH 16 |
Definition at line 145 of file HsPhoneNetworkTypes.h.
| #define maxPasswordLen 8 |
Phone password/PIN maximum length
Definition at line 41 of file HsPhoneNetworkTypes.h.
| #define maxPasswordLenCDMA 4 |
Definition at line 42 of file HsPhoneNetworkTypes.h.
| #define minPasswordLen 4 |
Phone password/PIN minimum length
Definition at line 40 of file HsPhoneNetworkTypes.h.
| #define PhnDataSessionStateTypeMajorVersion 0x0001L |
Definition at line 625 of file HsPhoneNetworkTypes.h.
| #define PhnDataSessionStateTypeMinorVersion 0x0000L |
Definition at line 626 of file HsPhoneNetworkTypes.h.
| #define PhnDataSessionStateTypeVersion (((UInt32)PhnDataSessionStateTypeMajorVersion << 16) | PhnDataSessionStateTypeMinorVersion) |
Definition at line 627 of file HsPhoneNetworkTypes.h.
| #define phnEnhancedRoamIndMaxLength 40 |
Definition at line 44 of file HsPhoneNetworkTypes.h.
| typedef UInt8 PhnBandSelection |
Definition at line 506 of file HsPhoneNetworkTypes.h.
| typedef UInt8* PhnBarFacilityPtr |
Definition at line 227 of file HsPhoneNetworkTypes.h.
| typedef UInt8 PhnBarFacilityType |
Definition at line 226 of file HsPhoneNetworkTypes.h.
| typedef UInt8 PhnCallControlType |
Definition at line 342 of file HsPhoneNetworkTypes.h.
| typedef UInt16 PhnDataServiceType |
Definition at line 600 of file HsPhoneNetworkTypes.h.
| typedef UInt8 PhnForwardModeType |
Phone call forwarding mode
Definition at line 259 of file HsPhoneNetworkTypes.h.
| typedef UInt8 PhnForwardType |
Phone call forwarding reason set a type for this enumeration
Definition at line 196 of file HsPhoneNetworkTypes.h.
| typedef UInt8 PhnMIPSessionType |
Definition at line 568 of file HsPhoneNetworkTypes.h.
| typedef UInt8 PhnMMIActionCode |
Definition at line 284 of file HsPhoneNetworkTypes.h.
| typedef struct PhnMMIEntryType * PhnMMIEntryPtr |
| typedef struct PhnMMIResultType * PhnMMIResultPtr |
| typedef UInt8 PhnMMIServiceCode |
Definition at line 327 of file HsPhoneNetworkTypes.h.
| typedef UInt8 PhnMsgBoxPriorityType |
Definition at line 114 of file HsPhoneNetworkTypes.h.
| typedef UInt8 PhnMsgBoxType |
Definition at line 99 of file HsPhoneNetworkTypes.h.
| typedef UInt8 PhnOneXProtRevType |
Definition at line 540 of file HsPhoneNetworkTypes.h.
| typedef struct PhnOperatorListType* PhnOperatorListPtr |
| typedef UInt16 PhnPacketDataEndStatusType |
Definition at line 622 of file HsPhoneNetworkTypes.h.
| typedef UInt8 PhnPacketDataSessionType |
Definition at line 554 of file HsPhoneNetworkTypes.h.
| typedef struct PhnRoamPrefInfoType* PhnRoamPrefInfoPtr |
| typedef UInt8 PhnRoamPrefSelectionType |
Definition at line 521 of file HsPhoneNetworkTypes.h.
| typedef UInt8 PhnRoamStatus |
Possible roaming status' GSM devices only use first two set a type for this enumeration
Definition at line 183 of file HsPhoneNetworkTypes.h.
| enum _PhnBandSelection |
Definition at line 495 of file HsPhoneNetworkTypes.h.
00496 { 00497 bandGSM_EGSM = 0, 00498 band1800, 00499 band900_1800, 00500 band1900, 00501 bandAuto, 00502 band850, 00503 band1900_850 00504 } _PhnBandSelection;
| enum _PhnDataServiceType |
This defines the different data service types.
| phnDataServiceNone | |
| phnDataServiceCSD | |
| phnDataService1xRTT | |
| phnDataService1xEVDO | |
| phnDataServiceGPRS | |
| phnDataServiceEdge | |
| phnDataServiceLast |
Definition at line 589 of file HsPhoneNetworkTypes.h.
00590 { 00591 phnDataServiceNone, 00592 phnDataServiceCSD, 00593 phnDataService1xRTT, 00594 phnDataService1xEVDO, 00595 phnDataServiceGPRS, 00596 phnDataServiceEdge, 00597 phnDataServiceLast 00598 }
| enum _PhnMIPSessionType |
This is now deprecated. It is only implemented to maintain backwards compatibility Currently, the only user is NetMaster
Definition at line 562 of file HsPhoneNetworkTypes.h.
00563 { 00564 phnMIPSessionNone, /**< */ 00565 phnMIPSession /**< A Mobile IP session exists. */ 00566 }
| enum _PhnOneXProtRevType |
This is now deprecated. It is only implemented to maintain backwards compatibility Currently, the only user is NetMaster
Definition at line 530 of file HsPhoneNetworkTypes.h.
00531 { 00532 phnOneXStatusPRevNoSvc, /**< Service is not available. */ 00533 phnOneXStatusPRev1, /**< J-STD-008 service is in use. */ 00534 phnOneXStatusPRev3, /**< IS-95A service is in use. */ 00535 phnOneXStatusPRev4, /**< IS-95B service is in use. */ 00536 phnOneXStatusPRev6, /**< IS-2000 release 0 service is in use. */ 00537 phnOneXStatusPRev7 /**< IS-2000 release A service is in use. */ 00538 }
List of errors on why a data call was disconnected.
Definition at line 607 of file HsPhoneNetworkTypes.h.
00608 { 00609 phnPacketDataEndStatusUnknown, /**< Unknown end status */ 00610 phnPacketDataEndStatusNormal, /**< Normal */ 00611 phnPacketDataEndStatusReorder, /**< reoder */ 00612 phnPacketDataEndStatusRetry, /**< retry */ 00613 phnPacketDataEndStatusTimeout, /**< call */ 00614 phnPacketDataEndStatusIntercept, /**< Intercept */ 00615 phnPacketDataEndStatusReject, /**< Service Option rejected */ 00616 phnPacketDataEndStatusNoReason, /**< No reason given */ 00617 phnPacketDataEndStatusAuthFailed, /**< authentication failed */ 00618 phnPacketDataEndStatusDropped, /**< dropped call */ 00619 phnPacketDataEndStatusLast /**< place holder for last */ 00620 }
Describes the current packet data session state. Currently there are 3 states. Active, dormant, or none.
| phnPacketDataSessionNone | No packet data session exists. |
| phnPacketDataSessionDormant | Packet data session dormant |
| phnPacketDataSessionActive | Packet data session active |
Definition at line 547 of file HsPhoneNetworkTypes.h.
00548 { 00549 phnPacketDataSessionNone, /**< No packet data session exists. */ 00550 phnPacketDataSessionDormant, /**< Packet data session dormant */ 00551 phnPacketDataSessionActive /**< Packet data session active */ 00552 }
This defines the roaming mode of the radio.
| phnRoamPrefHomeOnly | Home network only (no roaming) |
| phnRoamPrefAny | Any network (roaming allowed) |
| phnRoamPrefRoamOnly | Roam network only (roaming only) |
| phnRoamPrefLast | end of list enum |
Definition at line 513 of file HsPhoneNetworkTypes.h.
00514 { 00515 phnRoamPrefHomeOnly, /**< Home network only (no roaming) */ 00516 phnRoamPrefAny, /**< Any network (roaming allowed) */ 00517 phnRoamPrefRoamOnly, /**< Roam network only (roaming only) */ 00518 phnRoamPrefLast /**< end of list enum */ 00519 }
| enum GSMCLIPStatus |
GSM CLIP Subscription Status
Definition at line 49 of file HsPhoneNetworkTypes.h.
00049 { 00050 gsmCLIPNotProvisioned, /**< */ 00051 gsmCLIPProvisioned, /**< */ 00052 gsmCLIPUnknown /**< */ 00053 } GSMCLIPStatus;
| enum GSMCLIRDisplayStatus |
GSM CLIR Display Status
| gsmCLIRSubscription | presentation indicator is used according to the subscription of the CLIR service |
| gsmCLIRInvocation | |
| gsmCLIRSuppression |
Definition at line 73 of file HsPhoneNetworkTypes.h.
00073 { 00074 gsmCLIRSubscription, /**< presentation indicator is used according to the subscription of the CLIR service */ 00075 gsmCLIRInvocation, /**< */ 00076 gsmCLIRSuppression /**< */ 00077 } GSMCLIRDisplayStatus;
| enum GSMRegistrationMode |
| gsmRegModeAutomatic | |
| gsmRegModeManual | |
| gsmRegModeDeregister | |
| gsmRegModeFormat | |
| gsmRegModeManualAutomatic |
Definition at line 169 of file HsPhoneNetworkTypes.h.
00169 { 00170 gsmRegModeAutomatic, /**< */ 00171 gsmRegModeManual, /**< */ 00172 gsmRegModeDeregister, /**< */ 00173 gsmRegModeFormat, /**< */ 00174 gsmRegModeManualAutomatic /**< */ 00175 } GSMRegistrationMode;
Phone call barring options
| phnBarOutNone | |
| phnBarOutAll | |
| phnBarOutInternational | |
| phnBarOutInternationalExceptHome | |
| phnBarInNone | |
| phnBarInAll | |
| phnBarInWhenRoaming | |
| phnBarAll |
Definition at line 214 of file HsPhoneNetworkTypes.h.
00214 { 00215 phnBarOutNone, /**< */ 00216 phnBarOutAll, /**< */ 00217 phnBarOutInternational, /**< */ 00218 phnBarOutInternationalExceptHome, /**< */ 00219 00220 phnBarInNone, /**< */ 00221 phnBarInAll, /**< */ 00222 phnBarInWhenRoaming, /**< */ 00223 phnBarAll /**< */ 00224 00225 } PhnBarFacilityTypeEnum;
Call Control Codes
| mmiControlReleaseAllHeld | |
| mmiControlReleaseAllActive | |
| mmiControlReleaseCallx | |
| mmiControlSwap | |
| mmiControlActivateCallx | |
| mmiControlConference | |
| mmiControlTransfer |
Definition at line 332 of file HsPhoneNetworkTypes.h.
00332 { 00333 mmiControlReleaseAllHeld = 0, /**< */ 00334 mmiControlReleaseAllActive, /**< */ 00335 mmiControlReleaseCallx, /**< */ 00336 mmiControlSwap, /**< */ 00337 mmiControlActivateCallx, /**< */ 00338 mmiControlConference, /**< */ 00339 mmiControlTransfer /**< */ 00340 }PhnCallControlTypeEnum;
| enum PhnCLIRStatus |
Definition at line 59 of file HsPhoneNetworkTypes.h.
00059 { 00060 clirNotProvisioned, /**< sent: restricted presentation of the calling line */ 00061 clirProvisioned, /**< not sent: don't restrict presentation of the calling line */ 00062 clirUnknown, /**< status not available */ 00063 clirTemporaryRestricted, /**< not sent, override allowed */ 00064 clirTemporaryAllowed /**< sent: override allowed */ 00065 } PhnCLIRStatus;
| enum PhnForwardEnum |
| phnForwardUnconditional | |
| phnForwardOnBusy | |
| phnForwardOnNoReplay | |
| phnForwardOnNotReachable | |
| phnForwardTelefax | |
| phnForwardData | |
| phnForwardCancelAll | |
| phnForwardConditionalAll | |
| phnForwardLast |
Definition at line 197 of file HsPhoneNetworkTypes.h.
00197 { 00198 phnForwardUnconditional, /**< */ 00199 phnForwardOnBusy, /**< */ 00200 phnForwardOnNoReplay, /**< */ 00201 phnForwardOnNotReachable, /**< */ 00202 phnForwardTelefax, /**< */ 00203 phnForwardData, /**< */ 00204 phnForwardCancelAll, /**< */ 00205 phnForwardConditionalAll, /**< */ 00206 phnForwardLast /**< */ 00207 } PhnForwardEnum;
| enum PhnForwardModeEnum |
| phnForwardModeDisable | |
| phnForwardModeEnable | |
| phnForwardModeInterrogate | |
| phnForwardModeRegistration | |
| phnForwardModeErasure |
Definition at line 260 of file HsPhoneNetworkTypes.h.
00260 { 00261 phnForwardModeDisable, /**< */ 00262 phnForwardModeEnable, /**< */ 00263 phnForwardModeInterrogate, /**< */ 00264 phnForwardModeRegistration, /**< */ 00265 phnForwardModeErasure /**< */ 00266 } PhnForwardModeEnum;
| enum PhnMMIActionCodeEnum |
MMI Action Code
| mmiActionNoAction | |
| mmiActionActivate | |
| mmiActionDeactivate | |
| mmiActionInterrogate | |
| mmiActionRegister | |
| mmiActionErasure | |
| mmiActionUnlock | |
| mmiActionHandspring |
Definition at line 272 of file HsPhoneNetworkTypes.h.
00273 { 00274 mmiActionNoAction = 0, /**< */ 00275 mmiActionActivate = 0x01, /**< */ 00276 mmiActionDeactivate = 0x02, /**< */ 00277 mmiActionInterrogate = 0x04, /**< */ 00278 mmiActionRegister = 0x08, /**< */ 00279 mmiActionErasure = 0x10, /**< */ 00280 mmiActionUnlock = 0x20, /**< */ 00281 mmiActionHandspring = 0x40 /**< */ 00282 }
MMI Service Code
Definition at line 290 of file HsPhoneNetworkTypes.h.
00291 { 00292 mmiServiceInvalid = 0, /**< */ 00293 mmiServiceChangePIN, /**< */ 00294 mmiServiceChangePIN2, /**< */ 00295 mmiServiceUnlockPIN, /**< */ 00296 mmiServiceUnlockPIN2, /**< */ 00297 mmiServiceIMEI, /**< */ 00298 mmiServiceCallerId, /**< */ 00299 mmiServiceNumberSent, /**< */ 00300 mmiServiceCOLP, /**< */ 00301 mmiServiceCOLR, /**< */ 00302 mmiServiceCallWaiting, /**< */ 00303 mmiServiceForwardUnconditional, /**< */ 00304 mmiServiceForwardBusy, /**< */ 00305 mmiServiceForwardNoReply, /**< */ 00306 mmiServiceForwardNotReachable, /**< */ 00307 mmiServiceForwardAll, /**< */ 00308 mmiServiceForwardConditionalAll,/**< */ 00309 mmiServiceBAOC, /**< bar all outging calls */ 00310 mmiServiceBAOIC, /**< bar all outging international calls */ 00311 mmiServiceBAOICX, /**< bar all outging international calls expect home */ 00312 mmiServiceBAIC, /**< bar all incoming calls */ 00313 mmiServiceBAICR, /**< bar all incoming calls while roaming */ 00314 mmiServiceAllBarringServ, /**< bar all services */ 00315 mmiServiceAllOutBarringServ, /**< bar all outgoing services */ 00316 mmiServiceAllInBarringServ, /**< bar all incoming services */ 00317 mmiServiceChangeBarPwd, /**< Change barring password */ 00318 mmiServiceUSSD, /**< */ 00319 mmiServicePhoneNumber, /**< */ 00320 mmiServiceCallControl, /**< */ 00321 mmiServiceSelectorOperatorLock, /**< */ 00322 mmiServiceSelectorProviderLock, /**< */ 00323 mmiServiceNNN, /**< */ 00324 mmiServiceUnimplemented /**< defined by GSM standard but not implemented in our phone */ 00325 }
| enum PhnMsgBoxEnum |
| kBoxVoice | |
| kBoxTelefax | |
| kBoxEMail | |
| kBoxOther | |
| kBoxData | |
| PhnMsgBoxTypeMAX | THIS MUST BE LAST ENTRY.... NOT A VALID VALUE |
Definition at line 100 of file HsPhoneNetworkTypes.h.
00101 { 00102 kBoxVoice, /**< */ 00103 kBoxTelefax, /**< */ 00104 kBoxEMail, /**< */ 00105 kBoxOther, /**< */ 00106 kBoxData, /**< */ 00107 PhnMsgBoxTypeMAX /**< THIS MUST BE LAST ENTRY.... NOT A VALID VALUE */ 00108 // other values reserved for future expansion 00109 }
| kSmsPriorityNormal | |
| kSmsPriorityInteractive | |
| kSmsPriorityUrgent | |
| kSmsPriorityEmergency | |
| kSmsPriorityLast |
Definition at line 115 of file HsPhoneNetworkTypes.h.
00116 { 00117 kSmsPriorityNormal, 00118 kSmsPriorityInteractive, 00119 kSmsPriorityUrgent, 00120 kSmsPriorityEmergency, 00121 kSmsPriorityLast 00122 }
| enum PhnOperatorStatus |
Phone operator status
Definition at line 84 of file HsPhoneNetworkTypes.h.
00084 { 00085 phnOpUnknown, /**< */ 00086 phnOpAvailable, /**< */ 00087 phnOpCurrent, /**< */ 00088 phnOpForbidden /**< */ 00089 } PhnOperatorStatus;
| registrationNone | |
| registrationHome | |
| registrationSearch | |
| registrationDenied | |
| registrationUnknown | |
| registrationRoaming |
Definition at line 244 of file HsPhoneNetworkTypes.h.
00244 { 00245 registrationNone, /**< */ 00246 registrationHome, /**< */ 00247 registrationSearch, /**< */ 00248 registrationDenied, /**< */ 00249 registrationUnknown, /**< */ 00250 registrationRoaming /**< */ 00251 } PhnRegistrationStatus;
| enum PhnRoamIconState |
Definition at line 345 of file HsPhoneNetworkTypes.h.
00346 { 00347 PhnRoamIconOn, /**< */ 00348 PhnRoamIconOff, /**< */ 00349 PhnRoamIconFlash /**< */ 00350 }
| enum PhnRoamStatusEnum |
| PhnRoamStatusOff | |
| PhnRoamStatusOn | |
| PhnRoamStatusBlink | |
| PhnRoamStatusEnhancedIndicator | If this is the roaming status, call PhnLibGetEnhancedRoamIndicator |
Definition at line 184 of file HsPhoneNetworkTypes.h.
00185 { 00186 PhnRoamStatusOff, /**< */ 00187 PhnRoamStatusOn, /**< */ 00188 PhnRoamStatusBlink, /**< */ 00189 PhnRoamStatusEnhancedIndicator /**< If this is the roaming status, call PhnLibGetEnhancedRoamIndicator */ 00190 }
Telephone Service MMI code Types
Definition at line 378 of file HsPhoneNetworkTypes.h.
00378 { 00379 phnTeleserviceUnknownMmiCode = 0, /**< */ 00380 phnTeleserviceVoiceMmiCode = 11, /**< */ 00381 phnTeleserviceAllMmiCode = 12, /**< */ 00382 phnTeleserviceFaxMmiCode = 13, /**< */ 00383 phnTeleserviceSMSMmiCode = 16, /**< */ 00384 phnTeleserviceAllExceptSMSCode = 19, /**< */ 00385 phnTeleserviceDataCircSyncMmiCode = 24, /**< */ 00386 phnTeleserviceDataCircAsyncMmiCode = 25, /**< */ 00387 phnTeleserviceDedicatedPackMmiCode = 26, /**< */ 00388 phnTeleserviceDedicatedPADMmiCode = 27 /**< */ 00389 } PhnTeleserviceMmiCodeType;
| enum PhnTeleserviceType |
Telephone Service Types
Definition at line 361 of file HsPhoneNetworkTypes.h.
00361 { 00362 phnTeleserviceUnknown = 0, /**< */ 00363 phnTeleserviceVoice = 1, /**< */ 00364 phnTeleserviceData = 2, /**< */ 00365 phnTeleserviceFax = 4, /**< */ 00366 phnTeleserviceDefault = 7, /**< Voice + Data + Fax */ 00367 phnTeleserviceSMS = 8, /**< */ 00368 phnTeleserviceDataCircSync = 16, /**< */ 00369 phnTeleserviceDataCircAsync = 32, /**< */ 00370 phnTeleserviceDedicatedPack = 64, /**< */ 00371 phnTeleserviceDedicatedPAD = 128 /**< */ 00372 } PhnTeleserviceType;
| Top | Palm Developer Network © 2004-2008, Palm, Inc. All rights reserved. Generated on Fri Jun 13 10:07:24 2008 for Palm API Guide |