#define MAX_NOTIF_LIST 122 |
Maximum size of notification list
typedef void(* SWI_CALLBACK_EX)(SwiNotifyVariant *pNotify) |
Callback
enum SWI_TYPE_Notify |
This enumerated data type defines a variety of notification types.
API notifications are always enabled while modem originated notifications must be enabled before an update is sent form the modem. Notifications are disabled by default at power up and after a reset. Therefore, application must re-enable all desired notifications when device powers up or a reset is detected.
The following common API notifications are always enabled and do not require enabling. Modem originated notifications must be enabled before an update is sent from the modem.
SWI_NOTIFY_NULL | Invalid notification. This is simply a place holder. |
SWI_NOTIFY_AirServerChange |
Air server insertion/removal notification. This notification is always enabled and can not be disabled.
|
SWI_NOTIFY_LockAirServer |
Air server lock notification. This notification is always enabled and can not be disabled.
|
SWI_HW_NOTIFY_Power |
Hardware power state change. No need to re-enable mask. This notification is always enabled and can not be disabled. Only supported on CDMA devices.
|
SWI_NOTIFY_Power |
Device power notification. Previously used to indicate device removal. SWI_NOTIFY_AirServerChange should now be used instead. This notification is always enabled and can not be disabled.
|
SWI_NOTIFY_MUX_Shutdown | API service has shutdown. API service must be restarted and SwiApiClose and SwiApiOpenEx must be called before normal operation can proceed. This notification is always enabled and can not be disabled. This notification does not have an associated user structure. |
SWI_NOTIFY_HeartBeat |
Provides a mechanism to assure the application that the modem is still connected and running normally. This event is forwarded approximately every 10 seconds. It is recommended that this object no longer be used as it prevents the host USB bus controller from entering into low power state to conserve battery life.
|
SWI_NOTIFY_HeadsetIcon |
Notifies the app of headset attachment state.
|
SWI_NOTIFY_HeadsetState |
Notifies the application of the headset state. Headset state is not supported on the SB555.
|
SWI_NOTIFY_Rssi |
The Received Signal Strength Indicator (RSSI) is reported only when the value changes. The notification is issued at the slot cycle index as set by the service provider. For larger slot cycle indexes, the notification is issued less often. A slot cycle index of 1 generates this notification at about 2-second intervals.
|
SWI_NOTIFY_TransmitAlert |
Indicates to the application that there is a problem with the antenna. It should be assumed that the problem will not persist longer than 10 seconds. If the antenna problem continues another transmit alert event will be generated by the modem.
|
SWI_NOTIFY_Reset |
Reports to the application when the modem resets. This notification is received when modem is inserted, after power up, after a firmware download and during any process which cause a modem reset. Modem notifications which were previously enabled, will default back to its original state (off). When received, the application must re-enable all desired notifications again. This notification is always enabled and can not be disabled.
|
SWI_NOTIFY_Band |
Provides the application with band status updates, typically occurring after the frequency band has changed.
|
SWI_NOTIFY_Debug |
Not supported in this version of the SDK.
|
SWI_NOTIFY_FwDownload |
Provides firmware download progress status. Errors during the firmware download process are also reported.
|
SWI_NOTIFY_Dhcp |
Not supported in this version of the SDK.
|
SWI_NOTIFY_PPP |
Not supported in this version of the SDK.
|
SWI_NOTIFY_RadioPower |
Indicates the modem power state has changed. This notification is only available on 3G or newer CDMA and GSM products.
|
SWI_NOTIFY_RadioTempState |
Indicates the modem temperature state has changed. This notification is only available on 3G or newer CDMA and GSM products.
|
SWI_NOTIFY_RadioBattery |
Indicates the current supply voltage of the modem has changed. This notification is only available on CDMA and GSM MiniCard products.
|
SWI_NOTIFY_RadioBand |
Indicates there is a change in the band(s) the modem is currently using. This notification is available on 3G CDMA and GSM products. On some CDMA devices, multiple bands can be used at one time.
|
SWI_NOTIFY_AudioProfile |
Indicates there is a change in the modem's audio profile. This notification is available on 3G CDMA and GSM products.
|
SWI_NOTIFY_DeviceTime |
Indicates a change in the system time of the device This notification is available on 3G CDMA and GSM products. This notification is only sent on initial network attach for GSM products, when service is acquired/reacquired for CDMA based products, and if and when the time zone information changes.
|
SWI_NOTIFY_MpFwDownload | MP firmware download notification. There is no user structure associated with this object. |
SWI_NOTIFY_Gps |
Provides constant and up-to-date GPS information at regular intervals.
|
SWI_NOTIFY_ExtDio |
Provides current logic level of all external digital I/Os.
|
SWI_NOTIFY_ExtAi |
Provides current logic level of all external analog inputs.
|
SWI_NOTIFY_GpsCommand |
Provides the result/response of a GPS command sent to the GPS module in the modem.
|
SWI_NOTIFY_MpByteCount |
Provides byte counter information.
|
SWI_NOTIFY_MPIgnSense |
First informs the host software when the ignition is turned off, then when shutdown time approaches, more notifications are sent to indicate that the MP750 will soon be shutdown.
|
SWI_NOTIFY_RfDownload |
RF download progress.
|
SWI_NOTIFY_SimSled |
Provides SIM sled status.
|
SWI_NOTIFY_BatteryStatus |
Provides low battery alert.
|
SWI_NOTIFY_MpShutdown |
Provides the reason behind a MP shutdown
|
SWI_NOTIFY_MpConnect |
Provides MP test connection result (Under a Serial connection). Provides MP connection result (Under a USB connection)
|
SWI_NOTIFY_MpStartupDiag |
MP startup diagnostics.
|
SWI_NOTIFY_MpDisconnect |
MP disconnect notification.
|
SWI_NOTIFY_SmsStatus |
Reports the status of SMS records on the modem whenever a new message arrives. Whenever an SMS message arrives, the modem can generate this event notification. The data reported advises the application of the number of SMS messages stored in the modem. This SmsStatus notification will trigger on the arrival of any SMS message that can be stored in the modem. If the modem memory fills, and additional messages are declined, there will be no further notifications.
|
SWI_NOTIFY_SmsSendStatus |
Reports the results of sending a mobile originated SMS message. This notification passes the acknowledgment from the network to the application for SMS messages sent.
|
SWI_NOTIFY_LbsPdData |
Notifies the host application of the result of the position fix.
|
SWI_NOTIFY_LbsPdDone |
Notifies the host application that a position determination download session has completed.
|
SWI_NOTIFY_LbsPdEnd |
Notifies the host application that a position determination fix session had an error.
|
SWI_NOTIFY_LbsPdBegin |
Notifies the host application that a position determination fix session has begun.
|
SWI_NOTIFY_LbsPdUpdateFailure |
Notifies the host application that a position determination session has failed.
|
SWI_NOTIFY_LbsPdDloadBegin |
Notifies the host application that a data download session has begun.
|
SWI_NOTIFY_LbsPdDloadData |
Notifies the host application that ephemeris and almanac data has been downloaded.
|
SWI_NOTIFY_LbsPdDloadDone |
Notifies the host application that a position determination download session has completed.
|
SWI_NOTIFY_LbsPdDloadEnd |
Notifies the host application that a position determination download data session had an error.
|
SWI_NOTIFY_LbsPaIpAddr |
This notification contains the default value for the TCP/IP address used in LBS sessions.
|
SWI_NOTIFY_LbsPaGpsLock |
This notification contains the default value for the GPS lock used in LBS sessions.
|
SWI_NOTIFY_LbsPaPtlmMode |
This notification contains the mechanism used to transport LBS messages.
|
SWI_NOTIFY_LbsPaPortId |
This notification contains the default value for the port ID used in LBS sessions.
|
SWI_NOTIFY_LbsPaPrivacy |
This notification contains the default value for the privacy level used for LBS sessions.
|
SWI_NOTIFY_LbsPaNetAccess |
This notification contains the default value for the network access permissions used during LBS sessions.
|
SWI_NOTIFY_LbsPaBsInfo |
This notification contains the base station currently being accessed.
|
SWI_NOTIFY_LbsPaWarmBegin |
Notifies the registered host application that keep warming processing has begun.
|
SWI_NOTIFY_LbsPaWarmStatus |
This notification reports the keep warm processing status and is only available on GSM devices.
|
SWI_NOTIFY_LbsPaWarmDone |
Notifies the host application that keep warm processing is done.
|
SWI_NOTIFY_LbsSatInfo |
This notification lists satellites visible during the last position fix session. It also identifies the satellites used in the latest position fix.
|
SWI_NOTIFY_LbsPdGetStatus |
This notification provides the current status of the LBS.
|
SWI_NOTIFY_LbsNiReq |
Notifies the host of a network initiated location fix request. The associated user structure is SWI_STRUCT_LbsNiReq. The host should display the requester ID and client name if these fields are present. If the notification type requires a user response, the host should present a dialog to the user with the options "Accept" and "Reject" for the user to choose from. The host will respond using SwiSetLbsNiReq to the modem based on the user's selection (TYPE_LbsNiReqResp). If the user chooses not to respond (ex. closed dialog box), the host must respond with a set request where the user response is "Cancel request". If the user does not respond to the dialog within the specified timeout period, the host should close the dialog and send a set request where the user response is "Cancel request". Note that the modem will assume the user response is "Cancel request" after the timeout period has elapsed regardless of what the host continues to send.
|
SWI_NOTIFY_ChannelNumber |
Reports each channel number the radio tunes to. Using this notification type, the application is advised each time the radio tunes to a different channel. This can be very frequent when the radio is scanning for a usable channel. Only supported on CDMA devices.
|
SWI_NOTIFY_ChannelState |
Reports channel acquisition and scanning. Using this notification type, the application can keep the user aware of changes in the channel lock of the radio. Whenever the radio acquires or loses a channel, this notification is issued. Only supported on CDMA devices.
|
SWI_NOTIFY_ServiceIndication |
Reports entering and leaving coverage. Using this notification type, the application can keep the user aware of changes in the channel lock of the radio. Whenever the radio acquires or loses a channel, this notification is issued. Only supported on CDMA devices.
|
SWI_NOTIFY_RoamingStatus |
Reports the current roaming state of the modem. Using this notification type, the application can keep the user aware of changes in the received signal strength. Only supported on CDMA devices.
|
SWI_NOTIFY_Ecio | Not supported in this version of the SDK. |
SWI_NOTIFY_AuthenticationStatus | Not supported in this version of the SDK. |
SWI_NOTIFY_CallByteCounter |
Reports data traffic received and transmitted. Using this notification type, the application can keep the user aware of the amount of traffic on the current connection. The notification is issued at 1-second intervals during a data connection. Only supported on CDMA devices.
|
SWI_NOTIFY_CallConnecting |
Reports when a call connection is initiated. This notification advises the application that the process of connecting a call has initiated. There is no polling equivalent. This notification is enabled and disabled via SWI_NOTIFY_CallNotificationStatus. Only supported on CDMA devices.
|
SWI_NOTIFY_CallConnected |
Reports the successful connection of a call. This notification advises the application that a call has been successfully connected. This notification is enabled and disabled via SWI_NOTIFY_CallNotificationStatus. Only supported on CDMA devices.
|
SWI_NOTIFY_CallIncoming |
Equivalent to a ring, this advises of the incoming call type as well. This notification advises the application that there is an incoming call request. This notification is enabled and disabled via SWI_NOTIFY_CallNotificationStatus. Only supported on CDMA devices.
|
SWI_NOTIFY_CallCallerID |
Reports the standard caller ID of incoming calls (where supported by the network). This notification type passes the caller ID string to the application for incoming calls (where supported by the network). The format of the string is determined by the network. Both the standard and extended caller IDs are sent if enabled. Only supported on CDMA devices.
|
SWI_NOTIFY_CallExtendedCallerID |
Reports the extended caller ID of incoming calls (where supported by the network). This notification type passes an extended caller ID string to the application for incoming calls (where supported by the network). The format of the string is determined by the network. Both the standard and extended caller IDs are sent if enabled. Only supported on CDMA devices.
|
SWI_NOTIFY_CallDisconnected |
Reports when a call is disconnected. This notification advises the application that a call has been disconnected. This notification is enabled and disabled via SWI_NOTIFY_CallNotificationStatus. Only supported on CDMA devices.
|
SWI_NOTIFY_CallError |
Reports errors in call management operations. This notification advises the application that an error or fault has been detected in a call. This can happen anytime during a connection. This notification is enabled and disabled via SWI_NOTIFY_CallNotificationStatus. Only supported on CDMA devices.
|
SWI_NOTIFY_Prev |
Reports changes in the protocol revision available from the serving base station. This notification type advises the application when there is a change in the protocol revision supported by the serving base station. Only supported on CDMA devices.
|
SWI_NOTIFY_ActiveNam | Only supported on CDMA devices. |
SWI_NOTIFY_TechSid | Only supported on CDMA devices. |
SWI_NOTIFY_TechNid | Only supported on CDMA devices. |
SWI_NOTIFY_TechBsInfo | Only supported on CDMA devices. |
SWI_NOTIFY_TechBandClass |
Reports changes in the radio band being used (cellular or PCS). This notification type informs the application of changes in the radio band being used: cellular or PCS. Only supported on CDMA devices.
|
SWI_NOTIFY_TechRegZone | Only supported on CDMA devices. |
SWI_NOTIFY_TechPacketZone | Only supported on CDMA devices. |
SWI_NOTIFY_TechPcsBlock | Only supported on CDMA devices. |
SWI_NOTIFY_TechCellChannel | Only supported on CDMA devices. |
SWI_NOTIFY_SystemTime | Only supported on CDMA devices. |
SWI_NOTIFY_ActivationStatus | Only supported on CDMA devices. |
SWI_NOTIFY_V42BisEnabled | Only supported on CDMA devices. |
SWI_NOTIFY_CallNotificationStatus |
Enables and disables a group of notifications related to call management. This notification type is used to enable and disable the following call management notifications as a single block:
There is no actual notification data associated with CallNotificationStatus itself. Only supported on CDMA devices. |
SWI_NOTIFY_CallDormant |
Reports when a call enters dormant state. This notification advises the application that a call has been placed in dormant state. When a call leaves dormant state, the SWI_NOTIFY_CallConnected notification is issued. This notification is enabled and disabled via SWI_NOTIFY_CallNotificationStatus. Only supported on CDMA devices.
|
SWI_NOTIFY_CallPrivacy |
Reports changes in voice call privacy. When the Enhanced Privacy Option is enabled (at manufacturing time), the modem issues a request to use the Call Privacy feature whenever a voice call (both incoming and outgoing) is established. The base station can accept or reject the request depending on its settings. If voice privacy is successfully established, this notification indicates that call privacy is on. In addition, when a handover to a new base station occurs, the voice privacy feature may or may not be available at the new base station; again triggering the notificiation if there is a change. Only supported on CDMA devices.
|
SWI_NOTIFY_E911Mode |
Reports entry to, and exit from, E911 mode. This notification type advised the application when the modem enters or leaves E911 mode. Only supported on CDMA devices.
|
SWI_NOTIFY_ModemTooHotIndication | Not supported in this version of the SDK. |
SWI_NOTIFY_OTASPState |
Reports each stage of the OTASP process. This notification advises the application that a call has been placed in dormant state. This notification is enabled and disabled via SWI_NOTIFY_CallNotificationStatus. Only supported on CDMA devices.
|
SWI_NOTIFY_PowerSaveEnter |
Reports entry to power-save mode. This notification type advised the application when the modem enters power-save mode. Only supported on CDMA devices.
|
SWI_NOTIFY_PowerSaveExit |
Reports exit from power-save mode. This notification type advised the application when the modem leaves power-save mode. Only supported on CDMA devices.
|
SWI_NOTIFY_FlashBurn | Not supported in this version of the SDK. |
SWI_NOTIFY_ExcessSPCFailure | Not supported in this version of the SDK. |
SWI_NOTIFY_HdrNotificationStatus | Not supported in this version of the SDK. |
SWI_NOTIFY_Hdr_Acq |
Not supported in this version of the SDK. Use SWI_NOTIFY_Hdr_Srv_State instead.
|
SWI_NOTIFY_Hdr_Rssi |
Not supported in this version of the SDK. Use SWI_NOTIFY_Rssi_Ecio instead.
|
SWI_NOTIFY_Rssi_Ecio |
Indicates a threshold change in RSSI or EcIo. Only supported on CDMA devices.
|
SWI_NOTIFY_Hdr_Roam_Status |
Indicates a change in HDR Roam status. Only supported on CDMA devices.
|
SWI_NOTIFY_Hdr_Srv_State |
Indicates a change in HDR Service State. Only supported on CDMA devices.
|
SWI_NOTIFY_Hdr_Hybr_Pref |
Indicates a change in HDR Hybrid Pref. Only supported on CDMA devices.
|
SWI_NOTIFY_Idle_Digital_Mode | Not supported in this version of the SDK. |
SWI_NOTIFY_DDTM_Pref |
Indicates a change in DDTM pref. Only supported on CDMA devices.
|
SWI_NOTIFY_Hdr_PowerSave_Enter |
Indicates when modem has entered HDR Power save mode. Only supported on CDMA devices.
|
SWI_NOTIFY_Hdr_PowerSave_Exit |
Indicates when modem has exited HDR power save mode. Only supported on CDMA devices.
|
SWI_NOTIFY_TechHdrNotificationStatus | Not supported in this version of the SDK. |
SWI_NOTIFY_Tech_Hdr_Prev | Not supported in this version of the SDK. |
SWI_NOTIFY_Tech_Hdr_Sector | Not supported in this version of the SDK. |
SWI_NOTIFY_Tech_Hdr_State | Not supported in this version of the SDK. |
SWI_NOTIFY_Tech_Hdr_Channel | Not supported in this version of the SDK. |
SWI_NOTIFY_Tech_Hdr_Session | Not supported in this version of the SDK. |
SWI_NOTIFY_Tech_Hdr_An_Auth | Not supported in this version of the SDK. |
SWI_NOTIFY_Tech_Hdr_Drc_Val | Not supported in this version of the SDK. |
SWI_NOTIFY_Tech_Hdr_Drc_Cover | Not supported in this version of the SDK. |
SWI_NOTIFY_Tech_Hdr_Rri | Not supported in this version of the SDK. |
SWI_NOTIFY_Tech_Hdr_Stats | Not supported in this version of the SDK. |
SWI_NOTIFY_DebugRevMsg | Not supported in this version of the SDK. |
SWI_NOTIFY_SPCS_HIOTA_STATUS | Not supported in this version of the SDK. |
SWI_NOTIFY_RuimStatus | Not supported in this version of the SDK. |
SWI_NOTIFY_IOTA_Status |
Embedded IOTA status notification. Need to enable/disable the mask. Only supported on CDMA devices.
|
SWI_NOTIFY_IOTA_WAPPush |
Embedded IOTA WAP URI notification. This should be enabled to receive the WAP trigger. Only supported on CDMA devices.
|
SWI_NOTIFY_NetworkStatus |
Notifies the application of the network status with each change in service (status, roaming, cell ID, etc). Only supports GSM devices.
|
SWI_NOTIFY_Temperature |
Reports the temperature of the radio whenever it changes. If the temperature gets high, the application may elect to disconnect or throttle back on traffic. Only supports GSM devices.
|
SWI_NOTIFY_SmsSimFull |
Reports that the SIM Card memory has been filled and any subsequent SMS messages will be declined by the modem (and possibly held at the SMS Service Center). Only supports GSM devices.
|
SWI_NOTIFY_BandWrite |
Reports the status of the frequency band change request initiated by the SwiSetBandInfo function. The new frequency band will be reported by the SWI_NOTIFY_Band notification. Only supports GSM devices.
|
SWI_NOTIFY_MissedCall |
Notifies the application of the number of missed voice calls. The missed voice call count can be cleared by the application using the SwiAcknowledgeMissedCall function. The missed voice call count will not persist through a modem reset. Only supports GSM devices.
|
SWI_NOTIFY_PktSessionStatus |
Reports the current packet session status. Used with AirCard 750 or older GSM devices. When working with newer GSM devices, SWI_NOTIFY_PktSessionCall should be used instead.
|
SWI_NOTIFY_Registration | Not supported in this version of the SDK. |
SWI_NOTIFY_SmsSendReference | Not supported in this version of the SDK. |
SWI_NOTIFY_SimStatusExp |
Notifies the application of the SIM's status. This notification provides a mechanism for the modem to prompt the user to enter the PIN, PIN2, PUK, PUK2 or Special Code (MEP unlocking code). After every SIM related operation (PIN Change, Enabling of PIN Verification or PUK Entry) this notification will inform the host software of the SIM Status and the result of the previous operation. Only supported on GSM devices.
|
SWI_NOTIFY_RegistrationExp |
Provides the PLMN and/or SPN to be displayed to the user to indicate what network the mobile is registered on. This information should only be displayed if the mobile is currently registered. The application will receive a new notification every time the mobile registers on a new network. Only supported on GSM devices.
|
SWI_NOTIFY_CallProgress |
Reports the progress of voice calls. The host is notified of new incoming voice calls. Only supported on GSM devices.
|
SWI_NOTIFY_CallStatus |
Reports the connected calls state. Connected calls can be active, on hold, in a multi-party call or suspended. Only supported on GSM devices.
|
SWI_NOTIFY_ByteCounter |
Reports the transmit and receive byte counters on the modem. The byte counters can be cleared by the application using the SwiClearDataCounters function. The byte counters will not persist through a modem reset. Only supported on GSM devices.
|
SWI_NOTIFY_PhonebookReady |
Reports the availability of Phonebook service (includes the ability to read and edit the phonebooks). Only supported on GSM devices
|
SWI_NOTIFY_PhonebookEntry |
Reports a phonebook entry. Currently, only ADN phonebook is read from this notification. Note, when a new phonebook entry is added, a notification is not sent. Only supported on GSM devices.
|
SWI_NOTIFY_PlmnMode |
Reports the success of the PLMN mode change request initiated by the SwiSetPLMNMode function. Only supported on GSM devices.
|
SWI_NOTIFY_PlmnAvailable |
Reports the success of the PLMN scan initiated by the SwiStartPLMNSearch function. This notification will indicate if any networks were found in the scan. The SwiGetPLMNSelection function should be used to fetch the members of the list of found networks. Only supported on GSM devices.
|
SWI_NOTIFY_ModemDisabled |
Reports the modem's enable/disable status. Only supported on GSM devices.
|
SWI_NOTIFY_PlmnReady |
Reports the availability of manual PLMN selection service. Only supported on GSM devices.
|
SWI_NOTIFY_VoiceMessage |
Notifies the application of a change in voice message waiting flags that reside on the SIM. These flags identify whether or not voice messages and data messages are being stored by the network for retrieval by the mobile. Since this notification will only be sent to the application if there is a change in the mailbox flags it is necessary for the application to call the SwiGetVoiceMessage function to get the initial state of the mailbox flags at startup. Only supported on GSM devices
|
SWI_NOTIFY_IconGprsState |
Allows the application to hide, gray out or display the GPRS icon according to different carrier requirements. When the notification is enabled, a notification is immediately sent to the application. Only supported on GSM devices
|
SWI_NOTIFY_IconRoamState |
Allows the application to hide, gray out or display the ROAMING icon according to different carrier requirements. When the notification is enabled, a notification is immediately sent to the application. Only supported on GSM devices
|
SWI_NOTIFY_CallForwarded |
Provides an indication to the application to display the "Call Forwarded" string to the user. Some subscriptions on some networks notify the user when a call is forwarded or has been forwarded. Only supported on GSM devices.
|
SWI_NOTIFY_CFIcon |
Allows the application to gray out or display the Call Forwarding icon depending on the users current call forwarding configuration. When the notification is enabled, a notification is immediately sent to the application. Only supported on GSM devices.
|
SWI_NOTIFY_STKCommand | Not supported in this version of the SDK. |
SWI_NOTIFY_DataRate |
Updates the application with GPRS data rate statistics. This notification is sent periodically once it is enabled. If the data rate information has not change since the last SWI_NOTIFY_DataRate notification was sent then no notification will be sent. Only supported on GSM devices.
|
SWI_NOTIFY_ServiceIcon |
Provides the application with the service status information needed to inform the user of its current GPRS/EDGE service state.
|
SWI_NOTIFY_TTYControl | Not supported in this version of the SDK. |
SWI_NOTIFY_PktSessionCall |
Packet session call status. Used with AirCard 875 or newer devices. Only supported on GSM devices.
|
SWI_NOTIFY_NvStore |
NV backup notification. Used before a firmware upgrade is initiated to instruct the modem to back up information stored in non-volatile memory. Only supported on GSM devices.
|
SWI_NOTIFY_HSDPA_TestChan |
HSDPA test channel. Only supported on GSM devices.
|
SWI_NOTIFY_GsmSystemStatus |
GSM System Status. Notifies the application of system status with each change in service. Only supported on GSM devices.
|
SWI_NOTIFY_RscpEcIo |
GSM Received Signal Code Power(RSCP) and Energy per Chip per Power Density (Ec/Io) of the active set's strongest cells. This notifications is to be used for diagnostic purposes. It will be sent periodically and only if the reported data has changed. Information on the strongest active cells will be reported in order of strongest to weakest for a maximum of six cells. These measurements are valid only for UMTS, if the current service is GSM, no information shall be reported in this notification. The Ec/Io value will represent -dB in half step increments. For example, a reported value of 0x0015 means Ec/Io = -10.5dB. Only supported on GSM devices.
|
SWI_NOTIFY_GsmCellInfo |
GSM 2G Cell Information. This notifications is to be used for diagnostic purposes. It will be sent periodically and only if the reported data has changed. Only supported on GSM devices.
|
SWI_NOTIFY_GsmProfileChange |
GSM Profile Change. This notification indicates that a Connection Profile has changed and it gives the profile ID and info type that the application may wish to refresh. Only supported on GSM devices.
|
SWI_NOTIFY_GsmDefaultChange |
GSM Default Profile Change. This notification indicates that a default Connection Profile has changed. Only supported on GSM devices.
|
SWI_NOTIFY_SmsReady |
Reports the availability of SMS service (includes the ability to read SMS messages from the SIM). Only supported on GSM devices
|
SWI_NOTIFY_SmsStoreExp |
Indicates that the SMS copy initiated by the calling of the SwiStoreSMSMessageExp API is complete and that the application is now free to take another mobile-originated action using SwiStoreSMSMessageExp or SwiSendSMSMessageExp. This notification will report the success of the last SMS copy request. Only supported on GSM devices.
|
SWI_NOTIFY_SmsSendExp |
Indicates that the SMS send initiated by the calling of the SwiSendSMSMessageExp API is complete and that the application is now free to take another mobile-originated action using SwiStoreSMSMessageExp or SwiSendSMSMessageExp. This notification will report the success of the last SMS send request. Only supported on GSM devices.
|
SWI_NOTIFY_SmsDeliver |
Delivers an incoming SMS message or segment that is not to be stored on the SIM to the application.
|
SWI_NOTIFY_SmsReceived | Not supported in this version of the SDK. |
SWI_NOTIFY_SmsSubmit | Not supported in this version of the SDK. |
SWI_NOTIFY_SmsStatusReport |
Delivers an incoming SMS status report to the application. Only supported on GSM devices.
|
SWI_NOTIFY_SmsSimStatus | Not supported in this version of the SDK. |
SWI_NOTIFY_SSPasswordStatus |
Indicates that the network is request a particular supplementary service password. This notification may be a result of the application initiating the password registration process through the SwiStartSSPassReg API or the network may have initiated the process. The application is expected to answer this network request for password using the SwiSetSSPassword API. Only supported on GSM devices. |
SWI_NOTIFY_SSRespOK |
Indicates that a supplementary service action completed successfully. This notification is a network response to a supplementary service request that was completed successful and returned no information. The application uses the SwiSetSSRequest API to make supplementary service requests. The handle returned by this API call is used to tie the request to its network response. Only supported on GSM device.
|
SWI_NOTIFY_SSRespFwdInfo |
Indicates that a supplementary service action completed successfully. This notification is a network response to a supplementary service request and it gives call forwarding service status. The application uses the SwiSetSSRequest API to make supplementary service requests. The handle returned by this API call is used to tie the request to its network response. Only supported on GSM device.
|
SWI_NOTIFY_SSRespCallBar |
Indicates that a supplementary service action completed successfully. This notification is a network response to a supplementary service request and it gives call barring service status. The application uses the SwiSetSSRequest API to make supplementary service requests. The handle returned by this API call is used to tie the request to its network response. Only supported on GSM device.
|
SWI_NOTIFY_SSRespInfoData |
Indicates that a supplementary service action completed successfully. This notification is a network response to a supplementary service request and it gives service status on the requested supplementary service. The application uses the SwiSetSSRequest API to make supplementary service requests. The handle returned by this API call is used to tie the request to its network response. Only supported on GSM device. |
SWI_NOTIFY_SSRespStatus |
Indicates that a supplementary service action completed successfully. This notification is a network response to a supplementary service request and it gives the service status on the requested supplementary service. The application uses the SwiSetSSRequest API to make supplementary service requests. The handle returned by this API call is used to tie the request to its network response. Only supported on GSM device.
|
SWI_NOTIFY_SSRespFwdNum |
Indicates that a supplementary service action completed successfully. This notification is a network response to a supplementary service request and it returns a single forwarded number. The application uses the SwiSetSSRequest API to make supplementary service requests. The handle returned by this API call is used to tie the request to its network response. Only supported on GSM device.
|
SWI_NOTIFY_SSRespBSList |
Indicates that a supplementary service action completed successfully. This notification is a network response to a supplementary service request and it returns a list of basic service groups in used for the requested supplementary service. The application uses the SwiSetSSRequest API to make supplementary service requests. The handle returned by this API call is used to tie the request to its network response. Only supported on GSM device.
|
SWI_NOTIFY_SSRespFwdList |
Indicates that a supplementary service action completed successfully. This notification is a network response to a supplementary service request and it returns a list of call forwarding information for the requested supplementary service. The application uses the SwiSetSSRequest API to make supplementary service requests. The handle returned by this API call is used to tie the request to its network response. Only supported on GSM device. |
SWI_NOTIFY_SSRespRaw |
Indicates that a supplementary service action completed successfully. This notification is a network response to a supplementary service request and it returns a raw binary data. The application uses the SwiSetSSRequest API to make supplementary service requests. The handle returned by this API call is used to tie the request to its network response. Only supported on GSM device.
|
SWI_NOTIFY_SSRespPassword |
Indicates that a supplementary service action completed successfully. This notification is a network response to a supplementary service request and it returns password information. The application uses the SwiSetSSRequest API to make supplementary service requests. The handle returned by this API call is used to tie the request to its network response. Only supported on GSM device. |
SWI_NOTIFY_SSRespClir |
Indicates that a supplementary service action completed successfully. This notification is a network response to a supplementary service request and it returns CLIR service and setting information. The application uses the SwiSetSSRequest API to make supplementary service requests. The handle returned by this API call is used to tie the request to its network response. Only supported on GSM device.
|
SWI_NOTIFY_SSRespError |
Indicates that a supplementary service action completed unsuccessfully. This notification is a network response to a supplementary service request and it returns error cause information. The application uses the SwiSetSSRequest API to make supplementary service requests. The handle returned by this API call is used to tie the request to its network response. Only supported on GSM device.
|
SWI_NOTIFY_SSRespReject |
Indicates that a supplementary service action completed unsuccessfully. This notification is a network response to a supplementary service request and it returns rejection cause information. The application uses the SwiSetSSRequest API to make supplementary service requests. The handle returned by this API call is used to tie the request to its network response. Only supported on GSM device.
|
SWI_NOTIFY_SSRespCancel |
Indicates that a supplementary service action completed cancelled. This notification is a network response to a supplementary service request and it returns cancel cause. The application uses the SwiSetSSRequest API to make supplementary service requests. The handle returned by this API call is used to tie the request to its network response. Only supported on GSM device.
|
SWI_NOTIFY_SSRespRelease |
Indicates that an outstanding supplementary service action has been released. This notification is a network response to a supplementary service request. completed cancelled. This notification is a network response to a supplementary service request and it returns cancel cause. The application uses the SwiSetSSRequest API to make supplementary service requests. The handle returned by this API call is used to tie the request to its network response. Only supported on GSM device.
|
SWI_NOTIFY_SSNotify |
Indicates that a particular supplemenary service is active. This notification is a network indication. Only supported on GSM device.
|
SWI_NOTIFY_SS_USSD_REQ | Not supported in this version of the SDK. |
SWI_NOTIFY_END_NOTIFY | Place holder. Must be last entry in this list. |
SWI_API SWI_RCODE SwiDeRegisterCallback | ( | SWI_CALLBACK_EX | pCallback | ) |
This function de-registers an application's callback handler.
After calling this function, notifications will no longer be passed to the specified callback handler.
[OUT] | pCallback: Callback function pointer of type SWI_CALLBACK_EX to be de-registered. |
SWI_RCODE_INVALID_PAR: An invalid parameter was passed
See SWI_RCODE for additional information.
SWI_API SWI_RCODE SwiEnableNotif | ( | SWI_STRUCT_NotifList * | psList, | |
U32 | timeout | |||
) |
This function is used to enable a list of notifications simultaneously.
This function is only supported on GSM devices.
[IN] | psList: List of notifications to enable. See SWI_TYPE_Notify for a complete list of notifications. Only GSM notifications work with this function. | |
[IN] | timeout: Response timeout value in milliseconds. |
See SWI_RCODE for other error return codes.
SWI_API SWI_RCODE SwiNotify | ( | SWI_TYPE_Notify | eNotify, | |
U32 | timeout | |||
) |
This function turns the notification ON for the specified event.
Calling this function enables event notifications to be routed to the callback handler registered earlier using SwiRegisterCallback. If notifications are enabled when there is no registered callback function, the API will silently discard them as they arrive. Similarly, if a filter were defined, notifications will be silently discarded.
Modem resets disable notifications (but leave the callback function registered). You must explicitly re-enable notifications if a modem reset is detected (SWI_NOTIFY_Reset).
Once enabled, the modem will always send the current state of the notification object. When that notification is generated will depend on the object itself. After the initial indication, notifications are only generated when there is a change in state. Occasionally, notifications are generated at predefined intervals. See a description of the notification object for more information.
The following notifications are enabled by default and can not be disabled:
All other notifications are disabled by default and must be enabled.
Use SwiStopNotify to disable a notification event.
With GSM devices, multiple notifications can be enabled simultaneously using SwiEnableNotif.
[IN] | eNotify: SWI_TYPE_Notify notification to enable | |
[IN] | timeout: Response timeout value in milliseconds |
See SWI_RCODE for additional information.
SWI_API SWI_RCODE SwiRegisterCallback | ( | SWI_CALLBACK_EX | pCallback, | |
U64 | nNotifications | |||
) |
This function registers a callback handler to receive event notifications.
This function can be called immediately after SwiApiStartup to ensure the client application receives critical events.
The following notifications are enabled by default and can not be disabled:
Callback functions must be (re)registered every time SwiSelectAirServer is called. This ensures that features of the newly bound air server will have access to all the callback pointers.
On termination, SwiDeRegisterCallback should be called for each callback function previously registered.
All other notifications are disabled by default and must be enabled.
[OUT] | pCallback: Callback function pointer of type SWI_CALLBACK_EX to be registered for incoming notifications. | |
[IN] | nNotifications: Notification filter. nNotifications should be set to 0xFFFFFFFFFFFFFFFF to receive all possible notifications. |
SWI_API SWI_RCODE SwiStopAllNotif | ( | U32 | timeout | ) |
This function is used to stop the modem from sending all notifications.
This function is only supported on GSM devices.
[IN] | timeout: Response timeout value in milliseconds. |
See SWI_RCODE for other error return codes.
SWI_API SWI_RCODE SwiStopNotify | ( | SWI_TYPE_Notify | eNotify, | |
U32 | timeout | |||
) |
This function turns the notification OFF for the specified event.
After calling this function, the specified notifications will not be forwarded to the client's callback function. SwiNotify must be used to re-enable the notification.
The following notifications are enabled by default and can not be disabled:
[IN] | eNotify: SWI_TYPE_Notify notification to disable | |
[IN] | timeout: Response timeout value in milliseconds |