Line Service
[Mobile Services]

Detailed Description

This service set gives access to the line of a Mobile Context.

You can set a name for a line, and retrieve information like the numbers of the line, or its voice mail.

A Mobile Context could have multiple line, but only one line is the current one.

Data Structures

struct _AlpMblLineList

Defines

#define ALP_MBL_LINE_NOTIFICATION_ADDRESS_CHANGE   ((AlpMblNotificationId) 3)

The address of a line has change.

#define ALP_MBL_LINE_NOTIFICATION_NAME_CHANGE   ((AlpMblNotificationId) 1)

The name of a line has change.

#define ALP_MBL_LINE_NOTIFICATION_VOICE_MAIL_CHANGE   ((AlpMblNotificationId) 2)

The voice mail of a line has change.

Typedefs

typedef void(* AlpMblLineAddressChangeCallbackPtr )(void *iUserDataP, AlpMblLineId iLineId, AlpMblAddress iPrevious, AlpMblAddress iCurrent)

typedef unsigned char AlpMblLineId

Line identifier.

typedef _AlpMblLineList AlpMblLineList

typedef char AlpMblLineName [32]

The name associated to a line.

typedef void(* AlpMblLineNameChangeCallbackPtr )(void *iUserDataP, AlpMblLineId iLineId, AlpMblLineName iPrevious, AlpMblLineName iCurrent)

typedef void(* AlpMblLineVoiceMailChangeCallbackPtr )(void *iUserDataP, AlpMblLineId iLineId, AlpMblAddress iPrevious, AlpMblAddress iCurrent)

Functions

alp_status_t alp_mbl_line_get_address (AlpMblLineId iLineId, AlpMblAddress *oAddressP)

alp_status_t alp_mbl_line_get_name (AlpMblLineId iLineId, AlpMblLineName *oNameP)

alp_status_t alp_mbl_line_get_voice_mail (AlpMblLineId iLineId, AlpMblAddress *oVoiceMailP)

alp_status_t alp_mbl_line_set_address (AlpMblLineId iLineId, AlpMblAddress iAddress)

alp_status_t alp_mbl_line_set_name (AlpMblLineId iLineId, AlpMblLineName iName)

alp_status_t alp_mbl_line_set_voice_mail (AlpMblLineId iLineId, AlpMblAddress iVoiceMail)

Define Documentation

#define ALP_MBL_LINE_NOTIFICATION_ADDRESS_CHANGE ((AlpMblNotificationId) 3)

The address of a line has change.

#define ALP_MBL_LINE_NOTIFICATION_NAME_CHANGE ((AlpMblNotificationId) 1)

The name of a line has change.

#define ALP_MBL_LINE_NOTIFICATION_VOICE_MAIL_CHANGE ((AlpMblNotificationId) 2)

The voice mail of a line has change.

Typedef Documentation

typedef void(* AlpMblLineAddressChangeCallbackPtr)(void *iUserDataP, AlpMblLineId iLineId, AlpMblAddress iPrevious, AlpMblAddress iCurrent)

Callback prototype for ALP_MBL_LINE_NOTIFICATION_ADDRESS_CHANGE notification of the ALP_MBL_LINE_SERVICE_ID service.
Parameters:

[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.

[in] iLineId - Id of the line that its address has change.

[in] iPrevious - The previous address of the line.

[in] iCurrent - The new address of the line.

typedef unsigned char AlpMblLineId

Line identifier.

typedef struct _AlpMblLineList AlpMblLineList

typedef char AlpMblLineName[32]

The name associated to a line.

typedef void(* AlpMblLineNameChangeCallbackPtr)(void *iUserDataP, AlpMblLineId iLineId, AlpMblLineName iPrevious, AlpMblLineName iCurrent)

Callback prototype for ALP_MBL_LINE_NOTIFICATION_NAME_CHANGE notification of the ALP_MBL_LINE_SERVICE_ID service.
Parameters:

[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.

[in] iLineId - Id of the line that its name has change.

[in] iPrevious - The previous name of the line.

[in] iCurrent - The new name of the line.

typedef void(* AlpMblLineVoiceMailChangeCallbackPtr)(void *iUserDataP, AlpMblLineId iLineId, AlpMblAddress iPrevious, AlpMblAddress iCurrent)

Callback prototype for ALP_MBL_LINE_NOTIFICATION_VOICE_MAIL_CHANGE notification of the ALP_MBL_LINE_SERVICE_ID service.
Parameters:

[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.

[in] iLineId - Id of the line that its voice mail has change.

[in] iPrevious - The previous voice mail of the line.

[in] iCurrent - The new voice mail of the line.

Function Documentation

alp_status_t alp_mbl_line_get_address ( AlpMblLineId iLineId,

AlpMblAddress * oAddressP

)

Get the address of a line.

Parameters:

[in] iLineId - The id of the line.

[out] oAddressP - Pointer to an AlpMblAddress to store the address of the line.

Returns:
ALP_STATUS_OK - The address 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 line id is not valid: the line doesn't exist.

Since:
ALP iSDK 2.2

alp_status_t alp_mbl_line_get_name ( AlpMblLineId iLineId,

AlpMblLineName * oNameP

)

Get the name associated to a line.

Parameters:

[in] iLineId - The id of the line.

[out] oNameP - Pointer to an AlpMblLineName to store the name of the line.

Returns:
ALP_STATUS_OK - The name 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 line id is not valid: the line doesn't exist.

Since:
ALP iSDK 1.1

alp_status_t alp_mbl_line_get_voice_mail ( AlpMblLineId iLineId,

AlpMblAddress * oVoiceMailP

)

Get the voice mail of a line.

Parameters:

[in] iLineId - The id of the line.

[out] oVoiceMailP - Pointer to an AlpMblAddress to store the voice mail of the line.

Returns:
ALP_STATUS_OK - The voice mail 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 line id is not valid: the line doesn't exist.

Since:
ALP iSDK 1.1

alp_status_t alp_mbl_line_set_address ( AlpMblLineId iLineId,

AlpMblAddress iAddress

)

Set the address of a line.

Parameters:

[in] iLineId - The id of the line.

[in] iAddress - An AlpMblAddress which is the new address for the line.

Returns:
ALP_STATUS_OK - The address has been changed 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 line id is not valid: the line doesn't exist.

Since:
ALP iSDK 2.2

alp_status_t alp_mbl_line_set_name ( AlpMblLineId iLineId,

AlpMblLineName iName

)

Set the name associated to a line.

Parameters:

[in] iLineId - The id of the line.

[in] iName - An AlpMblLineName that is the new name of the line.

Returns:
ALP_STATUS_OK - The name 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 line id is not valid: the line doesn't exist.

Since:
ALP iSDK 1.1

alp_status_t alp_mbl_line_set_voice_mail ( AlpMblLineId iLineId,

AlpMblAddress iVoiceMail

)

Set the voice mail of a line. If the voice mail number is not provided, the Mobile Services will popup a dialog to ask the user.

Parameters:

[in] iLineId - The id of the line.

[in] iVoiceMail - An AlpMblAddress which is the new voice mail for the line. Could be set to '0' to ask the Mobile Services to popup a dialog to ask the user.

Returns:
ALP_STATUS_OK - The voice mail has been changed 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 line id is not valid: the line doesn't exist.

Since:
ALP iSDK 1.1

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


Data Structures
struct	_AlpMblLineList
Defines
#define	ALP_MBL_LINE_NOTIFICATION_ADDRESS_CHANGE ((AlpMblNotificationId) 3)
	The address of a line has change.
#define	ALP_MBL_LINE_NOTIFICATION_NAME_CHANGE ((AlpMblNotificationId) 1)
	The name of a line has change.
#define	ALP_MBL_LINE_NOTIFICATION_VOICE_MAIL_CHANGE ((AlpMblNotificationId) 2)
	The voice mail of a line has change.
Typedefs
typedef void(*	AlpMblLineAddressChangeCallbackPtr )(void *iUserDataP, AlpMblLineId iLineId, AlpMblAddress iPrevious, AlpMblAddress iCurrent)
typedef unsigned char	AlpMblLineId
	Line identifier.
typedef _AlpMblLineList	AlpMblLineList
typedef char	AlpMblLineName [32]
	The name associated to a line.
typedef void(*	AlpMblLineNameChangeCallbackPtr )(void *iUserDataP, AlpMblLineId iLineId, AlpMblLineName iPrevious, AlpMblLineName iCurrent)
typedef void(*	AlpMblLineVoiceMailChangeCallbackPtr )(void *iUserDataP, AlpMblLineId iLineId, AlpMblAddress iPrevious, AlpMblAddress iCurrent)
Functions
alp_status_t	alp_mbl_line_get_address (AlpMblLineId iLineId, AlpMblAddress *oAddressP)
alp_status_t	alp_mbl_line_get_name (AlpMblLineId iLineId, AlpMblLineName *oNameP)
alp_status_t	alp_mbl_line_get_voice_mail (AlpMblLineId iLineId, AlpMblAddress *oVoiceMailP)
alp_status_t	alp_mbl_line_set_address (AlpMblLineId iLineId, AlpMblAddress iAddress)
alp_status_t	alp_mbl_line_set_name (AlpMblLineId iLineId, AlpMblLineName iName)
alp_status_t	alp_mbl_line_set_voice_mail (AlpMblLineId iLineId, AlpMblAddress iVoiceMail)

Line Service [Mobile Services]

Detailed Description

Data Structures

Defines

Typedefs

Functions

Define Documentation

Typedef Documentation

Function Documentation

Line Service
[Mobile Services]