Header Files » Incs » 68k » libraries » carriercustomlib
CarrierCustomLibTypes.h

00001 /******************************************************************************
00002  * Copyright (c) 2004 palmOne, Inc. or its subsidiaries.
00003  * All rights reserved.
00004  *****************************************************************************/
00005 /**
00006  * @ingroup Carrier
00007  */
00008  
00009 /**
00010  * @file    CarrierCustomLibTypes.h
00011  * @version 1.0
00012  * @date    12/16/2002
00013  *
00014  * @brief This file contains public data types exported by the
00015  * Carrier Customization Library
00016  *
00017  */
00018  
00019 /* 
00020  * @author    dla
00021  *  History:
00022  *    11-Dec-2002   dla     Created
00023  *    16-Dec-2003   dla     Numerous additions for CDMA carrier support
00024  *
00025  *
00026  * <hr>
00027  */
00028  
00029  
00030 #ifndef __CARRIER_CUSTOMIZATION_LIBRARY_TYPES_H__
00031 #define __CARRIER_CUSTOMIZATION_LIBRARY_TYPES_H__
00032 
00033 
00034 #if 0
00035 #pragma mark -------- Constants -------- 
00036 #endif
00037 
00038 #define kCCLibType                    'libr'                        /**< Standard library type */
00039 #define kCarrierCustomizationCLibName "CarrierCustomization.lib"    /**< Carrier Customization Library name */
00040 #define kCarrierListDBName            "CarrierProfiles2"            /**< Name of carrier list database */
00041 #define kNetworkListDBName            "NetworkProfiles2"            /**< Name of network list database */
00042 
00043 
00044 /**
00045  * @name API Version numbers
00046  * @brief Current library API version number. Returned by NetPrefLibVersionGet()
00047  */
00048 /*@{*/
00049 #define CCSMVersionMajor      0
00050 #define CCSMVersionMinor      6
00051 #define CCSMVersionBugFix     0
00052 /*@}*/
00053 
00054 /**
00055  * @name Carrier codes
00056  */
00057 /*@{*/
00058 #define kSprintMCCMNC         "310000"
00059 #define kVerizonMCCMNC        "310555"
00060 #define kBellMobilityMCCMNC   "310505"
00061 #define kGenericMCCMNC        "310999"
00062 /*@}*/
00063 
00064 typedef void *CCSMCarrierHandle;  /**< pointer type to hold the carrier object */
00065 
00066 /**
00067  * Enumeration for the type of carrier settings.
00068  * The following are applicable to CDMA as well.
00069  *
00070  *
00071  * We want to keep the groups together.
00072  * This helps keep track of which structure the setting resides in.
00073  */
00074 enum
00075 {
00076   kCCSMSettingsSystemReserved,         /**< system settings place holder */
00077 
00078   //                                         <Data type returned> description
00079   // phone settings
00080   kCCSMSettingsShowNetworkSelect,      /**< <Boolean> enable/disable network select */
00081   kCCSMSettingsIndicateRoaming,        /**< <Boolean> enable/disable roaming indicator */
00082   kCCSMSettingsEditableMSISDN,         /**< <Boolean> User editable MSISDN */
00083   kCCSMSettingsShowEmergencyMode,      /**< <Boolean> enable/disable emergency mode indicator */
00084   kCCSMSettingsCarrierMSISDN,          /**< <char *>  carrier MSISDN */
00085   kCCSMSettingsRadioBand,              /**< <UInt32>  radio band to start search with */
00086   kCCSMSettingsVoiceMailNumber,        /**< <char *>  carriers voice mail number */
00087 
00088   // Messaging settings
00089   kCCSMSettingsPOP3Server,             /**< <char *>  pop3 server -- will be deprecated */
00090   kCCSMSettingsSMTPServer,             /**< <char *>  smtp server -- will be deprecated */
00091   kCCSMSettingsSMSCNumber,             /**< <char *>  smsc number */
00092   kCCSMSettingsSMSEmailGateway,        /**< <char *>  sms email gateway */
00093   kCCSMSettingsMMSURL,                 /**< <char *>  MMS URL */
00094   kCCSMSettingsMMSWAPGateway,          /**< <char *>  MMS WAP gateway */
00095   kCCSMSettingsMMSPort,                /**< <UInt32>  MMS port number */
00096   kCCSMSettingsMMSMaxMsgSize,          /**< <UInt32> max MMS message size (kbytes) */
00097 
00098   // Browser settings
00099   kCCSMSettingsPrimaryProxyServer,          /**< <char *>  Proxy server */
00100   kCCSMSettingsPrimaryProxyPort,            /**< <UInt32>  Proxy port */
00101   kCCSMSettingsPrimarySecureProxyServer,    /**< <char *>  Secure proxy server */
00102   kCCSMSettingsPrimarySecureProxyPort,      /**< <UInt32>  Secure proxy port */
00103   kCCSMSettingsSecondaryProxyServer,        /**< <char *>  Proxy server */
00104   kCCSMSettingsSecondaryProxyPort,          /**< <UInt32>  Proxy port */
00105   kCCSMSettingsSecondarySecureProxyServer,  /**< <char *>  Secure proxy server */
00106   kCCSMSettingsSecondarySecureProxyPort,    /**< <UInt32>  Secure proxy port */
00107   kCCMSSettingsPrimaryTrustedDomain,        /**< <char *>  GSM:  Primary trusted domain */
00108                                             /**< <char *>  CDMA: phone:downloadserver.url */
00109 
00110   kCCMSSettingsSecondaryTrustedDomain,      /**< <char *>  GSM Only: Secondary trusted domain */
00111   kCCMSSettingsUAProfilingURL,              /**< <char *>  UA Profiling URL */
00112   kCCSMSettingsHTTPHeaders,                 /**< <char *>  carrier specific HTTP headers to send */
00113   kCCSMSettingsNAIHeaderFormat,             /**< <char *>  header format to send NAI (see sprintf format) */
00114   kCCSMSettingsMSISDNHeaderFormat,          /**< <char *>  header format to send MSISDN (see sprintf format) */
00115   kCCSMSettingsEncryptMSISDN,               /**< <Boolean> encrypt MSISDN header */
00116   kCCSMSettingsHomepageURL,                 /**< <char *> home page string */
00117 
00118   // network settings
00119   kCCSMSettingsGPRSAutoAttach,              /**< <Boolean> flag whether or not to display the GPRS attached icon  */
00120 
00121   // NVRAM settings.
00122   kCCSMSettingsNAI,                         /**< <char *> Slot 1 username.  CDMA only */
00123 
00124   // new items
00125   kCCSMSettingsBrowserFlags,                /**< <UInt32> flags that controls browser behaviour */
00126   kCCSMSettingsBrowserProxyFlags,           /**< <UInt32> flags that controls browser behaviour */
00127 
00128   kCCSMSettingsProxyUsername,               /**< <char *> proxy username */
00129   kCCSMSettingsProxyPassword,               /**< <char *> password for the proxy */
00130   kCCSMSettingsMessagingFlags,              /**< <UInt32> messaging flags */
00131   kCCSMSettingsSMSMaxMsgSize,               /**< <UInt32> max SMS message size (bytes) */
00132   kCCSMSettingsSMSValidityPeriod,           /**< <UInt32> SMS validity period network specific value */
00133   kCCSMSettingsE911Timeout,                 /**< <UInt32> E911 timeout value (seconds) */
00134 
00135   // MMS Settings
00136   kCCSMSettingsMMSUAProf,                   /**< <char *> UA Prof */
00137   kCCSMSettingsMMSUAString,                 /**< <char *> UA Prof string*/ 
00138   kCCSMSettingsMMSMaxVideoSize,             /**< <Int32> MMS maximum video size */
00139   kCCSMSettingsMMSVersionNumber,            /**< <Int32> MMS version (11 = 1.1) */
00140 
00141   // Email settings
00142   kCCSMSettingsEmailSMTPServer,             /**< <char *> SMTP Server */
00143 
00144   // extra phone settings
00145   kCCSMSettingsSPNSupported,                /**< <Boolean> flag if SPN is supported */
00146 
00147   kCCSMSettingsWapSupportLevel,             /**< <UInt16> WAP level supported. */
00148 
00149   kCCSMSettingsSMSSupportDeliveryReceipt,   /**< <Boolean> WAP level supported. */
00150 
00151   kCCSMSettingsCSDDisable,                  /**< <Boolean> CSD disable or not */
00152 
00153   kCCSMSettingsReserved = 0x8000      /**< reserved */
00154 };
00155 typedef UInt16 CCSMSettingsType;  /**< used with the settingsTypeEnum */
00156 
00157 
00158 /** system settings
00159  *
00160  */
00161 typedef enum
00162 {
00163   kCCSMSystemSettingReserved  = 0x00000000  /**< reserved setting */
00164 }
00165 CCSMSystemFlagsEnum;
00166 typedef UInt32 CCSMSystemFlagsType; /**< Used with CCSMSystemFlagsEnum */
00167 
00168 /** enumeration for the phone settings flags
00169  *
00170  */
00171 typedef enum
00172 {
00173   kCCSMPhoneSettingsReserved          = 0x00000000,  /**< reserved setting */
00174   kCCSMPhoneSettingsNetworkSelect     = 0x00000001,  /**< Network Select disable/enable */
00175   kCCSMPhoneSettingsRoamingIndicator  = 0x00000002,  /**< Roaming indicator yes/no */
00176   kCCSMPhoneSettingsEditMSISDN        = 0x00000004,  /**< Editable MSISDN */
00177   kCCSMPhoneSettingsShowEmergencyMode = 0x00000008,  /**< use Emergency mode */
00178   kCCSMPhoneSettingsEnableTTY         = 0x00000010,  /**< enable TTY */
00179   kCCSMPhoneSettingsUseEFSPN          = 0x00000020   /**< Use EF SPN if any */
00180 }
00181 CCSMPhoneFlagsEnum;
00182 typedef UInt32 CCSMPhoneFlagsType; /**< used with CCSMPhoneFlagsEnum */
00183 
00184 /** enumeration for the radio band
00185  *  Used to optimize which band the radio starts scanning on.
00186  */
00187 typedef enum
00188 {
00189   kCCSMRadioBandUnknown,        /**< unknown radio band */
00190   kCCSMRadioBandEurope,         /**< european radio */
00191   kCCSMRadioBandNorthAmerica    /**< north american radio */
00192 }
00193 CCSMRadioBandEnum;
00194 typedef UInt32 CCSMRadioBandType; /**< used with CCSMRadioBandEnum */
00195 
00196 /** enumeration for the messaging settings flags
00197  *
00198  */
00199 typedef enum
00200 {
00201   kCCSMMessagingSettingsReserved              = 0x00000000,  /**< reserved setting */
00202   kCCSMMessagingSettingsStripPhonePlus        = 0x00000001,  /**< does the network require the phone number to be stripped */
00203   kCCSMMessagingSettings11DigitRecipient      = 0x00000002,  /**< flag if a number requires 10 or 11 digits (I assume US only) */
00204   kCCSMMessagingSettingsNormaliseMMSAddress   = 0x00000004,  /**< Flag if MMS address should be normalised or not */
00205   kCCSMMessagingSettingsWAPProtocol20         = 0x00000008,  /**< *internal* Use WAP 2.0 for MMS? */
00206   kCCSMMessagingSettingsDisableMMSFallback    = 0x00000010   /**< Flag to disable the fallback account when connecting */
00207 
00208   //  kCCSMMessagingSettingsCameraProtocol        = 0x00000020,  /**< *internal* Use lightsurf or not */
00209 }
00210 CCSMMessagingSettingsEnum;
00211 typedef UInt32 CCSMMessagingFlagsType; /**< Used with CCSMMessagingSettingsEnum */
00212 
00213 
00214 /** enumeration for the browser settings flags
00215  *
00216  */
00217 typedef enum
00218 {
00219   kCCSMBrowserSettingsReserved              = 0x00000000,  /**< reserved setting */
00220   kCCSMBrowserSettingsEncryptMSISDN         = 0x00000001,  /**< send encrypted MSISDN */
00221   kCCSMBrowserSettingsCSDDisconnectOnExit   = 0x00000002,  /**< disconnect on exit for CSD connections */
00222   kCCSMBrowserSettingsPDataDisconnectOnExit = 0x00000004,  /**< disconnect on exit for packet data connections */
00223   kCCSMBrowserSettingsDormantOnExit         = 0x00000008,  /**< force dormancy on exit */
00224 
00225   kCCSMBrowserSettingsHideDisconnect        = 0x00000010,  /**< hide disconnect button */
00226   kCCSMBrowserSettingsVersionInWAPProfile   = 0x00000020,  /**< Add version in WAP profile header */
00227 
00228 
00229 
00230   kCCSMPrimaryProxyAuthenticate             = 0x00000001,  /**< proxy properties */
00231   kCCSMPrimaryProxyLocked                   = 0x00000002,  /**< proxy properties */
00232   kCCSMPrimaryProxyHide                     = 0x00000004,  /**< proxy properties */
00233 
00234   kCCSMSecondaryProxyAuthenticate           = 0x00010000,  /**< proxy properties */
00235   kCCSMSecondaryProxyLocked                 = 0x00020000,  /**< proxy properties */
00236   kCCSMSecondaryProxyHide                   = 0x00040000   /**< proxy properties */
00237 }
00238 CCSMBrowserSettingsEnum;
00239 typedef UInt32 CCSMBrowserFlagsType; /**< Used with CCSMBrowserSettingsEnum */
00240 
00241 struct CCSMContextTypeTag;
00242 
00243 #endif // __CARRIER_CUSTOMIZATION_LIBRARY_TYPES_H__
Top	Palm Developer Network © 2004-2008, Palm, Inc. All rights reserved. Generated on Fri Jun 13 10:06:52 2008 for Palm API Guide