Mobile Context Service
[Mobile Services]


Detailed Description

This service set gives access to the available mobile contexts.

It also gives access to an aggregated view of the current calls and history calls.

Amongst the available contexts, one is called the default context. The default context is the 'main' context of a device. For exemple, on a GSM phone, the default context is the context related to the GSM phone module, even if the phone has VoIP functionalities. And on a VoIP phone, the default context is the 'main' VoIP context, defined by the user.


Data Structures

struct  _AlpMblAddressList
struct  _AlpMblContextCallCounter
struct  _AlpMblContextList
struct  _AlpMblContextRestrictedContact
struct  _AlpMblContextRestrictedContactByAddress
struct  _AlpMblContextRestrictedContactList
struct  _AlpMblContextRestrictionListFacility
struct  _AlpMblCost
struct  _AlpMblDataCall
struct  _AlpMblDataCallList
struct  _AlpMblOwnNumber

Defines

#define ALP_MBL_CONTEXT_ANSWER_MODE_ANY_KEY   ((AlpMblContextAnswerMode) 1)
 Any hard key will answer.
#define ALP_MBL_CONTEXT_ANSWER_MODE_AUTOMATIC   ((AlpMblContextAnswerMode) 2)
 Call is answered automaticly.
#define ALP_MBL_CONTEXT_ANSWER_MODE_KEY_OR_BUTTON   ((AlpMblContextAnswerMode) 0)
 OFF HOOK key will answer, or answer soft key.
#define ALP_MBL_CONTEXT_BLACK_LIST   1
 Black list.
#define ALP_MBL_CONTEXT_CALL_COUNTER_ALL   (ALP_MBL_CONTEXT_CALL_COUNTER_VOICE_ALL | ALP_MBL_CONTEXT_CALL_COUNTER_DATA_ALL)
 All counter.
#define ALP_MBL_CONTEXT_CALL_COUNTER_DATA_ALL   (ALP_MBL_CONTEXT_CALL_COUNTER_DATA_CS | ALP_MBL_CONTEXT_CALL_COUNTER_DATA_PS_ALL)
 All data counter.
#define ALP_MBL_CONTEXT_CALL_COUNTER_DATA_CS   ((AlpMblContextCallCounterType) 0x04)
 Circuit switch data call counter.
#define ALP_MBL_CONTEXT_CALL_COUNTER_DATA_PS_ALL   (ALP_MBL_CONTEXT_CALL_COUNTER_DATA_PS_IN | ALP_MBL_CONTEXT_CALL_COUNTER_DATA_PS_OUT)
 All packet switch byte counter.
#define ALP_MBL_CONTEXT_CALL_COUNTER_DATA_PS_IN   ((AlpMblContextCallCounterType) 0x08)
 Receive packet switch byte counter.
#define ALP_MBL_CONTEXT_CALL_COUNTER_DATA_PS_OUT   ((AlpMblContextCallCounterType) 0x10)
 Sent packet switch byte counter.
#define ALP_MBL_CONTEXT_CALL_COUNTER_VIDEO_ALL   (ALP_MBL_CONTEXT_CALL_COUNTER_VIDEO_IN | ALP_MBL_CONTEXT_CALL_COUNTER_VIDEO_OUT)
 All video call counter.
#define ALP_MBL_CONTEXT_CALL_COUNTER_VIDEO_IN   ((AlpMblContextCallCounterType) 0x20)
 Receive video call counter.
#define ALP_MBL_CONTEXT_CALL_COUNTER_VIDEO_OUT   ((AlpMblContextCallCounterType) 0x40)
 Dialed video call counter.
#define ALP_MBL_CONTEXT_CALL_COUNTER_VOICE_ALL   (ALP_MBL_CONTEXT_CALL_COUNTER_VOICE_IN | ALP_MBL_CONTEXT_CALL_COUNTER_VOICE_OUT)
 All voice call counter.
#define ALP_MBL_CONTEXT_CALL_COUNTER_VOICE_IN   ((AlpMblContextCallCounterType) 0x01)
 Receive voice call counter.
#define ALP_MBL_CONTEXT_CALL_COUNTER_VOICE_OUT   ((AlpMblContextCallCounterType) 0x02)
 Dialed voice call counter.
#define ALP_MBL_CONTEXT_CLIR_ACCORDING_SUBSCRIPTION   0
 the presentation indicator is used according to the subscription of the CLIR service
#define ALP_MBL_CONTEXT_CLIR_INVOCATION   1
 the calling subscriber choose to restrict the presentation of the Caller Id to the called party when originating a call.
#define ALP_MBL_CONTEXT_CLIR_STATUS_NOT_PROVISIONED   0
 the CLIR Supplementary Service is deactivated/ not provisioned
#define ALP_MBL_CONTEXT_CLIR_STATUS_PRESENTATION_PERMANENTLY_RESTRICTED   1
 if subscribed-to in the permanent mode, the network shall automatically invoke the CLIR Supplementary Service for each outgoing call.
#define ALP_MBL_CONTEXT_CLIR_STATUS_PRESENTATION_TEMPORARILY_ALLOWED   4
 if subscribed-to in the temporary mode with the default value "presentation allowed" then the network shall only invoke the CLIR Supplementary Service if requested by subscriber at the time of call request.
#define ALP_MBL_CONTEXT_CLIR_STATUS_PRESENTATION_TEMPORARILY_RESTRICTED   3
 if subscribed-to in the temporary mode with the default value "presentation restricted" then the network shall automatically invoke the CLIR Supplementary Service for each outgoing call unless CLIR is suppressed by subscriber request at the time of call request.
#define ALP_MBL_CONTEXT_CLIR_STATUS_UNKNOWN   2
 the CLIR status is unknown (eg no network,never set...)
#define ALP_MBL_CONTEXT_CLIR_SUPPRESSION   2
 the calling subscriber choose to allow the presentation of the Caller Id to the called party when originating a call.
#define ALP_MBL_CONTEXT_EMERGENCY_NUMBERS_AVAILABLE   ((AlpMblNotificationId) 4)
 Emergency numbers are available.
#define ALP_MBL_CONTEXT_FIX_DIAL_LIST   2
 Fix Dialing List.
#define ALP_MBL_CONTEXT_INVALID_CONTEXT_ID   ((AlpMblContextId) 0)
 Invalid context id.
#define ALP_MBL_CONTEXT_LIST_COUNT   (ALP_MBL_CONTEXT_FIX_DIAL_LIST + 1)
 Total count of restricted list.
#define ALP_MBL_CONTEXT_NETWORK_ID_CHANGE   ((AlpMblNotificationId) 3)
 The network id of a mobile context has changed.
#define ALP_MBL_CONTEXT_NOTIFICATION_AVAILABLE_LINES_CHANGE   ((AlpMblNotificationId) 15)
 The available line of a cellular mobile context has changed.
#define ALP_MBL_CONTEXT_NOTIFICATION_CALL_LIST_UPDATE   ((AlpMblNotificationId) 19)
 The status of one or more call have changed, so we have update the entire call list.
#define ALP_MBL_CONTEXT_NOTIFICATION_CLIR_STATUS_CHANGE   ((AlpMblNotificationId) 10)
 The status of the CLIR service has changed.
#define ALP_MBL_CONTEXT_NOTIFICATION_COST_CHANGE   ((AlpMblNotificationId) 11)
 The cost of Mobile Context has changed.
#define ALP_MBL_CONTEXT_NOTIFICATION_COST_LIMIT_CHANGE   ((AlpMblNotificationId) 12)
 The cost limit of Mobile Context has changed.
#define ALP_MBL_CONTEXT_NOTIFICATION_CURRENCY_CHANGE   ((AlpMblNotificationId) 13)
 The currency of Mobile Context has changed.
#define ALP_MBL_CONTEXT_NOTIFICATION_CURRENT_LINE_CHANGE   ((AlpMblNotificationId) 16)
 The current line of a cellular mobile context has changed.
#define ALP_MBL_CONTEXT_NOTIFICATION_HOME_OPERATOR_ID_AVAILABLE   ((AlpMblNotificationId) 6)
 Home operator id is available.
#define ALP_MBL_CONTEXT_NOTIFICATION_MISSED_CALL_COUNT_CHANGE   ((AlpMblNotificationId) 8)
 The count of missed call has changed.
#define ALP_MBL_CONTEXT_NOTIFICATION_NEW_CALL   ((AlpMblNotificationId) 2)
 There is a new call for a specific mobile context.
#define ALP_MBL_CONTEXT_NOTIFICATION_OWN_NUMBERS_AVAILABLE   ((AlpMblNotificationId) 9)
 The own phone numbers (voice, fax, data) are available.
#define ALP_MBL_CONTEXT_NOTIFICATION_RESTRICTION_LIST_CHANGE   ((AlpMblNotificationId) 17)
 The content of a restricted list has changed.
#define ALP_MBL_CONTEXT_NOTIFICATION_RESTRICTION_LIST_STATUS_CHANGE   ((AlpMblNotificationId) 18)
 The status of a restricted list has changed (activate/desactivate...).
#define ALP_MBL_CONTEXT_NOTIFICATION_STATUS_CHANGE   ((AlpMblNotificationId) 1)
 The status of a mobile context has changed.
#define ALP_MBL_CONTEXT_NOTIFICATION_SUBSCRIBER_ID_AVAILABLE   ((AlpMblNotificationId) 5)
 Subscriber id is available.
#define ALP_MBL_CONTEXT_NOTIFICATION_UNIT_PRICE_CHANGE   ((AlpMblNotificationId) 14)
 The unit's price of Mobile Context has changed.
#define ALP_MBL_CONTEXT_NOTIFICATION_VOICE_MAIL_INDICATOR_CHANGE   ((AlpMblNotificationId) 7)
 The status of the voice mail indicator has changed.
#define ALP_MBL_CONTEXT_RESTRICTED_CONTACT_BY_ADDRESS   0
 The restricted contact structure contains an address (and a name).
#define ALP_MBL_CONTEXT_RESTRICTION_LIST_CONTACT_ADDED   0
 action 'add' on a restriction list
#define ALP_MBL_CONTEXT_RESTRICTION_LIST_CONTACT_REMOVED   1
 action 'remove' on a restriction list
#define ALP_MBL_CONTEXT_RESTRICTION_LIST_CONTACT_RETRIEVED   3
 action 'retrieved' on a restriction list
#define ALP_MBL_CONTEXT_RESTRICTION_LIST_CONTACT_UPDATED   2
 action 'edit' on a restriction list
#define ALP_MBL_CONTEXT_RESTRICTION_LIST_DISABLE   0
 The restriction list is disabled.
#define ALP_MBL_CONTEXT_RESTRICTION_LIST_ENABLE   1
 The restriction list is enabled.
#define ALP_MBL_CONTEXT_RESTRICTION_LIST_FACILITY_ADDRESS_SIZE   0
 The restriction list contact address size.
#define ALP_MBL_CONTEXT_RESTRICTION_LIST_FACILITY_NAME_SIZE   1
 The restriction list contact name size.
#define ALP_MBL_CONTEXT_RESTRICTION_LIST_NOT_SUPPORTED   2
 The restriction list is not supported.
#define ALP_MBL_CONTEXT_STATUS_CONNECTED   ((AlpMblContextStatus) 1)
 Context is connected.
#define ALP_MBL_CONTEXT_STATUS_CONNECTING   ((AlpMblContextStatus) 3)
 Context is connecting.
#define ALP_MBL_CONTEXT_STATUS_DISCONNECTED   ((AlpMblContextStatus) 2)
 Context is disconnected.
#define ALP_MBL_CONTEXT_STATUS_DISCONNECTING   ((AlpMblContextStatus) 4)
 Context is disconnecting.
#define ALP_MBL_CONTEXT_STATUS_UNKNOWN   ((AlpMblContextStatus) 0)
 Status is unknown - initial status.
#define ALP_MBL_CONTEXT_WHITE_LIST   0
 While list.

Typedefs

typedef _AlpMblAddressList AlpMblAddressList
 List of address.
typedef unsigned char AlpMblContextAnswerMode
 Context answer mode, see ALP_MBL_CONTEXT_ANSWER_MODE_XXX defines.
typedef void(* AlpMblContextAvailableLinesChangeCallbackPtr )(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblLineList iAvailableLines)
typedef _AlpMblContextCallCounter AlpMblContextCallCounter
 Call counter information.
typedef unsigned char AlpMblContextCallCounterType
 Call counter type, see ALP_MBL_CONTEXT_CALL_COUNTER_XXX defines.
typedef unsigned char AlpMblContextCallerIdRestrictionAdjustment
 Caller Id restriction status, see ALP_MBL_CONTEXT_CLIR_XXX defines.
typedef unsigned char AlpMblContextCallerIdRestrictionStatus
 Caller Id restriction status, see ALP_MBL_CONTEXT_CLIR_STATUS_XXX defines.
typedef void(* AlpMblContextCallListUpdateCallbackPtr )(void *iUserDataP, AlpMblContextId iMobileContextId, uint8_t iCallCount, AlpMblCallUpdateInfo *iCallUpdateInfoP)
typedef void(* AlpMblContextClirStatusChangeCallbackPtr )(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblContextCallerIdRestrictionStatus iPreviousStatus, AlpMblContextCallerIdRestrictionStatus iCurrentStatus)
typedef void(* AlpMblContextCostChangeCallbackPtr )(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblCost iPrevious, AlpMblCost iCurrent)
typedef void(* AlpMblContextCostLimitChangeCallbackPtr )(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblCost iPrevious, AlpMblCost iCurrent)
typedef void(* AlpMblContextCurrencyChangeCallbackPtr )(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblCurrency iPrevious, AlpMblCurrency iCurrent)
typedef void(* AlpMblContextCurrentLineChangeCallbackPtr )(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblLineId iPrevious, AlpMblLineId iCurrent)
typedef char AlpMblContextDescription [32]
 Context description.
typedef void(* AlpMblContextEmergencyNumbersAvailableCallbackPtr )(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblAddressList iAddressList)
typedef void(* AlpMblContextHomeOperatorIdAvailableCallbackPtr )(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblOperatorId iOperatorId)
typedef unsigned char AlpMblContextId
 Context identifier.
typedef _AlpMblContextList AlpMblContextList
 List of context.
typedef void(* AlpMblContextMissedCallCountChangeCallbackPtr )(void *iUserDataP, AlpMblContextId iMobileContextId, uint8_t iPreviousCount, uint8_t iCurrentCount)
typedef void(* AlpMblContextNetworkIdChangeCallbackPtr )(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblNetworkId iPrevious, AlpMblNetworkId iCurrent)
typedef void(* AlpMblContextNewCallCallbackPtr )(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblCallId iCallId, AlpMblCallDirection iDirection, AlpMblCallType iType)
typedef void(* AlpMblContextOwnNumbersAvailableCallbackPtr )(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblOwnNumber *iOwnNumberP)
typedef _AlpMblContextRestrictedContact AlpMblContextRestrictedContact
typedef AlpMblAddress AlpMblContextRestrictedContactAddress
 Restricted contact phone number.
typedef _AlpMblContextRestrictedContactByAddress AlpMblContextRestrictedContactByAddress
typedef int32_t AlpMblContextRestrictedContactIndex
 Storage index.
typedef _AlpMblContextRestrictedContactList AlpMblContextRestrictedContactList
 List of restricted contacts.
typedef char AlpMblContextRestrictedContactName [128]
 Restricted contact name.
typedef int32_t AlpMblContextRestrictedContactType
 what kind of informations are provided by the restricted contact structure (see ALP_MBL_CONTEXT_RESTRICTED_CONTACT_BY_xxx)
typedef uint16_t AlpMblContextRestrictionList
 Restriction List index.
typedef uint16_t AlpMblContextRestrictionListAction
 Possible action with restriction List.
typedef void(* AlpMblContextRestrictionListChangeCallbackPtr )(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblContextRestrictionList iList, AlpMblContextRestrictionListAction iAction, AlpMblContextRestrictedContact iContact)
typedef _AlpMblContextRestrictionListFacility AlpMblContextRestrictionListFacility
 List of restricted contacts.
typedef uint16_t AlpMblContextRestrictionListStatus
 Possible status of a restriction List.
typedef void(* AlpMblContextRestrictionListStatusChangeCallbackPtr )(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblContextRestrictionList iList, AlpMblContextRestrictionListStatus iPrevious, AlpMblContextRestrictionListStatus iCurrent)
typedef unsigned char AlpMblContextStatus
 Context status, see ALP_MBL_CONTEXT_STATUS_XXX defines.
typedef void(* AlpMblContextStatusChangeCallbackPtr )(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblContextStatus iPrevious, AlpMblContextStatus iCurrent, alp_status_t iError)
typedef char AlpMblContextSubscriberId [32]
 Context subscriber identity.
typedef void(* AlpMblContextSubscriberIdAvailableCallbackPtr )(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblContextSubscriberId iSubscriberId)
typedef char AlpMblContextType [12]
 Context type.
typedef void(* AlpMblContextUnitPriceChangeCallbackPtr )(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblCost iPrevious, AlpMblCost iCurrent)
typedef void(* AlpMblContextVoiceMailIndicatorStatusChangeCallbackPtr )(void *iUserDataP, AlpMblContextId iMobileContextId, bool iIndicatorStatus, uint8_t iVoiceMailCount, AlpMblLineId iLineId)
typedef _AlpMblCost AlpMblCost
typedef _AlpMblDataCall AlpMblDataCall
typedef _AlpMblDataCallList AlpMblDataCallList
typedef _AlpMblOwnNumber AlpMblOwnNumber

Functions

alp_status_t alp_mbl_context_add_restricted_contact (AlpMblContextId iContextId, AlpMblContextRestrictionList iList, AlpMblContextRestrictedContact *iContactP)
alp_status_t alp_mbl_context_delete (AlpMblContextId iContextId)
alp_status_t alp_mbl_context_get_address_scheme (AlpMblContextId iContextId, AlpMblAddressScheme *oContextAddressSchemeP)
alp_status_t alp_mbl_context_get_answer_mode (AlpMblContextId iContextId, AlpMblContextAnswerMode *oAnswerModeP)
alp_status_t alp_mbl_context_get_available_lines (AlpMblContextId iContextId, AlpMblLineList *oLineListP)
alp_status_t alp_mbl_context_get_call_counter (AlpMblContextId iContextId, AlpMblContextCallCounter *oCallCounterP)
alp_status_t alp_mbl_context_get_callid_restriction_status (AlpMblContextId iContextId, AlpMblContextCallerIdRestrictionStatus *oCallIdRestrictionP)
alp_status_t alp_mbl_context_get_calls (AlpMblContextId iContextId, AlpMblCallList *oCallListP, AlpMblCallFilter iFilter)
alp_status_t alp_mbl_context_get_cost (AlpMblContextId iContextId, AlpMblCost *oCostP)
alp_status_t alp_mbl_context_get_cost_limit (AlpMblContextId iContextId, AlpMblCost *oCostLimitP)
alp_status_t alp_mbl_context_get_currency (AlpMblContextId iContextId, AlpMblCurrency *oCurrencyP)
alp_status_t alp_mbl_context_get_current_line (AlpMblContextId iContextId, AlpMblLineId *oLineIdP)
alp_status_t alp_mbl_context_get_description (AlpMblContextId iContextId, AlpMblContextDescription *oContextDescriptionP)
alp_status_t alp_mbl_context_get_home_operator_id (AlpMblContextId iContextId, AlpMblOperatorId *oHomeOperatorIdP)
alp_status_t alp_mbl_context_get_missed_call_count (AlpMblContextId iContextId, uint8_t *oMissedCallCountP)
alp_status_t alp_mbl_context_get_network_id (AlpMblContextId iContextId, AlpMblNetworkId *oNetworkIdP)
alp_status_t alp_mbl_context_get_own_number (AlpMblContextId iContextId, AlpMblOwnNumber *oOwnNumberP)
alp_status_t alp_mbl_context_get_restricted_contacts (AlpMblContextId iContextId, AlpMblContextRestrictionList iList, AlpMblContextRestrictedContactList *oContactListP)
alp_status_t alp_mbl_context_get_restriction_list_facility (AlpMblContextId iContextId, AlpMblContextRestrictionList iList, AlpMblContextRestrictionListFacility *ioFacilityP) __attribute((deprecated))
alp_status_t alp_mbl_context_get_restriction_list_status (AlpMblContextId iContextId, AlpMblContextRestrictionList iList, AlpMblContextRestrictionListStatus *oStatusP)
alp_status_t alp_mbl_context_get_status (AlpMblContextId iContextId, AlpMblContextStatus *oStatusP)
alp_status_t alp_mbl_context_get_subscriber_id (AlpMblContextId iContextId, AlpMblContextSubscriberId *oContextSubscriberIdP)
alp_status_t alp_mbl_context_get_type (AlpMblContextId iContextId, AlpMblContextType *oContextTypeP)
alp_status_t alp_mbl_context_get_unit_price (AlpMblContextId iContextId, AlpMblCost *oUnitPriceP)
alp_status_t alp_mbl_context_get_voice_mail_indicator_status (AlpMblContextId iContextId, bool *oIndicatorStatusP, uint8_t *oVoiceMailCountP)
alp_status_t alp_mbl_context_hold_active_calls (AlpMblContextId iContextId)
alp_status_t alp_mbl_context_is_emergency_number (AlpMblContextId iContextId, AlpMblAddress iAddress, bool *oIsEmergencyNumberP)
alp_status_t alp_mbl_context_new_call (AlpMblContextId iContextId, AlpMblAddress iAddress, AlpMblCallId *oCallIdP)
alp_status_t alp_mbl_context_new_emergency_call (AlpMblContextId iContextId, AlpMblAddress iAddress, AlpMblCallId *oCallIdP)
alp_status_t alp_mbl_context_new_video_call (AlpMblContextId iContextId, AlpMblAddress iAddress, AlpMblCallId *oCallIdP)
alp_status_t alp_mbl_context_release_active_calls (AlpMblContextId iContextId)
alp_status_t alp_mbl_context_release_calls (AlpMblContextId iContextId)
alp_status_t alp_mbl_context_release_held_calls (AlpMblContextId iContextId)
alp_status_t alp_mbl_context_remove_restricted_contact (AlpMblContextId iContextId, AlpMblContextRestrictionList iList, AlpMblContextRestrictedContact *iContactP)
alp_status_t alp_mbl_context_reset_call_counter (AlpMblContextId iContextId, AlpMblContextCallCounterType iCallCounterType)
alp_status_t alp_mbl_context_reset_cost (AlpMblContextId iContextId)
alp_status_t alp_mbl_context_set_answer_mode (AlpMblContextId iContextId, AlpMblContextAnswerMode iAnswerMode)
alp_status_t alp_mbl_context_set_callid_restriction_status (AlpMblContextId iContextId, AlpMblContextCallerIdRestrictionAdjustment iCallIdRestrictionAdjustment)
alp_status_t alp_mbl_context_set_cost_limit (AlpMblContextId iContextId, AlpMblCost iCostLimit)
alp_status_t alp_mbl_context_set_currency (AlpMblContextId iContextId, AlpMblCurrency iCurrency)
alp_status_t alp_mbl_context_set_current_line (AlpMblContextId iContextId, AlpMblLineId iLineId)
alp_status_t alp_mbl_context_set_own_number (AlpMblContextId iContextId, AlpMblOwnNumber *iOwnNumberP)
alp_status_t alp_mbl_context_set_restriction_list_status (AlpMblContextId iContextId, AlpMblContextRestrictionList iList, AlpMblContextRestrictionListStatus iStatus)
alp_status_t alp_mbl_context_set_unit_price (AlpMblContextId iContextId, AlpMblCost iUnitPrice)
alp_status_t alp_mbl_context_start (AlpMblContextId iContextId)
alp_status_t alp_mbl_context_stop (AlpMblContextId iContextId)


Define Documentation

#define ALP_MBL_CONTEXT_ANSWER_MODE_ANY_KEY   ((AlpMblContextAnswerMode) 1)
 

Any hard key will answer.

#define ALP_MBL_CONTEXT_ANSWER_MODE_AUTOMATIC   ((AlpMblContextAnswerMode) 2)
 

Call is answered automaticly.

#define ALP_MBL_CONTEXT_ANSWER_MODE_KEY_OR_BUTTON   ((AlpMblContextAnswerMode) 0)
 

OFF HOOK key will answer, or answer soft key.

#define ALP_MBL_CONTEXT_BLACK_LIST   1
 

Black list.

#define ALP_MBL_CONTEXT_CALL_COUNTER_ALL   (ALP_MBL_CONTEXT_CALL_COUNTER_VOICE_ALL | ALP_MBL_CONTEXT_CALL_COUNTER_DATA_ALL)
 

All counter.

#define ALP_MBL_CONTEXT_CALL_COUNTER_DATA_ALL   (ALP_MBL_CONTEXT_CALL_COUNTER_DATA_CS | ALP_MBL_CONTEXT_CALL_COUNTER_DATA_PS_ALL)
 

All data counter.

#define ALP_MBL_CONTEXT_CALL_COUNTER_DATA_CS   ((AlpMblContextCallCounterType) 0x04)
 

Circuit switch data call counter.

#define ALP_MBL_CONTEXT_CALL_COUNTER_DATA_PS_ALL   (ALP_MBL_CONTEXT_CALL_COUNTER_DATA_PS_IN | ALP_MBL_CONTEXT_CALL_COUNTER_DATA_PS_OUT)
 

All packet switch byte counter.

#define ALP_MBL_CONTEXT_CALL_COUNTER_DATA_PS_IN   ((AlpMblContextCallCounterType) 0x08)
 

Receive packet switch byte counter.

#define ALP_MBL_CONTEXT_CALL_COUNTER_DATA_PS_OUT   ((AlpMblContextCallCounterType) 0x10)
 

Sent packet switch byte counter.

#define ALP_MBL_CONTEXT_CALL_COUNTER_VIDEO_ALL   (ALP_MBL_CONTEXT_CALL_COUNTER_VIDEO_IN | ALP_MBL_CONTEXT_CALL_COUNTER_VIDEO_OUT)
 

All video call counter.

#define ALP_MBL_CONTEXT_CALL_COUNTER_VIDEO_IN   ((AlpMblContextCallCounterType) 0x20)
 

Receive video call counter.

#define ALP_MBL_CONTEXT_CALL_COUNTER_VIDEO_OUT   ((AlpMblContextCallCounterType) 0x40)
 

Dialed video call counter.

#define ALP_MBL_CONTEXT_CALL_COUNTER_VOICE_ALL   (ALP_MBL_CONTEXT_CALL_COUNTER_VOICE_IN | ALP_MBL_CONTEXT_CALL_COUNTER_VOICE_OUT)
 

All voice call counter.

#define ALP_MBL_CONTEXT_CALL_COUNTER_VOICE_IN   ((AlpMblContextCallCounterType) 0x01)
 

Receive voice call counter.

#define ALP_MBL_CONTEXT_CALL_COUNTER_VOICE_OUT   ((AlpMblContextCallCounterType) 0x02)
 

Dialed voice call counter.

#define ALP_MBL_CONTEXT_CLIR_ACCORDING_SUBSCRIPTION   0
 

the presentation indicator is used according to the subscription of the CLIR service

#define ALP_MBL_CONTEXT_CLIR_INVOCATION   1
 

the calling subscriber choose to restrict the presentation of the Caller Id to the called party when originating a call.

#define ALP_MBL_CONTEXT_CLIR_STATUS_NOT_PROVISIONED   0
 

the CLIR Supplementary Service is deactivated/ not provisioned

#define ALP_MBL_CONTEXT_CLIR_STATUS_PRESENTATION_PERMANENTLY_RESTRICTED   1
 

if subscribed-to in the permanent mode, the network shall automatically invoke the CLIR Supplementary Service for each outgoing call.

#define ALP_MBL_CONTEXT_CLIR_STATUS_PRESENTATION_TEMPORARILY_ALLOWED   4
 

if subscribed-to in the temporary mode with the default value "presentation allowed" then the network shall only invoke the CLIR Supplementary Service if requested by subscriber at the time of call request.

#define ALP_MBL_CONTEXT_CLIR_STATUS_PRESENTATION_TEMPORARILY_RESTRICTED   3
 

if subscribed-to in the temporary mode with the default value "presentation restricted" then the network shall automatically invoke the CLIR Supplementary Service for each outgoing call unless CLIR is suppressed by subscriber request at the time of call request.

#define ALP_MBL_CONTEXT_CLIR_STATUS_UNKNOWN   2
 

the CLIR status is unknown (eg no network,never set...)

#define ALP_MBL_CONTEXT_CLIR_SUPPRESSION   2
 

the calling subscriber choose to allow the presentation of the Caller Id to the called party when originating a call.

#define ALP_MBL_CONTEXT_EMERGENCY_NUMBERS_AVAILABLE   ((AlpMblNotificationId) 4)
 

Emergency numbers are available.

#define ALP_MBL_CONTEXT_FIX_DIAL_LIST   2
 

Fix Dialing List.

#define ALP_MBL_CONTEXT_INVALID_CONTEXT_ID   ((AlpMblContextId) 0)
 

Invalid context id.

#define ALP_MBL_CONTEXT_LIST_COUNT   (ALP_MBL_CONTEXT_FIX_DIAL_LIST + 1)
 

Total count of restricted list.

#define ALP_MBL_CONTEXT_NETWORK_ID_CHANGE   ((AlpMblNotificationId) 3)
 

The network id of a mobile context has changed.

#define ALP_MBL_CONTEXT_NOTIFICATION_AVAILABLE_LINES_CHANGE   ((AlpMblNotificationId) 15)
 

The available line of a cellular mobile context has changed.

#define ALP_MBL_CONTEXT_NOTIFICATION_CALL_LIST_UPDATE   ((AlpMblNotificationId) 19)
 

The status of one or more call have changed, so we have update the entire call list.

#define ALP_MBL_CONTEXT_NOTIFICATION_CLIR_STATUS_CHANGE   ((AlpMblNotificationId) 10)
 

The status of the CLIR service has changed.

#define ALP_MBL_CONTEXT_NOTIFICATION_COST_CHANGE   ((AlpMblNotificationId) 11)
 

The cost of Mobile Context has changed.

#define ALP_MBL_CONTEXT_NOTIFICATION_COST_LIMIT_CHANGE   ((AlpMblNotificationId) 12)
 

The cost limit of Mobile Context has changed.

#define ALP_MBL_CONTEXT_NOTIFICATION_CURRENCY_CHANGE   ((AlpMblNotificationId) 13)
 

The currency of Mobile Context has changed.

#define ALP_MBL_CONTEXT_NOTIFICATION_CURRENT_LINE_CHANGE   ((AlpMblNotificationId) 16)
 

The current line of a cellular mobile context has changed.

#define ALP_MBL_CONTEXT_NOTIFICATION_HOME_OPERATOR_ID_AVAILABLE   ((AlpMblNotificationId) 6)
 

Home operator id is available.

#define ALP_MBL_CONTEXT_NOTIFICATION_MISSED_CALL_COUNT_CHANGE   ((AlpMblNotificationId) 8)
 

The count of missed call has changed.

#define ALP_MBL_CONTEXT_NOTIFICATION_NEW_CALL   ((AlpMblNotificationId) 2)
 

There is a new call for a specific mobile context.

#define ALP_MBL_CONTEXT_NOTIFICATION_OWN_NUMBERS_AVAILABLE   ((AlpMblNotificationId) 9)
 

The own phone numbers (voice, fax, data) are available.

#define ALP_MBL_CONTEXT_NOTIFICATION_RESTRICTION_LIST_CHANGE   ((AlpMblNotificationId) 17)
 

The content of a restricted list has changed.

#define ALP_MBL_CONTEXT_NOTIFICATION_RESTRICTION_LIST_STATUS_CHANGE   ((AlpMblNotificationId) 18)
 

The status of a restricted list has changed (activate/desactivate...).

#define ALP_MBL_CONTEXT_NOTIFICATION_STATUS_CHANGE   ((AlpMblNotificationId) 1)
 

The status of a mobile context has changed.

#define ALP_MBL_CONTEXT_NOTIFICATION_SUBSCRIBER_ID_AVAILABLE   ((AlpMblNotificationId) 5)
 

Subscriber id is available.

#define ALP_MBL_CONTEXT_NOTIFICATION_UNIT_PRICE_CHANGE   ((AlpMblNotificationId) 14)
 

The unit's price of Mobile Context has changed.

#define ALP_MBL_CONTEXT_NOTIFICATION_VOICE_MAIL_INDICATOR_CHANGE   ((AlpMblNotificationId) 7)
 

The status of the voice mail indicator has changed.

#define ALP_MBL_CONTEXT_RESTRICTED_CONTACT_BY_ADDRESS   0
 

The restricted contact structure contains an address (and a name).

#define ALP_MBL_CONTEXT_RESTRICTION_LIST_CONTACT_ADDED   0
 

action 'add' on a restriction list

#define ALP_MBL_CONTEXT_RESTRICTION_LIST_CONTACT_REMOVED   1
 

action 'remove' on a restriction list

#define ALP_MBL_CONTEXT_RESTRICTION_LIST_CONTACT_RETRIEVED   3
 

action 'retrieved' on a restriction list

#define ALP_MBL_CONTEXT_RESTRICTION_LIST_CONTACT_UPDATED   2
 

action 'edit' on a restriction list

#define ALP_MBL_CONTEXT_RESTRICTION_LIST_DISABLE   0
 

The restriction list is disabled.

#define ALP_MBL_CONTEXT_RESTRICTION_LIST_ENABLE   1
 

The restriction list is enabled.

#define ALP_MBL_CONTEXT_RESTRICTION_LIST_FACILITY_ADDRESS_SIZE   0
 

The restriction list contact address size.

#define ALP_MBL_CONTEXT_RESTRICTION_LIST_FACILITY_NAME_SIZE   1
 

The restriction list contact name size.

#define ALP_MBL_CONTEXT_RESTRICTION_LIST_NOT_SUPPORTED   2
 

The restriction list is not supported.

#define ALP_MBL_CONTEXT_STATUS_CONNECTED   ((AlpMblContextStatus) 1)
 

Context is connected.

#define ALP_MBL_CONTEXT_STATUS_CONNECTING   ((AlpMblContextStatus) 3)
 

Context is connecting.

#define ALP_MBL_CONTEXT_STATUS_DISCONNECTED   ((AlpMblContextStatus) 2)
 

Context is disconnected.

#define ALP_MBL_CONTEXT_STATUS_DISCONNECTING   ((AlpMblContextStatus) 4)
 

Context is disconnecting.

#define ALP_MBL_CONTEXT_STATUS_UNKNOWN   ((AlpMblContextStatus) 0)
 

Status is unknown - initial status.

#define ALP_MBL_CONTEXT_WHITE_LIST   0
 

While list.


Typedef Documentation

typedef struct _AlpMblAddressList AlpMblAddressList
 

List of address.

typedef unsigned char AlpMblContextAnswerMode
 

Context answer mode, see ALP_MBL_CONTEXT_ANSWER_MODE_XXX defines.

typedef void(* AlpMblContextAvailableLinesChangeCallbackPtr)(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblLineList iAvailableLines)
 

Callback prototype for ALP_MBL_CONTEXT_NOTIFICATION_AVAILABLE_LINES_CHANGE notification.

Parameters:
[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.
[in] iMobileContextId - The id of the mobile context.
[in] iAvailableLines - The available lines. You have to free iAvailableLines.lineP memory when you have done with it using alp_mbl_free();

typedef struct _AlpMblContextCallCounter AlpMblContextCallCounter
 

Call counter information.

typedef unsigned char AlpMblContextCallCounterType
 

Call counter type, see ALP_MBL_CONTEXT_CALL_COUNTER_XXX defines.

typedef unsigned char AlpMblContextCallerIdRestrictionAdjustment
 

Caller Id restriction status, see ALP_MBL_CONTEXT_CLIR_XXX defines.

typedef unsigned char AlpMblContextCallerIdRestrictionStatus
 

Caller Id restriction status, see ALP_MBL_CONTEXT_CLIR_STATUS_XXX defines.

typedef void(* AlpMblContextCallListUpdateCallbackPtr)(void *iUserDataP, AlpMblContextId iMobileContextId, uint8_t iCallCount, AlpMblCallUpdateInfo *iCallUpdateInfoP)
 

Callback prototype for ALP_MBL_CONTEXT_NOTIFICATION_CALL_LIST_UPDATE notification of the ALP_MBL_CONTEXT_SERVICE_ID service.

Parameters:
[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.
[in] iMobileContextId - The id of the mobile context.
[in] iCallCount - Call count.
[in] iCallUpdateInfoP - List of call information. Must be free by application when no more needed, using alp_mbl_free.

typedef void(* AlpMblContextClirStatusChangeCallbackPtr)(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblContextCallerIdRestrictionStatus iPreviousStatus, AlpMblContextCallerIdRestrictionStatus iCurrentStatus)
 

Callback prototype for ALP_MBL_CONTEXT_NOTIFICATION_CLIR_STATUS_CHANGE notification.

Parameters:
[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.
[in] iMobileContextId - Id of the mobile context that its CLIR service status has changed.
[in] iPreviousStatus - Previous CLIR status of the mobile context.
[in] iCurrentStatus - Current CLIR status of the mobile context.

typedef void(* AlpMblContextCostChangeCallbackPtr)(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblCost iPrevious, AlpMblCost iCurrent)
 

Callback prototype for ALP_MBL_CONTEXT_NOTIFICATION_COST_CHANGE notification.

Parameters:
[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.
[in] iMobileContextId - Id of the mobile context that its cost has changed.
[in] iPrevious - Previous cost of the mobile context.
[in] iCurrent - Current cost of the mobile context.

typedef void(* AlpMblContextCostLimitChangeCallbackPtr)(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblCost iPrevious, AlpMblCost iCurrent)
 

Callback prototype for ALP_MBL_CONTEXT_NOTIFICATION_COST_LIMIT_CHANGE notification.

Parameters:
[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.
[in] iMobileContextId - Id of the mobile context that its cost limit has changed.
[in] iPrevious - Previous cost limit of the mobile context.
[in] iCurrent - Current cost limit of the mobile context.

typedef void(* AlpMblContextCurrencyChangeCallbackPtr)(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblCurrency iPrevious, AlpMblCurrency iCurrent)
 

Callback prototype for ALP_MBL_CONTEXT_NOTIFICATION_CURRENCY_CHANGE notification.

Parameters:
[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.
[in] iMobileContextId - Id of the mobile context that its currency has changed.
[in] iPrevious - Previous currency of the mobile context.
[in] iCurrent - Current currency of the mobile context.

typedef void(* AlpMblContextCurrentLineChangeCallbackPtr)(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblLineId iPrevious, AlpMblLineId iCurrent)
 

Callback prototype for ALP_MBL_CONTEXT_NOTIFICATION_CURRENT_LINE_CHANGE notification.

Parameters:
[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.
[in] iMobileContextId - The id of the mobile context.
[in] iPrevious - The previous line.
[in] iCurrent - The current line.

typedef char AlpMblContextDescription[32]
 

Context description.

typedef void(* AlpMblContextEmergencyNumbersAvailableCallbackPtr)(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblAddressList iAddressList)
 

Callback prototype for ALP_MBL_CONTEXT_EMERGENCY_NUMBERS_AVAILABLE notification.

Parameters:
[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.
[in] iMobileContextId - Id of the mobile context that its emergency numbers are available.
[in] iAddressList - List of emergency numbers of the mobile context. You have to free iAddressList.addressListP when you have done with it using alp_mbl_free();

typedef void(* AlpMblContextHomeOperatorIdAvailableCallbackPtr)(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblOperatorId iOperatorId)
 

Callback prototype for ALP_MBL_CONTEXT_NOTIFICATION_HOME_OPERATOR_ID_AVAILABLE notification.

Parameters:
[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.
[in] iMobileContextId - Id of the mobile context that its home operator id is available.
[in] iOperatorId - Operator id of the mobile context.

typedef unsigned char AlpMblContextId
 

Context identifier.

typedef struct _AlpMblContextList AlpMblContextList
 

List of context.

typedef void(* AlpMblContextMissedCallCountChangeCallbackPtr)(void *iUserDataP, AlpMblContextId iMobileContextId, uint8_t iPreviousCount, uint8_t iCurrentCount)
 

Callback prototype for ALP_MBL_CONTEXT_NOTIFICATION_MISSED_CALL_COUNT_CHANGE notification.

Parameters:
[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.
[in] iMobileContextId - Id of the mobile context that its missed call count has changed.
[in] iPreviousCount - Previous missed call count of the mobile context.
[in] iCurrentCount - New missed call count of the mobile context.

typedef void(* AlpMblContextNetworkIdChangeCallbackPtr)(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblNetworkId iPrevious, AlpMblNetworkId iCurrent)
 

Callback prototype for ALP_MBL_CONTEXT_NETWORK_ID_CHANGE notification.

Parameters:
[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.
[in] iMobileContextId - Id of the mobile context that its network id has changed.
[in] iPrevious - Previous network id.
[in] iCurrent - New network id.

typedef void(* AlpMblContextNewCallCallbackPtr)(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblCallId iCallId, AlpMblCallDirection iDirection, AlpMblCallType iType)
 

Callback prototype for ALP_MBL_CONTEXT_NOTIFICATION_NEW_CALL notification.

Parameters:
[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.
[in] iMobileContextId - Id of the mobile context that has a new call.
[in] iCallId - Id of the new call.
[in] iDirection - Direction of the new call. See ALP_MBL_CALL_DIRECTION_XXX defines.
[in] iType - Type of the new call. See ALP_MBL_CALL_TYPE_XXX defines.

typedef void(* AlpMblContextOwnNumbersAvailableCallbackPtr)(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblOwnNumber *iOwnNumberP)
 

Callback prototype for ALP_MBL_CONTEXT_NOTIFICATION_OWN_NUMBERS_AVAILABLE notification.

Parameters:
[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.
[in] iMobileContextId - Id of the mobile context that its own numbers are available.
[in] iOwnNumberP - The own numbers of the mobile context.
Note:
It's up to the application to free the iOwnNumberP when it no longer need it, using the alp_mbl_free() API.

typedef struct _AlpMblContextRestrictedContact AlpMblContextRestrictedContact
 

typedef AlpMblAddress AlpMblContextRestrictedContactAddress
 

Restricted contact phone number.

typedef struct _AlpMblContextRestrictedContactByAddress AlpMblContextRestrictedContactByAddress
 

typedef int32_t AlpMblContextRestrictedContactIndex
 

Storage index.

typedef struct _AlpMblContextRestrictedContactList AlpMblContextRestrictedContactList
 

List of restricted contacts.

typedef char AlpMblContextRestrictedContactName[128]
 

Restricted contact name.

typedef int32_t AlpMblContextRestrictedContactType
 

what kind of informations are provided by the restricted contact structure (see ALP_MBL_CONTEXT_RESTRICTED_CONTACT_BY_xxx)

typedef uint16_t AlpMblContextRestrictionList
 

Restriction List index.

typedef uint16_t AlpMblContextRestrictionListAction
 

Possible action with restriction List.

typedef void(* AlpMblContextRestrictionListChangeCallbackPtr)(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblContextRestrictionList iList, AlpMblContextRestrictionListAction iAction, AlpMblContextRestrictedContact iContact)
 

Callback prototype for ALP_MBL_CONTEXT_NOTIFICATION_RESTRICTION_LIST_CHANGE notification.

Parameters:
[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.
[in] iMobileContextId - The id of the mobile context.
[in] iList - The restriction list modified
[in] iAction - The action executed on the list (ALP_MBL_CONTEXT_RESTRICTION_LIST_CONTACT_ADDED, ALP_MBL_CONTEXT_RESTRICTION_LIST_CONTACT_REMOVED)
[in] iContact - Informations about the contact added or removed

typedef struct _AlpMblContextRestrictionListFacility AlpMblContextRestrictionListFacility
 

List of restricted contacts.

typedef uint16_t AlpMblContextRestrictionListStatus
 

Possible status of a restriction List.

typedef void(* AlpMblContextRestrictionListStatusChangeCallbackPtr)(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblContextRestrictionList iList, AlpMblContextRestrictionListStatus iPrevious, AlpMblContextRestrictionListStatus iCurrent)
 

Callback prototype for ALP_MBL_CONTEXT_NOTIFICATION_RESTRICTION_LIST_STATUS_CHANGE notification.

Parameters:
[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.
[in] iMobileContextId - The id of the mobile context.
[in] iList - The restriction list activated or desactivated
[in] iPrevious - The previous state of the restriction list (ALP_MBL_CONTEXT_RESTRICTION_LIST_ENABLE or ALP_MBL_CONTEXT_RESTRICTION_LIST_DISABLE)
[in] iCurrent - The current state of the restriction list (ALP_MBL_CONTEXT_RESTRICTION_LIST_ENABLE or ALP_MBL_CONTEXT_RESTRICTION_LIST_DISABLE)

typedef unsigned char AlpMblContextStatus
 

Context status, see ALP_MBL_CONTEXT_STATUS_XXX defines.

typedef void(* AlpMblContextStatusChangeCallbackPtr)(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblContextStatus iPrevious, AlpMblContextStatus iCurrent, alp_status_t iError)
 

Callback prototype for ALP_MBL_CONTEXT_NOTIFICATION_STATUS_CHANGE notification.

Parameters:
[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.
[in] iMobileContextId - Id of the mobile context that the status has change.
[in] iPrevious - Previous status of the mobile context. See ALP_MBL_CONTEXT_STATUS_XXX defines.
[in] iCurrent - New status of the mobile context. See ALP_MBL_CONTEXT_STATUS_XXX defines.
[in] iError - Extra information if the new mobile context status is ALP_MBL_CONTEXT_STATUS_DISCONNECTED, see ALP_STATUS_MBL_XXX defines.
Returns:
Nothing.

typedef char AlpMblContextSubscriberId[32]
 

Context subscriber identity.

typedef void(* AlpMblContextSubscriberIdAvailableCallbackPtr)(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblContextSubscriberId iSubscriberId)
 

Callback prototype for ALP_MBL_CONTEXT_NOTIFICATION_SUBSCRIBER_ID_AVAILABLE notification.

Parameters:
[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.
[in] iMobileContextId - Id of the mobile context that its subscriber id is available.
[in] iSubscriberId - Subscriber id of the mobile context.

typedef char AlpMblContextType[12]
 

Context type.

typedef void(* AlpMblContextUnitPriceChangeCallbackPtr)(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblCost iPrevious, AlpMblCost iCurrent)
 

Callback prototype for ALP_MBL_CONTEXT_NOTIFICATION_UNIT_PRICE_CHANGE notification.

Parameters:
[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.
[in] iMobileContextId - Id of the mobile context that its unit's price has changed.
[in] iPrevious - Previous unit's price of the mobile context.
[in] iCurrent - Current unit's price of the mobile context.

typedef void(* AlpMblContextVoiceMailIndicatorStatusChangeCallbackPtr)(void *iUserDataP, AlpMblContextId iMobileContextId, bool iIndicatorStatus, uint8_t iVoiceMailCount, AlpMblLineId iLineId)
 

Callback prototype for ALP_MBL_CONTEXT_NOTIFICATION_VOICE_MAIL_INDICATOR_CHANGE notification.

Parameters:
[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.
[in] iMobileContextId - Id of the mobile context that its voice mail indicator status has changed.
[in] iIndicatorStatus - Status indicator: true, display a voicemail indicator icon; false, do not display a voicemail indicator icon.
[in] iVoiceMailCount - The count of voicemail. Only return when iIndicatorStatus is true. If 0, the information is not provided.
[in] iLineId - Id of the associated line. 0 if line id information is not available.

typedef struct _AlpMblCost AlpMblCost
 

typedef struct _AlpMblDataCall AlpMblDataCall
 

typedef struct _AlpMblDataCallList AlpMblDataCallList
 

typedef struct _AlpMblOwnNumber AlpMblOwnNumber
 


Function Documentation

alp_status_t alp_mbl_context_add_restricted_contact AlpMblContextId  iContextId,
AlpMblContextRestrictionList  iList,
AlpMblContextRestrictedContact iContactP
 

Add a contact or all the contacts of one person to a restriction list (White List, Black list...)

Parameters:
[in] iContextId - The id of the Mobile Context.
[in] iList - The list to work on (= ALP_MBL_CONTEXT_WHITE_LIST, ALP_MBL_CONTEXT_BLACK_LIST...)
[in] iContactP - A Structure which contains informations about the contact/person to add
Returns:
ALP_STATUS_OK - The contact (or person) has been added successfuly.

ALP_STATUS_MBL_INVALID_PARAMETER - The iList value or the contact info are invalid.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is invalid.

ALP_STATUS_MBL_MEMORY_ERROR - Memory error, not enough memory to perform the action.

ALP_STATUS_MBL_OPERATION_NOT_ALLOWED - The contact (or person) already exist in the restricted list, and it's not allowed to add a duplicate entry.

Since:
ALP iSDK 1.1

alp_status_t alp_mbl_context_delete AlpMblContextId  iContextId  ) 
 

Delete a mobile context

Parameters:
[in] iContextId - The id of the mobile context to delete.
Returns:
ALP_STATUS_OK - The mobile context has been deleted successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

Since:
ALP iSDK 1.0

alp_status_t alp_mbl_context_get_address_scheme AlpMblContextId  iContextId,
AlpMblAddressScheme oContextAddressSchemeP
 

Get the address scheme of a mobile context

Parameters:
[in] iContextId - The id of the mobile context to get its address scheme.
[out] oContextAddressSchemeP - Pointer to a AlpMblAddressScheme to store the context address scheme.
Returns:
ALP_STATUS_OK - The address scheme of the mobile context has been retrieved successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

ALP_STATUS_MBL_INVALID_PARAMETER - oContextAddressSchemeP is NULL, and it's not valid.

Since:
ALP iSDK 1.0

alp_status_t alp_mbl_context_get_answer_mode AlpMblContextId  iContextId,
AlpMblContextAnswerMode oAnswerModeP
 

Gets the answer mode.

Parameters:
[in] iContextId - The id of the mobile context that we want to get the answer mode.
[out] oAnswerModeP - The answer mode.
Returns:
ALP_STATUS_OK - The answer mode has been retrieved successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

ALP_STATUS_MBL_INVALID_PARAMETER - oAnswerModeP is NULL, and it's not valid.

Since:
ALP iSDK 1.0

alp_status_t alp_mbl_context_get_available_lines AlpMblContextId  iContextId,
AlpMblLineList oLineListP
 

Gets the available lines of a Mobile Context.

Parameters:
[in] iContextId - The id of the Cellular Context.
[out] oLineListP - Pointer to an AlpMblLineList, to store the list of available lines.
Returns:
ALP_STATUS_OK - The available lines have been retrieved successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

ALP_STATUS_MBL_INVALID_PARAMETER - oLineListP is NULL, and it's not valid.

Since:
ALP iSDK 1.1

alp_status_t alp_mbl_context_get_call_counter AlpMblContextId  iContextId,
AlpMblContextCallCounter oCallCounterP
 

Gets call counter information.

Parameters:
[in] iContextId - The id of the mobile context that we want to get the missed call count.
[out] oCallCounterP - The call counter information.
Returns:
ALP_STATUS_OK - The call counter information has been retrieved successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

ALP_STATUS_MBL_INVALID_PARAMETER - oCallCounterP is NULL, and it's not valid.

Since:
ALP iSDK 1.0

alp_status_t alp_mbl_context_get_callid_restriction_status AlpMblContextId  iContextId,
AlpMblContextCallerIdRestrictionStatus oCallIdRestrictionP
 

Gets the subscriber CLIR service status in the network

Parameters:
[in] iContextId - The id of the mobile Context.
[out] oCallIdRestrictionP - Pointer to a CLIR service status value.
Returns:
ALP_STATUS_OK - The callid restriction status has been retrieved successfuly.
Since:
ALP iSDK 1.1

alp_status_t alp_mbl_context_get_calls AlpMblContextId  iContextId,
AlpMblCallList oCallListP,
AlpMblCallFilter  iFilter
 

Return the list of the calls.

Parameters:
[in] iContextId - The id of the mobile context that we want to retrieve the calls.
[in] iFilter - A filter, to apply when searching for the call.
[out] oCallListP - Pointer to a AlpMblCallList to store the call list.
Returns:
ALP_STATUS_OK - The call list has been retrieved successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

ALP_STATUS_MBL_INVALID_PARAMETER - oCallListP is NULL, and it's not valid.

Since:
ALP iSDK 1.0

alp_status_t alp_mbl_context_get_cost AlpMblContextId  iContextId,
AlpMblCost oCostP
 

Get the cost of a Mobile Context.

Parameters:
[in] iContextId - The id of the mobile context to get its cost.
[out] oCostP - Pointer to a AlpMblCost to store the cost of the Mobile Context.
Returns:
ALP_STATUS_OK - The cost of the mobile context has been retrieved successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

ALP_STATUS_MBL_INVALID_PARAMETER - oCostP is NULL, and it's not valid.

Since:
ALP iSDK 1.1

alp_status_t alp_mbl_context_get_cost_limit AlpMblContextId  iContextId,
AlpMblCost oCostLimitP
 

Get the cost limit of a Mobile Context.

Parameters:
[in] iContextId - The id of the mobile context to get its cost limit.
[out] oCostLimitP - Pointer to a AlpMblCost to store the cost limit of the Mobile Context.
Returns:
ALP_STATUS_OK - The cost limit of the mobile context has been retrieved successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

ALP_STATUS_MBL_INVALID_PARAMETER - oCostLimitP is NULL, and it's not valid.

Since:
ALP iSDK 1.1

alp_status_t alp_mbl_context_get_currency AlpMblContextId  iContextId,
AlpMblCurrency oCurrencyP
 

Get the currency of a Mobile Context.

Parameters:
[in] iContextId - The id of the mobile context to get its currency.
[out] oCurrencyP - Pointer to a AlpMblCurrency to store the currency of the Mobile Context.
Returns:
ALP_STATUS_OK - The currency of the mobile context has been retrieved successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

ALP_STATUS_MBL_INVALID_PARAMETER - oCostLimitP is NULL, and it's not valid.

Since:
ALP iSDK 1.1

alp_status_t alp_mbl_context_get_current_line AlpMblContextId  iContextId,
AlpMblLineId oLineIdP
 

Gets the current line of a Cellular Mobile Context.

Parameters:
[in] iContextId - The id of the Cellular Mobile Context.
[out] oLineIdP - Pointer to an AlpMblLineId, to store the current line id.
Returns:
ALP_STATUS_OK - The current line has been retrieved successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist or its status is not ALP_MBL_CONTEXT_STATUS_CONNECTED.

ALP_STATUS_MBL_INVALID_PARAMETER - oCurrentLineP is NULL, and it's not valid.

Since:
ALP iSDK 1.1

alp_status_t alp_mbl_context_get_description AlpMblContextId  iContextId,
AlpMblContextDescription oContextDescriptionP
 

Get the description of a mobile context

Parameters:
[in] iContextId - The id of the mobile context to get its description.
[out] oContextDescriptionP - Pointer to a AlpMblContextDescription to store the context description.
Returns:
ALP_STATUS_OK - The description of the mobile context has been retrieved successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

ALP_STATUS_MBL_INVALID_PARAMETER - oContextDescriptionP is NULL, and it's not valid.

Example:
You can see an example of use with the description of the function alp_mbl_get_contexts().
Since:
ALP iSDK 1.0

alp_status_t alp_mbl_context_get_home_operator_id AlpMblContextId  iContextId,
AlpMblOperatorId oHomeOperatorIdP
 

Get the home operator id of a mobile context.

Parameters:
[in] iContextId - The ID of the mobile context to get its home operator id.
[out] oHomeOperatorIdP - Pointer to a AlpMblOperatorId to store the home operator id.
Returns:
ALP_STATUS_OK - The home operator id of the mobile context has been retrieved successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

ALP_STATUS_MBL_INVALID_PARAMETER - oHomeOperatorIdP is NULL, and it's not valid.

Example:
An example of displaying the name of the home operator associated to the default mobile context.
#include <stdio.h>
#include <alp/mobile.h>
#include <alp/errormgr.h>

alp_status_t prv_display_home_operator_name()
{
        AlpMblContextId         defaultContextId;
        AlpMblOperatorId        homeOperatorId;
        AlpMblOperatorName      operatorName;
        alp_status_t            err;

        if ((err = alp_mbl_get_default_context(&defaultContextId)) != ALP_STATUS_OK)
        {
                printf("alp_mbl_get_default_context failed with error: %s.\n", alp_err_get_string(err, true));
                return err;
        }

        printf("The id of the default context is %d.\n", defaultContextId);

        if ((err = alp_mbl_context_get_home_operator_id(defaultContextId, &homeOperatorId)) != ALP_STATUS_OK)
        {
                printf("alp_mbl_context_get_home_operator_id failed with error: %s.\n", alp_err_get_string(err, true));
                return err;
        }

        printf("The associated home operator id is %d.\n", homeOperatorId);

        if ((err = alp_mbl_operator_get_name(homeOperatorId, &operatorName)) != ALP_STATUS_OK)
        {
                if (err == ALP_STATUS_MBL_VALUE_NOT_AVAILABLE)
                {
                        printf("The operator name is not yet available, wait for ALP_MBL_OPERATOR_NOTIFICATION_NAME_AVAILABLE notification.\n");
                        return err;
                }
                else
                {
                        printf("alp_mbl_operator_get_name failed with error: %s.\n", alp_err_get_string(err, true));
                        return err;
                }
        }

        printf("The associated home operator name is %s.\n", operatorName);

        return ALP_STATUS_OK;
}
Since:
ALP iSDK 1.0

alp_status_t alp_mbl_context_get_missed_call_count AlpMblContextId  iContextId,
uint8_t *  oMissedCallCountP
 

Gets the count of missed call.

Parameters:
[in] iContextId - The id of the mobile context that we want to get the missed call count.
[out] oMissedCallCountP - The count of missed call.
Returns:
ALP_STATUS_OK - The missed call count has been retrieved successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

ALP_STATUS_MBL_INVALID_PARAMETER - oMissedCallCountP is NULL, and it's not valid.

Since:
ALP iSDK 1.0

alp_status_t alp_mbl_context_get_network_id AlpMblContextId  iContextId,
AlpMblNetworkId oNetworkIdP
 

Get the network id attached to a mobile context. If the returned id is 0, the mobile context has no associated network. If the function returns ALP_STATUS_MBL_VALUE_NOT_AVAILABLE, it means that the mobile context is registering to a network, and you should wait for the notification ALP_MBL_CONTEXT_NETWORK_ID_CHANGE to know when the mobile context is registered to a network.

Parameters:
[in] iContextId - The id of the mobile context to get its attached network id.
[out] oNetworkIdP - Pointer to a AlpMblNetworkId to store the network id.
Returns:
ALP_STATUS_OK - The network id associated to the mobile context has been retrieved successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_VALUE_NOT_AVAILABLE - The mobile context is registering to a network, wait for ALP_MBL_CONTEXT_NETWORK_ID_CHANGE notification.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist or the status of the mobile context is invalid for this operation. The mobile context should be ALP_MBL_CONTEXT_STATUS_CONNECTED to perform such operation.

ALP_STATUS_MBL_INVALID_PARAMETER - oNetworkIdP is NULL, and it's not valid.

Example:
An example of getting the id of the network associated to the default mobile context.
#include <stdio.h>
#include <alp/mobile.h>
#include <alp/errormgr.h>

alp_status_t prv_get_network_id(AlpMblNetworkId* oNetworkIdP)
{
        AlpMblContextId         defaultContextId;
        alp_status_t            err;

        if ((err = alp_mbl_get_default_context(&defaultContextId)) != ALP_STATUS_OK)
        {
                printf("alp_mbl_get_default_context failed with error: %s.\n", alp_err_get_string(err, true));
                return err;
        }

        printf("The id of the default context is %d.\n", defaultContextId);

        if ((err = alp_mbl_context_get_network_id(defaultContextId, oNetworkIdP)) != ALP_STATUS_OK)
        {
                if (err == ALP_STATUS_MBL_VALUE_NOT_AVAILABLE)
                {
                        printf("The mobile context is registering to a network, wait for ALP_MBL_CONTEXT_NETWORK_ID_CHANGE notification.\n");
                        return err;
                }
                else if (err == ALP_STATUS_MBL_INVALID_OBJECT)
                {
                        printf("The status of the mobile context is not ALP_MBL_CONTEXT_STATUS_CONNECTED, you must start it first.\n");
                        return err;
                }
                else
                {
                        printf("alp_mbl_context_get_status failed with error: %s.\n", alp_err_get_string(err, true));
                        return err;
                }
        }

        printf("The associated network id is %d.\n", *oNetworkIdP);

        return ALP_STATUS_OK;
}
Since:
ALP iSDK 1.0

alp_status_t alp_mbl_context_get_own_number AlpMblContextId  iContextId,
AlpMblOwnNumber oOwnNumberP
 

Gets the own phone number (voice, fax, and data).

Parameters:
[in] iContextId - The id of the mobile Context.
[out] oOwnNumberP - Pointer to a AlpMblOwnNumber structure.
Returns:
ALP_STATUS_OK - The own phone number has been retrieved successfuly.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

ALP_STATUS_MBL_INVALID_PARAMETER - oPhoneNumberP is NULL, and it's not valid.

Since:
ALP iSDK 1.0

alp_status_t alp_mbl_context_get_restricted_contacts AlpMblContextId  iContextId,
AlpMblContextRestrictionList  iList,
AlpMblContextRestrictedContactList oContactListP
 

Get the restricted contacts from a restriction List

Parameters:
[in] iContextId - The id of the Mobile Context.
[in] iList - The list to work on (= ALP_MBL_CONTEXT_WHITE_LIST or ALP_MBL_CONTEXT_BLACK_LIST)
[out] oContactListP - A pointer to a structure list which contains informations about the contacts/persons in the selected list (must be freed)
Returns:
ALP_STATUS_OK - The list of contacts (or persons) has been retrieved successfuly
Since:
ALP iSDK 1.1

alp_status_t alp_mbl_context_get_restriction_list_facility AlpMblContextId  iContextId,
AlpMblContextRestrictionList  iList,
AlpMblContextRestrictionListFacility ioFacilityP
 

Get the specified facilty of a restriction List

Parameters:
[in] iContextId - The id of the Mobile Context.
[in] iList - The list to work on (= ALP_MBL_CONTEXT_WHITE_LIST or ALP_MBL_CONTEXT_BLACK_LIST)
in/out] ioFacilityP - A pointer to a structure to specify the facility and to store the result (see ALP_MBL_CONTEXT_RESTRICTION_LIST_FACILITY_...)
Returns:
ALP_STATUS_OK - The current facility has been retrieved successfuly
Since:
ALP iSDK 1.1
Note:
Deprecated since ALP iSDK 2.0. This API is useless and will be remove to avoid any confusion. Use alp_mbl_context_get_restriction_list_status() to get info on a restriction list.

alp_status_t alp_mbl_context_get_restriction_list_status AlpMblContextId  iContextId,
AlpMblContextRestrictionList  iList,
AlpMblContextRestrictionListStatus oStatusP
 

Get the current status of a restriction List (enable / disable)

Parameters:
[in] iContextId - The id of the Mobile Context.
[in] iList - The list to work on (= ALP_MBL_CONTEXT_WHITE_LIST or ALP_MBL_CONTEXT_BLACK_LIST)
[out] oStatusP - A pointer to return the current status of the restricted list (ALP_MBL_CONTEXT_RESTRICTION_LIST_ENABLE, ALP_MBL_CONTEXT_RESTRICTION_LIST_DISABLE)
Returns:
ALP_STATUS_OK - The current status has been retrieved successfuly
Since:
ALP iSDK 1.1

alp_status_t alp_mbl_context_get_status AlpMblContextId  iContextId,
AlpMblContextStatus oStatusP
 

Get the status of a mobile context

Parameters:
[in] iContextId - The id of the mobile context to get its status.
[out] oStatusP - Pointer to a AlpMblContextStatus to store the context status.
Returns:
ALP_STATUS_OK - The mobile context status has been retrieved successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

ALP_STATUS_MBL_INVALID_PARAMETER - oStatusP is NULL, and it's not valid.

Example:
An example of getting the status of the default mobile context.
#include <stdio.h>
#include <alp/mobile.h>
#include <alp/errormgr.h>

alp_status_t prv_get_default_context_status(AlpMblContextStatus* oStatusP)
{
        AlpMblContextId         defaultContextId;
        alp_status_t            err;

        if ((err = alp_mbl_get_default_context(&defaultContextId)) != ALP_STATUS_OK)
        {
                printf("alp_mbl_get_default_context failed with error: %s.\n", alp_err_get_string(err, true));
                return err;
        }

        printf("The id of the default context is %d.\n", defaultContextId);

        if ((err = alp_mbl_context_get_status(defaultContextId, oStatusP)) != ALP_STATUS_OK)
        {
                printf("alp_mbl_context_get_status failed with error: %s.\n", alp_err_get_string(err, true));
                return err;
        }

        switch (*oStatusP)
        {
        case ALP_MBL_CONTEXT_STATUS_CONNECTED:
                printf("The status of the default context is ALP_MBL_CONTEXT_STATUS_CONNECTED.\n");
                break;
        case ALP_MBL_CONTEXT_STATUS_DISCONNECTED:
                printf("The status of the default context is ALP_MBL_CONTEXT_STATUS_DISCONNECTED.\n");
                break;
        case ALP_MBL_CONTEXT_STATUS_CONNECTING:
                printf("The status of the default context is ALP_MBL_CONTEXT_STATUS_CONNECTING.\n");
                break;
        case ALP_MBL_CONTEXT_STATUS_DISCONNECTING:
                printf("The status of the default context is ALP_MBL_CONTEXT_STATUS_DISCONNECTING.\n");
                break;
        case ALP_MBL_CONTEXT_STATUS_UNKNOWN:
                printf("The status of the default context is ALP_MBL_CONTEXT_STATUS_UNKNOWN.\n");
                break;
        default:
                printf("The status of the default context is unknow: %d.\n", *oStatusP);
                break;
        }

        return ALP_STATUS_OK;
}
Since:
ALP iSDK 1.0

alp_status_t alp_mbl_context_get_subscriber_id AlpMblContextId  iContextId,
AlpMblContextSubscriberId oContextSubscriberIdP
 

Get the subscriber identity of a mobile context. If the mobile context type is cellular, the subscriber identify is the IMSI code.

Parameters:
[in] iContextId - The id of the mobile context to get its subscriber id.
[out] oContextSubscriberIdP - Pointer to a AlpMblContextSubscriberId to store the context subscriber id.
Returns:
ALP_STATUS_OK - The subscriber identity of the mobile context has been retrieved successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

ALP_STATUS_MBL_INVALID_PARAMETER - oContextSubscriberIdP is NULL, and it's not valid.

Since:
ALP iSDK 1.0

alp_status_t alp_mbl_context_get_type AlpMblContextId  iContextId,
AlpMblContextType oContextTypeP
 

Get the type of a mobile context

Parameters:
[in] iContextId - The id of the mobile context to get its type.
[out] oContextTypeP - Pointer to a AlpMblContextType to store the context type.
Returns:
ALP_STATUS_OK - The type of the mobile context has been retrieved successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

ALP_STATUS_MBL_INVALID_PARAMETER - oContextTypeP is NULL, and it's not valid.

Since:
ALP iSDK 1.0

alp_status_t alp_mbl_context_get_unit_price AlpMblContextId  iContextId,
AlpMblCost oUnitPriceP
 

Get the price of a unit for a Mobile Context.

Parameters:
[in] iContextId - The id of the mobile context to get its unit price.
[out] oUnitPriceP - Pointer to a AlpMblCost to store the unit price of the Mobile Context.
Returns:
ALP_STATUS_OK - The unit price of the mobile context has been retrieved successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

ALP_STATUS_MBL_INVALID_PARAMETER - oUnitPriceP is NULL, and it's not valid.

Since:
ALP iSDK 1.1

alp_status_t alp_mbl_context_get_voice_mail_indicator_status AlpMblContextId  iContextId,
bool *  oIndicatorStatusP,
uint8_t *  oVoiceMailCountP
 

Gets the status of the voice mail indicator.

Parameters:
[in] iContextId - The id of the mobile context that we want to get the voice mail indicator status.
[out] oIndicatorStatusP - Status indicator: true, display a voicemail indicator icon; false, do not display a voicemail indicator icon.
[out] oVoiceMailCountP - The count of voicemail. Only return when oIndicatorStatusP is true. If 0, the information is not provided.
Returns:
ALP_STATUS_OK - The voice mail status indicator has been retrieved successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

ALP_STATUS_MBL_INVALID_PARAMETER - Both oIndicatorStatusP and oVoiceMailCountP are NULL, and it's not valid.

Since:
ALP iSDK 1.0

alp_status_t alp_mbl_context_hold_active_calls AlpMblContextId  iContextId  ) 
 

Put on hold all the active calls of a mobile context.

Parameters:
[in] iContextId - The id of the mobile context that we want to have all its active calls put on hold.
Returns:
ALP_STATUS_OK - The active calls have been put on hold successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

Since:
ALP iSDK 1.0

alp_status_t alp_mbl_context_is_emergency_number AlpMblContextId  iContextId,
AlpMblAddress  iAddress,
bool *  oIsEmergencyNumberP
 

Check if the number is an emergency call for the specified mobile context.

Parameters:
[in] iContextId - The id of the mobile context.
[in] iAddress - The number to check.
[out] oIsEmergencyNumberP - True if the number is an emergency call for the context, false otherwise.
Returns:
ALP_STATUS_OK - The emergency status of the call has been retrieved successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

ALP_STATUS_MBL_INVALID_PARAMETER - oIsEmergencyNumberP is NULL, and it's not valid.

Since:
ALP iSDK 1.0

alp_status_t alp_mbl_context_new_call AlpMblContextId  iContextId,
AlpMblAddress  iAddress,
AlpMblCallId oCallIdP
 

Create a new voice call.

Parameters:
[in] iContextId - The id of the mobile context that will create the voice call.
[in] iAddress - The address to use with the call.
[out] oCallIdP - Pointer to a AlpMblCallId to store the call.
Returns:
ALP_STATUS_OK - The call has been created successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

Example:
An example of creating and dialing a number, using the default mobile context.
#include <stdio.h>
#include <string.h>
#include <alp/mobile.h>
#include <alp/mobile_call.h>
#include <alp/errormgr.h>

alp_status_t prv_dial_number(char* iNumberP)
{
        AlpMblContextId         defaultContextId;
        AlpMblAddress           address;
        AlpMblCallId            callId;
        alp_status_t            err;

        if ((err = alp_mbl_get_default_context(&defaultContextId)) != ALP_STATUS_OK)
        {
                printf("alp_mbl_get_default_context failed with error: %s.\n", alp_err_get_string(err, true));
                return err;
        }

        strncpy(address, iNumberP, sizeof(AlpMblAddress));
        address[sizeof(AlpMblAddress) - 1] = '\0';

        if ((err = alp_mbl_context_new_call(defaultContextId, address, &callId)) != ALP_STATUS_OK)
        {
                printf("alp_mbl_context_new_call failed with error: %s.\n", alp_err_get_string(err, true));
                return err;
        }

        if ((err = alp_mbl_call_dial(callId)) != ALP_STATUS_OK)
        {
                printf("alp_mbl_call_dial failed with error: %s.\n", alp_err_get_string(err, true));
                return err;
        }

        printf("Call %s is dialing...\n", address);

        return ALP_STATUS_OK;
}
Since:
ALP iSDK 1.0

alp_status_t alp_mbl_context_new_emergency_call AlpMblContextId  iContextId,
AlpMblAddress  iAddress,
AlpMblCallId oCallIdP
 

Create a new emergency call.

Parameters:
[in] iContextId - The id of the mobile context that will create the emergency call.
[in] iAddress - The address to use with the call. Could be NULL to use the default emergency number. If the number is not a valid emergency number, the default emergency number will be used.
[out] oCallIdP - Pointer to a AlpMblCallId to store the emergency call.
Returns:
ALP_STATUS_OK - The emergency call has been created successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

ALP_STATUS_MBL_INVALID_PARAMETER - oCallIdP is NULL, and it's not valid.

Example:
An example of creating and dialing an emergency number, using the default mobile context.
#include <stdio.h>
#include <alp/mobile.h>
#include <alp/mobile_call.h>
#include <alp/errormgr.h>

alp_status_t prv_dial_emergency()
{
        AlpMblContextId         defaultContextId;
        AlpMblCallId            callId;
        alp_status_t            err;

        if ((err = alp_mbl_get_default_context(&defaultContextId)) != ALP_STATUS_OK)
        {
                printf("alp_mbl_get_default_context failed with error: %s.\n", alp_err_get_string(err, true));
                return err;
        }

        if ((err = alp_mbl_context_new_emergency_call(defaultContextId, NULL, &callId)) != ALP_STATUS_OK)
        {
                printf("alp_mbl_context_new_emergency_call failed with error: %s.\n", alp_err_get_string(err, true));
                return err;
        }

        if ((err = alp_mbl_call_dial(callId)) != ALP_STATUS_OK)
        {
                printf("alp_mbl_call_dial failed with error: %s.\n", alp_err_get_string(err, true));
                return err;
        }

        printf("Emergency call is dialing...\n");

        return ALP_STATUS_OK;
}
Since:
ALP iSDK 1.0

alp_status_t alp_mbl_context_new_video_call AlpMblContextId  iContextId,
AlpMblAddress  iAddress,
AlpMblCallId oCallIdP
 

Create a new video call.

Parameters:
[in] iContextId - The id of the mobile context that will create the video call.
[in] iAddress - The address to use with the call.
[out] oCallIdP - Pointer to a AlpMblCallId to store the call.
Returns:
ALP_STATUS_OK - The call has been created successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

Since:
ALP iSDK 1.1

alp_status_t alp_mbl_context_release_active_calls AlpMblContextId  iContextId  ) 
 

Release all the active calls of a mobile context.

Parameters:
[in] iContextId - The id of the mobile context that we want to have its active calls released.
Returns:
ALP_STATUS_OK - The mobile context active calls have been released successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

Since:
ALP iSDK 2.3

alp_status_t alp_mbl_context_release_calls AlpMblContextId  iContextId  ) 
 

Release all the calls of a mobile context.

Parameters:
[in] iContextId - The id of the mobile context that we want to have all its calls released.
Returns:
ALP_STATUS_OK - The mobile context calls have been released successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

Since:
ALP iSDK 1.0

alp_status_t alp_mbl_context_release_held_calls AlpMblContextId  iContextId  ) 
 

Release all the held calls of a mobile context.

Parameters:
[in] iContextId - The id of the mobile context that we want to have its held calls released.
Returns:
ALP_STATUS_OK - The mobile context held calls have been released successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

Since:
ALP iSDK 2.3

alp_status_t alp_mbl_context_remove_restricted_contact AlpMblContextId  iContextId,
AlpMblContextRestrictionList  iList,
AlpMblContextRestrictedContact iContactP
 

Remove a contact or all the contacts of one person from a restriction list (White List, Black list...)

Parameters:
[in] iContextId - The id of the Mobile Context.
[in] iList - The list to work on (= ALP_MBL_CONTEXT_WHITE_LIST, ALP_MBL_CONTEXT_BLACK_LIST...)
[in] iContactP - A Structure which contains informations about the contact/person to remove if the contact and the person in this structure is nul (=0), the whole of the list is removed.
Returns:
ALP_STATUS_OK - The contact (or person) has been removed successfuly
Since:
ALP iSDK 1.1

alp_status_t alp_mbl_context_reset_call_counter AlpMblContextId  iContextId,
AlpMblContextCallCounterType  iCallCounterType
 

Resets call counter information.

Parameters:
[in] iContextId - The id of the mobile context that we want to get the missed call count.
[in] iCallCounterType - Type of call counter to reset.
Returns:
ALP_STATUS_OK - The call counter information has been reset successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

Since:
ALP iSDK 1.0

alp_status_t alp_mbl_context_reset_cost AlpMblContextId  iContextId  ) 
 

Reset the cost of a Mobile Context.

Parameters:
[in] iContextId - The id of the mobile context to reste its cost.
Returns:
ALP_STATUS_OK - The cost of the mobile context has been reset successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

Since:
ALP iSDK 1.1

alp_status_t alp_mbl_context_set_answer_mode AlpMblContextId  iContextId,
AlpMblContextAnswerMode  iAnswerMode
 

Sets the answer mode.

Parameters:
[in] iContextId - The id of the mobile context that we want to set the answer mode.
[in] iAnswerMode - The answer mode.
Returns:
ALP_STATUS_OK - The answer mode has been set successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

ALP_STATUS_MBL_INVALID_PARAMETER - iAnswerMode is not valid: must be ALP_MBL_CONTEXT_ANSWER_MODE_KEY_OR_BUTTON, ALP_MBL_CONTEXT_ANSWER_MODE_ANY_KEY or ALP_MBL_CONTEXT_ANSWER_MODE_AUTOMATIC.

Since:
ALP iSDK 1.0

alp_status_t alp_mbl_context_set_callid_restriction_status AlpMblContextId  iContextId,
AlpMblContextCallerIdRestrictionAdjustment  iCallIdRestrictionAdjustment
 

Sets the CLIR adjustment for outgoing calls

Parameters:
[in] iContextId - The id of the mobile Context.
[in] iCallIdRestriction - parameter to set the adjustment.
Returns:
ALP_STATUS_OK - The callid restriction status has been set successfuly.
Since:
ALP iSDK 1.1

alp_status_t alp_mbl_context_set_cost_limit AlpMblContextId  iContextId,
AlpMblCost  iCostLimit
 

Set the cost limit of a Mobile Context.

Parameters:
[in] iContextId - The id of the mobile context to set its cost limit.
[in] iCostLimit - A AlpMblCost that is the cost limit to set for the Mobile Context.
Returns:
ALP_STATUS_OK - The cost limit of the mobile context has been set successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

ALP_STATUS_MBL_INVALID_PARAMETER - The cost limit is not valid.

Since:
ALP iSDK 1.1

alp_status_t alp_mbl_context_set_currency AlpMblContextId  iContextId,
AlpMblCurrency  iCurrency
 

Set the currency of a Mobile Context.

Parameters:
[in] iContextId - The id of the mobile context to set its currency.
[in] iCurrencyP - Pointer to a AlpMblCurrency to set the currency of the Mobile Context.
Returns:
ALP_STATUS_OK - The currency of the mobile context has been retrieved successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

Since:
ALP iSDK 2.1

alp_status_t alp_mbl_context_set_current_line AlpMblContextId  iContextId,
AlpMblLineId  iLineId
 

Sets the current line of a Mobile Context.

Parameters:
[in] iContextId - The id of the Mobile Context.
[in] iLineId - The id of the line to set.
Returns:
ALP_STATUS_OK - The current line has been set successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist or its status is not ALP_MBL_CONTEXT_STATUS_CONNECTED.

Since:
ALP iSDK 1.1

alp_status_t alp_mbl_context_set_own_number AlpMblContextId  iContextId,
AlpMblOwnNumber iOwnNumberP
 

Sets the own phone number (voice, fax, and data).

Parameters:
[in] iContextId - The id of the mobile Context.
[in] iOwnNumberP - Pointer to a AlpMblOwnNumber structure.
Returns:
ALP_STATUS_OK - The own phone number has been set successfuly.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

Since:
ALP iSDK 1.0

alp_status_t alp_mbl_context_set_restriction_list_status AlpMblContextId  iContextId,
AlpMblContextRestrictionList  iList,
AlpMblContextRestrictionListStatus  iStatus
 

Set the current status of a restriction List (enable / disable)

Parameters:
[in] iContextId - The id of the Mobile Context.
[in] iList - The list to work on (= ALP_MBL_CONTEXT_WHITE_LIST or ALP_MBL_CONTEXT_BLACK_LIST)
[in] iStatus - The status for the restricted list (ALP_MBL_CONTEXT_RESTRICTION_LIST_ENABLE, ALP_MBL_CONTEXT_RESTRICTION_LIST_DISABLE)
Returns:
ALP_STATUS_OK - The current status has been setted successfuly
Since:
ALP iSDK 1.1

alp_status_t alp_mbl_context_set_unit_price AlpMblContextId  iContextId,
AlpMblCost  iUnitPrice
 

Set the price of a unit for a Mobile Context.

Parameters:
[in] iContextId - The id of the mobile context to set its unit price.
[in] iUnitPriceP - Pointer to a AlpMblCost to set the unit price of the Mobile Context.
Returns:
ALP_STATUS_OK - The unit price of the mobile context has been retrieved successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

Since:
ALP iSDK 2.1

alp_status_t alp_mbl_context_start AlpMblContextId  iContextId  ) 
 

Start a mobile context.

If the mobile context is a GSM one, the connection with the phone module will be opened, the authentication will be checked, and the phone module will register to the network.

Parameters:
[in] iContextId - The id of the mobile context to start.
Returns:
ALP_STATUS_OK - The mobile context has been strated successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

Example:
An example of starting the default mobile context.
#include <stdio.h>
#include <alp/mobile.h>
#include <alp/errormgr.h>

alp_status_t prv_start_default_context()
{
        AlpMblContextId         defaultContextId;
        alp_status_t            err;

        if ((err = alp_mbl_get_default_context(&defaultContextId)) != ALP_STATUS_OK)
        {
                printf("alp_mbl_get_default_context failed with error: %s.\n", alp_err_get_string(err, true));
                return err;
        }

        printf("The id of the default context is %d.\n", defaultContextId);

        if ((err = alp_mbl_context_start(defaultContextId)) != ALP_STATUS_OK)
        {
                printf("alp_mbl_context_start failed with error: %s.\n", alp_err_get_string(err, true));
                return err;
        }

        printf("The default context is now ALP_MBL_CONTEXT_STATUS_CONNECTING, we have check ALP_MBL_CONTEXT_NOTIFICATION_STATUS_CHANGE to know when the mobile context is ALP_MBL_CONTEXT_STATUS_CONNECTED, or if there was a failure.\n");

        return ALP_STATUS_OK;
}
Since:
ALP iSDK 1.0

alp_status_t alp_mbl_context_stop AlpMblContextId  iContextId  ) 
 

Stop a mobile context.

Parameters:
[in] iContextId - The id of the mobile context to start.
Returns:
ALP_STATUS_OK - The mobile context has been stopped successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - The context id is not valid: the context doesn't exist.

Example:
An example of stopping the default mobile context.
#include <stdio.h>
#include <alp/mobile.h>
#include <alp/errormgr.h>

alp_status_t prv_stop_default_context()
{
        AlpMblContextId         defaultContextId;
        alp_status_t            err;

        if ((err = alp_mbl_get_default_context(&defaultContextId)) != ALP_STATUS_OK)
        {
                printf("alp_mbl_get_default_context failed with error: %s.\n", alp_err_get_string(err, true));
                return err;
        }

        printf("The id of the default context is %d.\n", defaultContextId);

        if ((err = alp_mbl_context_stop(defaultContextId)) != ALP_STATUS_OK)
        {
                printf("alp_mbl_context_stop failed with error: %s.\n", alp_err_get_string(err, true));
                return err;
        }

        printf("The default context is now ALP_MBL_CONTEXT_STATUS_DISCONNECTING, we have check ALP_MBL_CONTEXT_NOTIFICATION_STATUS_CHANGE to know when the mobile context is ALP_MBL_CONTEXT_STATUS_DISCONNECTED, or if there was a failure.\n");

        return ALP_STATUS_OK;
}
Since:
ALP iSDK 1.0


Generated on Wed Jul 30 07:06:42 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.