include/alp/mobile_context.h File Reference


Detailed Description

This public header file contains all mobile context prototypes.

#include <alp/mobile_services.h>
#include <alp/mobile_call.h>
#include <alp/mobile_operator.h>
#include <alp/mobile_line.h>

Go to the source code of this file.

Data Structures

struct  _AlpMblAddressList
struct  _AlpMblContextCallCounter
struct  _AlpMblContextList
struct  _AlpMblContextRestrictedContact
struct  _AlpMblContextRestrictedContactByAddress
struct  _AlpMblContextRestrictedContactList
struct  _AlpMblContextRestrictionListFacility
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 _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 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 _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)


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

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