|
LinuxSDK
V1.4.0.5
|
Header file for for GSM APIs related to the SIM Application Toolkit. More...
Go to the source code of this file.
Data Structures | |
| struct | SWI_STRUCT_STK_Command |
| struct | SWI_STRUCT_STK_Notif_Command |
| struct | SWI_STRUCT_STK_RsepUserAck |
| struct | SWI_STRUCT_STK_RsepGetInput |
| struct | SWI_STRUCT_STK_RsepUserConfirm |
| struct | SWI_STRUCT_STK_RsepSelectItem |
Macros | |
| #define | OBJ_CNS_STK_CMD_STRING_LENGTH 236 |
| #define | OBJ_CNS_STK_RESP_USER_ACK_LENGTH 5 |
| #define | OBJ_CNS_STK_RESP_GET_INPUT_LENGTH 245 |
| #define | OBJ_CNS_STK_RESP_GET_INPUT_STRING_LENGTH 238 |
| #define | OBJ_CNS_STK_RESP_USER_CNF_LENGTH 5 |
| #define | OBJ_CNS_STK_RESP_SELECT_ITEM_LENGTH 5 |
Typedefs | |
| typedef struct SWI_STRUCT_STK_RsepUserAck | SWI_STRUCT_STK_RespUserAck |
| typedef struct SWI_STRUCT_STK_RsepGetInput | SWI_STRUCT_STK_RespGetInput |
Functions | |
| SWI_API SWI_RCODE | SwiGetSIMToolKitCommand (struct SWI_STRUCT_STK_Command *STKCommandp, swi_uint32 timeout) |
| SWI_API SWI_RCODE | SwiSetSTKUserAcknowledge (const struct SWI_STRUCT_STK_RsepUserAck *RespUserAckp, swi_uint32 timeout) |
| SWI_API SWI_RCODE | SwiSetSTKSetInput (const struct SWI_STRUCT_STK_RsepGetInput *RespGetInputp, swi_uint32 timeout) |
| SWI_API SWI_RCODE | SwiSetSTKUserConfirmationResponse (const struct SWI_STRUCT_STK_RsepUserConfirm *RespUserConfirmp, swi_uint32 timeout) |
| SWI_API SWI_RCODE | SwiSetSTKUserSelectedMenuItem (const struct SWI_STRUCT_STK_RsepSelectItem *RespSelectItemp, swi_bool *Resultp, swi_uint32 timeout) |
Header file for for GSM APIs related to the SIM Application Toolkit.
Copyright: © 2011 Sierra Wireless, Inc. all rights reserved
| #define OBJ_CNS_STK_CMD_STRING_LENGTH 236 |
| #define OBJ_CNS_STK_RESP_GET_INPUT_LENGTH 245 |
| #define OBJ_CNS_STK_RESP_GET_INPUT_STRING_LENGTH 238 |
| #define OBJ_CNS_STK_RESP_SELECT_ITEM_LENGTH 5 |
| #define OBJ_CNS_STK_RESP_USER_ACK_LENGTH 5 |
| #define OBJ_CNS_STK_RESP_USER_CNF_LENGTH 5 |
| typedef struct SWI_STRUCT_STK_RsepGetInput SWI_STRUCT_STK_RespGetInput |
| typedef struct SWI_STRUCT_STK_RsepUserAck SWI_STRUCT_STK_RespUserAck |
| enum SWI_TYPE_STK_Key |
| enum SWI_TYPE_STKPriority |
| enum SWI_TYPE_STKReturn |
| SWI_API SWI_RCODE SwiGetSIMToolKitCommand | ( | struct SWI_STRUCT_STK_Command * | STKCommandp, |
| swi_uint32 | timeout | ||
| ) |
This function is used to set up a notification to the host anytime the SIM issues a Sim Application Toolkit command. The notification will contain all the necessary information to inform the host of any further action required. If the Display Text Available flag is set then the host should first get this display text so that the user can be informed of any required information and then the other information can be fetched using the Set Request function.
| STKCommandp,: | [IN/OUT] STK Command data |
| timeout,: | [IN] Response timeout value in milliseconds. |
| SWI_API SWI_RCODE SwiSetSTKSetInput | ( | const struct SWI_STRUCT_STK_RsepGetInput * | RespGetInputp, |
| swi_uint32 | timeout | ||
| ) |
This function is used by the host to return to the SIM the response to get input command. The returned string is a maximum length of 120 characters coded in UCS2 (ie 240 bytes).In case of timeouts, nothing is sent to the modem, the modem will handle its own timeouts.
| RespGetInputp,: | [IN] User input info |
| timeout,: | [IN] Response timeout value in milliseconds. |
| SWI_API SWI_RCODE SwiSetSTKUserAcknowledge | ( | const struct SWI_STRUCT_STK_RsepUserAck * | RespUserAckp, |
| swi_uint32 | timeout | ||
| ) |
This function is used to send a user acknowledge to the SIM. If the user has acknowledged the displayed message then this object is used to return the OK to the SIM. If the STK command times out, then nothing is returned to the SIM and the SIM will handle its own timeout. If the user has requested to back out of the current STK command then this object informs the SIM of this user action. Note that the backwards request will have no affect on the first level of the main menu. If the user has requested to abort the current STK command session then this object informs the SIM of this user action. This command has no effect on the first level of the main menu. If the user interface is busy when a normal priority display text command is received then the host must use this object to inform the SIM that the MMI is busy right now.
| RespUserAckp,: | [IN] User return type |
| timeout,: | [IN] Response timeout value in milliseconds. |
| SWI_API SWI_RCODE SwiSetSTKUserConfirmationResponse | ( | const struct SWI_STRUCT_STK_RsepUserConfirm * | RsepUserConfirmp, |
| swi_uint32 | timeout | ||
| ) |
This function is used by the host to return a user confirmation back to the modem. The host can only return a Yes or No response using this object. In case of timeouts, nothing is sent to the modem, the modem will handle its own timeouts.
| RsepUserConfirmp,: | [IN] User response info |
| timeout,: | [IN] Response timeout value in milliseconds. |
| SWI_API SWI_RCODE SwiSetSTKUserSelectedMenuItem | ( | const struct SWI_STRUCT_STK_RsepSelectItem * | RespSelectItemp, |
| swi_bool * | Resultp, | ||
| swi_uint32 | timeout | ||
| ) |
This function is used by the host to select an item in a menu.. If there is no proactive command in progress then it would select an item from the main menu, otherwise if a Select Item proactive command had been issued, then it would select an item from that list.
| RespSelectItemp,: | [IN] User selected menu item info |
| timeout,: | [IN] Response timeout value in milliseconds. |