API Guide Home (Online version only) |

# HsPhoneGSMTypes.h File Reference

## Detailed Description

Header File for Phone Library API ---- NETWORK CATEGORY.

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 GSM category. These API calls are used to interact with the wireless network.

Definition in file HsPhoneGSMTypes.h.

Include dependency graph for HsPhoneGSMTypes.h:

Go to the source code of this file.

## Data Structures

- struct PhnPhoneBookInfoType
- struct PhnGPRSPDPContextType
- struct PhnGPRSPDPContextListNodeType

## Defines

- #define isValidSATNotificationType(s)
- #define isValidPhnGPRSPDPType(t) ((t >= phnGPRSPDPTypeIP) && (t <= phnGPRSPDPTypePPP))
- #define isValidPhnGPRSQOSType(t) ((t >= kGPRSQOSTypeRequired) && (t <= kGPRSQOSTypeMinimum))
- #define isValidGSMSIMMessagesDialogKind(d) ((d >= gsmMessagesConfirmMove) && (d <= gsmMessagesCantReceive))
- #define isValidGSMSATEventToneTypeEnum(x) (((x >= phnSATEventToneTypeDial) && (x <= phnSATEventToneTypeNegativeBeep)) || (x == phnSATEventToneTypeNoneSpecified))
- #define isValidGSMSATEventSetupCallCallTypeEnum(x) ((x >= phnSATEventSetupCallCallTypeVoice) && (x <= phnSATEventSetupCallCallTypeFax))

- #define GSMLockSelectorOperatorLock ('PN')
- #define GSMLockSelectorProviderLock ('PP')

- #define phnNetPrefGPRSPDPContextID 1
- #define GSMLibRingsDbName "System Ring Tones"
- #define kLineNumberUnknown 0

Special response values for PhnSATEventGetInkey (besides a single character)

- #define phnSATInkeyResponseValueYes ((UInt32)'YES_')
- #define phnSATInkeyResponseValueNo ((UInt32)'NO__')

## Typedefs

- typedef struct PhnPhoneBookInfoType * PhnPhoneBookInfoPtr
- typedef UInt8 SATRequestType
- typedef UInt8 SATDecisionType
- typedef UInt8 SATNotificationType
- typedef UInt16 SATSetupCallType
- typedef UInt32 SATRefreshFile
- typedef UInt16 SATRefreshType
- typedef UInt8 PhnGPRSPDPType
- typedef UInt8 PhnGPRSQOSType
- typedef UInt8 GSMSIMMessagesDialogKind
- typedef UInt8 GSMSATEventMenuFlag
- typedef UInt8 GSMSATEventInputFormatEnum
- typedef UInt8 GSMATEventInputEchoModeEnum
- typedef UInt8 GSMSATEventToneTimeUnitEnum
- typedef UInt16 GSMSATEventToneTypeEnum
- typedef UInt8 GSMSATEventSetupCallCallTypeEnum
- typedef UInt8 GSMSATDataSvcType

## Enumerations

- enum _SATRequestType {
  kSATSelectMainMenuItem,
  kSATClearText,
  kSATSetInkey,
  kSATSetInput,
  kSATMakeCall,
  kSATSelectItem = 6,
  kSATReqLaunchBrowser,
  kSATReqIdleModeText,
  kSATReqDataSrv,
  kSATReqPlayTone,
  kSATReqRefresh,
  kSATCancel = 95,
  kSATUnknownNotification,
  kSATApplicationBusy,
  kSATUserNotResponse,
  kSATEndSession,
  kSATReqSendDTMF
  }
- enum _SATDecisionType {
  kSATSessionAborted,
  kSATItemSelected,
  kSATHelpRequested,
  kSATNavigateBack
  }
- enum _SATNotificationType {
  kSATMainMenuAvailable,
  kSATDisplayText,
  kSATGetInkey,
  kSATGetInput,
  kSATSetupCall,
  kSATPlayTone,
  kSATDisplaySubmenus,
  kSATRefresh,
  kSATSendSS,
  kSATSendSMS,
  kSATSendUSSD,
  kSATLaunchBrowser,
  kSATIdleModeText,
  kSATRunAT,
  kSATDataSvc,
  kSATSendDTMF,
  kSATTimeout = 98,
  kSATSessionEnd = 99
  }
- enum _SATSetupCallType {
  kSATSetupCallModeNotBusy,
  kSATSetupCallWithRedialModeNotBusy,
  kSATSetupCallHoldOtherCalls,
  kSATSetupCallWithRedialHoldOtherCalls,
  kSATSetupCallDisconnectOtherCalls,
  kSATSetupCallWithRedialDisconnectOtherCalls,
  kSATSetupCallMax
  }
- enum _SATRefreshFile { kSATEFSimPhoneBook = 0x00000001 }
- enum _SATRefreshType {
  kSATInitWithFullFileChange,
  kSATFileChange,
  kSATInitWithFileChange,
  kSATInit,
  kSATSIMReset,
  kSATMax
  }
- enum _PhnGPRSPDPType {
  phnGPRSPDPTypeIP = 1,
  phnGPRSPDPTypePPP = 2
  }
- enum _PhnGPRSQOSType {
  kGPRSQOSTypeRequired = 1,
  kGPRSQOSTypeMinimum = 2
  }
- enum _GSMSIMMessagesDialogKind {
  gsmMessagesConfirmMove,
  gsmMessagesCantReceive
  }
- enum _GSMSATEventMenuFlag {
  phnSATEventMenuFlagHelp = 1,
  phnSATEventMenuFlagNextAct = 2
  }
- enum _GSMSATEventInputFormatEnum {
  phnSATEventInputFormatDigit = 0,
  phnSATEventInputFormatSMSChar = 1,
  phnSATEventInputFormatUCS2 = 2,
  phnSATEventInputFormatUnpacked = 3,
  phnSATEventInputFormatPacked = 4,
  phnSATEventInputFormatYesNo = 5,
  phnSATEventInputFormatUnknown = 255
  }
- enum _GSMATEventInputEchoModeEnum {
  phnSATEventInputEchoModeShowInput = 0,
  phnSATEventInputEchoModeHideInput = 1
  }
- enum _GSMSATEventToneTimeUnitEnum {
  phnSATEventToneTimeUnitMinutes = 0,
  phnSATEventToneTimeUnitSeconds = 1,
  phnSATEventToneTimeUnitDeciSeconds = 2
  }
- enum _GSMSATEventToneTypeEnum {
  phnSATEventToneTypeNoneSpecified = 0xFFFF,
  phnSATEventToneTypeDial = 0,
  phnSATEventToneTypeBusy = 1,
  phnSATEventToneTypeCongestion = 2,
  phnSATEventToneTypeRadioAck = 3,
  phnSATEventToneTypeDropped = 4,
  phnSATEventToneTypeError = 5,
  phnSATEventToneTypeCallWaiting = 6,
  phnSATEventToneTypeRinging = 7,
  phnSATEventToneTypeGeneralBeep = 8,
  phnSATEventToneTypePositiveBeep = 9,
  phnSATEventToneTypeNegativeBeep = 10
  }
- enum _GSMSATEventSetupCallCallTypeEnum {
  phnSATEventSetupCallCallTypeVoice = 0,
  phnSATEventSetupCallCallTypeData = 1,
  phnSATEventSetupCallCallTypeFax = 2
  }
- enum _GSMSATDataSvcTypeEnum {
  phnSATEventDataSvcTypeOpenChannel = 1,
  phnSATEventDataSvcTypeSendData = 2,
  phnSATEventDataSvcTypeRcvData = 3,
  phnSATEventDataSvcTypeCloseChannel = 4
  }

## Define Documentation

#define GSMLibRingsDbName "System Ring Tones"

Name of GSM RingTone DB

Definition at line 63 of file HsPhoneGSMTypes.h.

#define GSMLockSelectorOperatorLock ('PN')

Definition at line 41 of file HsPhoneGSMTypes.h.

#define GSMLockSelectorProviderLock ('PP')

Definition at line 42 of file HsPhoneGSMTypes.h.

#define isValidGSMSATEventSetupCallCallTypeEnum | ( | x |  | ) | ((x >= phnSATEventSetupCallCallTypeVoice) && (x <= phnSATEventSetupCallCallTypeFax))

Definition at line 357 of file HsPhoneGSMTypes.h.

#define isValidGSMSATEventToneTypeEnum | ( | x |  | ) | (((x >= phnSATEventToneTypeDial) && (x <= phnSATEventToneTypeNegativeBeep)) || (x == phnSATEventToneTypeNoneSpecified))

Definition at line 332 of file HsPhoneGSMTypes.h.

#define isValidGSMSIMMessagesDialogKind | ( | d |  | ) | ((d >= gsmMessagesConfirmMove) && (d <= gsmMessagesCantReceive))

Definition at line 248 of file HsPhoneGSMTypes.h.

#define isValidPhnGPRSPDPType | ( | t |  | ) | ((t >= phnGPRSPDPTypeIP) && (t <= phnGPRSPDPTypePPP))

Definition at line 199 of file HsPhoneGSMTypes.h.

#define isValidPhnGPRSQOSType | ( | t |  | ) | ((t >= kGPRSQOSTypeRequired) && (t <= kGPRSQOSTypeMinimum))

Definition at line 212 of file HsPhoneGSMTypes.h.

#define isValidSATNotificationType | ( | s |  | ) |

Value:

    (((s >= kSATMainMenuAvailable) && (s <= kSATSendUSSD)) \
                  || (s == kSATTimeout) || (s == kSATSessionEnd))

Definition at line 164 of file HsPhoneGSMTypes.h.

#define kLineNumberUnknown 0

Definition at line 67 of file HsPhoneGSMTypes.h.

#define phnNetPrefGPRSPDPContextID 1

Definition at line 52 of file HsPhoneGSMTypes.h.

#define phnSATInkeyResponseValueNo ((UInt32)'NO__')

Definition at line 297 of file HsPhoneGSMTypes.h.

#define phnSATInkeyResponseValueYes ((UInt32)'YES_')

Definition at line 296 of file HsPhoneGSMTypes.h.

## Typedef Documentation

typedef UInt8 GSMATEventInputEchoModeEnum

Definition at line 289 of file HsPhoneGSMTypes.h.

typedef UInt8 GSMSATDataSvcType

Definition at line 355 of file HsPhoneGSMTypes.h.

typedef UInt8 GSMSATEventInputFormatEnum

Definition at line 280 of file HsPhoneGSMTypes.h.

typedef UInt8 GSMSATEventMenuFlag

Definition at line 258 of file HsPhoneGSMTypes.h.

typedef UInt8 GSMSATEventSetupCallCallTypeEnum

Definition at line 344 of file HsPhoneGSMTypes.h.

typedef UInt8 GSMSATEventToneTimeUnitEnum

Definition at line 310 of file HsPhoneGSMTypes.h.

typedef UInt16 GSMSATEventToneTypeEnum

Definition at line 330 of file HsPhoneGSMTypes.h.

typedef UInt8 GSMSIMMessagesDialogKind

Definition at line 246 of file HsPhoneGSMTypes.h.

typedef UInt8 PhnGPRSPDPType

Definition at line 197 of file HsPhoneGSMTypes.h.

typedef UInt8 PhnGPRSQOSType

Definition at line 210 of file HsPhoneGSMTypes.h.

typedef struct PhnPhoneBookInfoType * PhnPhoneBookInfoPtr

typedef UInt8 SATDecisionType

Definition at line 118 of file HsPhoneGSMTypes.h.

typedef UInt8 SATNotificationType

Definition at line 144 of file HsPhoneGSMTypes.h.

typedef UInt32 SATRefreshFile

Definition at line 174 of file HsPhoneGSMTypes.h.

typedef UInt16 SATRefreshType

Definition at line 186 of file HsPhoneGSMTypes.h.

typedef UInt8 SATRequestType

Definition at line 106 of file HsPhoneGSMTypes.h.

typedef UInt16 SATSetupCallType

Definition at line 162 of file HsPhoneGSMTypes.h.

## Enumeration Type Documentation

enum _GSMATEventInputEchoModeEnum

Enumerator:

  phnSATEventInputEchoModeShowInput | Show input as entered
  phnSATEventInputEchoModeHideInput | Display bullets or boxes instead of entered characters

Definition at line 285 of file HsPhoneGSMTypes.h.

    00294    {*/

enum _GSMSATDataSvcTypeEnum

Possible values of serviceType for PhnSATEventDataSvc

Enumerator:

  phnSATEventDataSvcTypeOpenChannel |
  phnSATEventDataSvcTypeSendData |
  phnSATEventDataSvcTypeRcvData |
  phnSATEventDataSvcTypeCloseChannel |

Definition at line 349 of file HsPhoneGSMTypes.h.

enum _GSMSATEventInputFormatEnum

Possible values of format for PhnSATEventGetInkey and PhnSATEventGetInput

Enumerator:

  phnSATEventInputFormatDigit | Get Inkey or Get Input 0-9, #, *, or +
  phnSATEventInputFormatSMSChar | Get Inkey or Get Input SMS character set
  phnSATEventInputFormatUCS2 | Get Inkey or Get Input
  phnSATEventInputFormatUnpacked | Get Input only
  phnSATEventInputFormatPacked | Get Input only
  phnSATEventInputFormatYesNo | Get Inkey or Get Input
  phnSATEventInputFormatUnknown | KEEP THIS ONE AT THE END

Definition at line 264 of file HsPhoneGSMTypes.h.

    00284                                   {

enum _GSMSATEventMenuFlag

Enumerator:

  phnSATEventMenuFlagHelp | help is available
  phnSATEventMenuFlagNextAct | nextAction is valid

Definition at line 253 of file HsPhoneGSMTypes.h.

    00263                                  {

enum _GSMSATEventSetupCallCallTypeEnum

Possible values of callType for PhnSATEventSetupCall

Enumerator:

  phnSATEventSetupCallCallTypeVoice | SIM wants to set up a voice call
  phnSATEventSetupCallCallTypeData | SIM wants to set up a data call
  phnSATEventSetupCallCallTypeFax | SIM wants to set up a fax

Definition at line 338 of file HsPhoneGSMTypes.h.

    00348                             {

enum _GSMSATEventToneTimeUnitEnum

Possible values of timeUnit for PhnSATEventPlayTone

Enumerator:

  phnSATEventToneTimeUnitMinutes | Duration specified in minutes
  phnSATEventToneTimeUnitSeconds | Duration specified in seconds
  phnSATEventToneTimeUnitDeciSeconds | Duration specified in 1/10 seconds

Definition at line 304 of file HsPhoneGSMTypes.h.

    00314                               {

enum _GSMSATEventToneTypeEnum

Possible values of toneType for PhnSATEventPlayTone

Enumerator:

  phnSATEventToneTypeNoneSpecified | Means just do a normal beep...
  phnSATEventToneTypeDial |
  phnSATEventToneTypeBusy |
  phnSATEventToneTypeCongestion |
  phnSATEventToneTypeRadioAck |
  phnSATEventToneTypeDropped |
  phnSATEventToneTypeError |
  phnSATEventToneTypeCallWaiting |
  phnSATEventToneTypeRinging |
  phnSATEventToneTypeGeneralBeep |
  phnSATEventToneTypePositiveBeep |
  phnSATEventToneTypeNegativeBeep |

Definition at line 315 of file HsPhoneGSMTypes.h.

    00337                                        {

enum _GSMSIMMessagesDialogKind

Enumerator:

  gsmMessagesConfirmMove |
  gsmMessagesCantReceive |

Definition at line 242 of file HsPhoneGSMTypes.h.

    00252                           {

enum _PhnGPRSPDPType

Enumerator:

  phnGPRSPDPTypeIP |
  phnGPRSPDPTypePPP |

Definition at line 191 of file HsPhoneGSMTypes.h.

    00191 {
    00192   phnGPRSPDPTypeIP = 1,         /**<        */
    00193   phnGPRSPDPTypePPP = 2         /**<        */
    00194 } _PhnGPRSPDPType;
    00195

enum _PhnGPRSQOSType

Enumerator:

  kGPRSQOSTypeRequired |
  kGPRSQOSTypeMinimum |

Definition at line 204 of file HsPhoneGSMTypes.h.

    00204 {
    00205   kGPRSQOSTypeRequired = 1,     /**<        */
    00206   kGPRSQOSTypeMinimum = 2       /**<        */
    00207 } _PhnGPRSQOSType;
    00208

enum _SATDecisionType

decision we are sending to SIM

Enumerator:

  kSATSessionAborted |
  kSATItemSelected |
  kSATHelpRequested |
  kSATNavigateBack |

Definition at line 111 of file HsPhoneGSMTypes.h.

    00111              {
    00112     kSATSessionAborted,     /**<        */
    00113     kSATItemSelected,       /**<        */
    00114     kSATHelpRequested,      /**<        */
    00115     kSATNavigateBack        /**<        */
    00116 } _SATDecisionType;

enum _SATNotificationType

type of notification sent by SAT

Enumerator:

  kSATMainMenuAvailable |
  kSATDisplayText |
  kSATGetInkey |
  kSATGetInput |
  kSATSetupCall |
  kSATPlayTone |
  kSATDisplaySubmenus |
  kSATRefresh | application do not get this notification
  kSATSendSS |
  kSATSendSMS |
  kSATSendUSSD |
  kSATLaunchBrowser |
  kSATIdleModeText |
  kSATRunAT |
  kSATDataSvc |
  kSATSendDTMF |
  kSATTimeout |
  kSATSessionEnd |

Definition at line 123 of file HsPhoneGSMTypes.h.

    00123              {
    00124     kSATMainMenuAvailable,      /**<        */
    00125     kSATDisplayText,        /**<        */
    00126     kSATGetInkey,           /**<        */
    00127     kSATGetInput,           /**<        */
    00128     kSATSetupCall,          /**<        */
    00129     kSATPlayTone,           /**<        */
    00130     kSATDisplaySubmenus,        /**<        */
    00131     kSATRefresh,            /**< application do not get this notification */
    00132     kSATSendSS,         /**<        */
    00133     kSATSendSMS,            /**<        */
    00134     kSATSendUSSD,           /**<        */
    00135     kSATLaunchBrowser,          /**<        */
    00136     kSATIdleModeText,           /**<        */
    00137     kSATRunAT,          /**<        */
    00138     kSATDataSvc,            /**<        */
    00139     kSATSendDTMF,           /**<        */
    00140     kSATTimeout     = 98,   /**<        */
    00141     kSATSessionEnd  = 99        /**<        */
    00142 } _SATNotificationType;

enum _SATRefreshFile

Enumerator:

  kSATEFSimPhoneBook |

Definition at line 168 of file HsPhoneGSMTypes.h.

    00168 {
    00169   kSATEFSimPhoneBook = 0x00000001
    00170
    00171 }_SATRefreshFile;
    00172

enum _SATRefreshType

Enumerator:

  kSATInitWithFullFileChange |
  kSATFileChange |
  kSATInitWithFileChange |
  kSATInit |
  kSATSIMReset |
  kSATMax |

Definition at line 176 of file HsPhoneGSMTypes.h.

    00176 {
    00177   kSATInitWithFullFileChange,
    00178   kSATFileChange,
    00179   kSATInitWithFileChange,
    00180   kSATInit,
    00181   kSATSIMReset,
    00182   kSATMax
    00183 }_SATRefreshType;
    00184

enum _SATRequestType

SIM Application Toolkit's data types type of request/respond we are sending

Enumerator:

  kSATSelectMainMenuItem |
  kSATClearText |
  kSATSetInkey |
  kSATSetInput |
  kSATMakeCall |
  kSATSelectItem |
  kSATReqLaunchBrowser |
  kSATReqIdleModeText |
  kSATReqDataSrv |
  kSATReqPlayTone |
  kSATReqRefresh |
  kSATCancel |
  kSATUnknownNotification |
  kSATApplicationBusy |
  kSATUserNotResponse |
  kSATEndSession |
  kSATReqSendDTMF |

Definition at line 86 of file HsPhoneGSMTypes.h.

    00086              {
    00087     kSATSelectMainMenuItem,     /**<        */
    00088     kSATClearText,          /**<        */
    00089     kSATSetInkey,           /**<        */
    00090     kSATSetInput,           /**<        */
    00091     kSATMakeCall,           /**<        */
    00092     kSATSelectItem = 6,     /**<        */
    00093     kSATReqLaunchBrowser,       /**<        */
    00094     kSATReqIdleModeText,
    00095     kSATReqDataSrv,
    00096     kSATReqPlayTone,            /**<        */
    00097     kSATReqRefresh,         /**<        */
    00098     kSATCancel     = 95,    /**<        */
    00099     kSATUnknownNotification,    /**<        */
    00100     kSATApplicationBusy,        /**<        */
    00101     kSATUserNotResponse,        /**<        */
    00102     kSATEndSession,         /**<        */
    00103     kSATReqSendDTMF         /**<        */
    00104 } _SATRequestType;

enum _SATSetupCallType

Enumerator:

  kSATSetupCallModeNotBusy |
  kSATSetupCallWithRedialModeNotBusy |
  kSATSetupCallHoldOtherCalls |
  kSATSetupCallWithRedialHoldOtherCalls |
  kSATSetupCallDisconnectOtherCalls |
  kSATSetupCallWithRedialDisconnectOtherCalls |
  kSATSetupCallMax |

Definition at line 150 of file HsPhoneGSMTypes.h.

    00151 {
    00152   kSATSetupCallModeNotBusy,
    00153   kSATSetupCallWithRedialModeNotBusy,
    00154   kSATSetupCallHoldOtherCalls,
    00155   kSATSetupCallWithRedialHoldOtherCalls,
    00156   kSATSetupCallDisconnectOtherCalls,
    00157   kSATSetupCallWithRedialDisconnectOtherCalls,
    00158
    00159   kSATSetupCallMax// do not use
    00160 }_SATSetupCallType;

Top | Palm Developer Network © 2004-2008, Palm, Inc. All rights reserved. Generated on Fri Jun 13 10:07:19 2008 for Palm API Guide