Speed Dial Service
[Mobile Services]

Detailed Description

This service groups the Speed Dial functions.


Data Structures

struct  _AlpMblSpeedDialEntry
struct  _AlpMblSpeedDialList

Typedefs

typedef _AlpMblSpeedDialEntry AlpMblSpeedDialEntry
typedef uint8_t AlpMblSpeedDialIndex
typedef _AlpMblSpeedDialList AlpMblSpeedDialList

Functions

alp_status_t alp_mbl_speed_dial_add (AlpLuid iContactLuid, AlpMblSpeedDialIndex *oIndexP)
alp_status_t alp_mbl_speed_dial_dial (AlpLuid iContactLuid, AlpMblCallId *oCallIdP)
alp_status_t alp_mbl_speed_dial_get_list (AlpMblSpeedDialList *oSpeedDialListP)
alp_status_t alp_mbl_speed_dial_move (AlpLuid iContactLuid, AlpMblSpeedDialIndex iNewIndex)
alp_status_t alp_mbl_speed_dial_remove (AlpLuid iContactLuid)
alp_status_t alp_mbl_speed_dial_video_dial (AlpLuid iContactLuid, AlpMblCallId *oCallIdP)

Typedef Documentation

typedef struct _AlpMblSpeedDialEntry AlpMblSpeedDialEntry
 

typedef uint8_t AlpMblSpeedDialIndex
 

typedef struct _AlpMblSpeedDialList AlpMblSpeedDialList
 

Function Documentation

alp_status_t alp_mbl_speed_dial_add (  AlpLuid  iContactLuid,
AlpMblSpeedDialIndex *  oIndexP
) 
 

Add a contact to the speed dial database.

Parameters:
[in] iContactLuid - Contact to add.
[out] oIndexP - Index of this contact in the speed dial database. Could be NULL. Index is 0-based.
Returns:
ALP_STATUS_OK - The spee dial list 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.

Since:
ALP iSDK 1.0

alp_status_t alp_mbl_speed_dial_dial (  AlpLuid  iContactLuid,
AlpMblCallId *  oCallIdP
) 
 

Dial the specified contact, using a voice call.

Parameters:
[in] iContactLuid - Contact to dial.
[out] oCallIdP - Pointer to an AlpMblCallId that will get the calld id upon return. Could be NULL.
Returns:
ALP_STATUS_OK - The contact has been dial successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

Example:
An example of dialing a contact, using the first entry of the speed dial. 
#include <stdio.h>
#include <alp/mobile.h>
#include <alp/mobile_speed_dial.h>
#include <alp/errormgr.h>

alp_status_t prv_dial_first_speed_dial()
{
        AlpMblSpeedDialList     speedDialList;
        AlpMblCallId            callId;
        alp_status_t            err;

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

        if (speedDialList.count == 0)
        {
                printf("There is no speed dial entry.\n");
                return ALP_STATUS_OK;
        }

        if ((err = alp_mbl_speed_dial_dial(speedDialList.listP[0].contactLuid, &callId)) != ALP_STATUS_OK)
        {
                printf("alp_mbl_speed_dial_dial failed with error: %s.\n", alp_err_get_string(err, true));
                goto cleanup;
        }

        printf("Call (%ld) is dialing.\n", callId);

cleanup:
        alp_mbl_free(speedDialList.listP);

        return err;
}
Since:
ALP iSDK 1.0

alp_status_t alp_mbl_speed_dial_get_list (  AlpMblSpeedDialList *  oSpeedDialListP  ) 
 

Return the list of speed dial entry.

Parameters:
[out] oSpeedDialListP - Pointer to a list of speed dial entry.
Returns:
ALP_STATUS_OK - The spee dial list 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.

Example:
An example of getting the list of speed dial. 
#include <stdio.h>
#include <alp/mobile.h>
#include <alp/mobile_speed_dial.h>
#include <alp/errormgr.h>

alp_status_t prv_list_speed_dial()
{
        AlpMblSpeedDialList     speedDialList;
        uint8_t                         i;
        alp_status_t            err;

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

        printf("There is (are) %d speed dial entry(ies).\n", speedDialList.count);

        for ( i = 0 ; i < speedDialList.count ; i++ )
        {
                printf("%d - contact luid (%lu), position (%lu).\n", i, speedDialList.listP[i].contactLuid, speedDialList.listP[i].position);
        }

        alp_mbl_free(speedDialList.listP);

        return err;
}
Since:
ALP iSDK 1.0

alp_status_t alp_mbl_speed_dial_move (  AlpLuid  iContactLuid,
AlpMblSpeedDialIndex  iNewIndex
) 
 

Move a contact in the speed dial database.

Parameters:
[in] iContactLuid - Contact to remove.
[in] iNewIndex - New position of the contact (index is 0-based).
Returns:
ALP_STATUS_OK - The spee dial list 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.

Since:
ALP iSDK 1.0

alp_status_t alp_mbl_speed_dial_remove (  AlpLuid  iContactLuid  ) 
 

Remove a contact from the speed dial database.

Parameters:
[in] iContactLuid - Contact to remove.
Returns:
ALP_STATUS_OK - The spee dial list 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.

Since:
ALP iSDK 1.0

alp_status_t alp_mbl_speed_dial_video_dial (  AlpLuid  iContactLuid,
AlpMblCallId *  oCallIdP
) 
 

Dial the specified contact, using a video call.

Parameters:
[in] iContactLuid - Contact to dial.
[out] oCallIdP - Pointer to an AlpMblCallId that will get the calld id upon return. Could be NULL.
Returns:
ALP_STATUS_OK - The contact has been dial successfully.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

Since:
ALP iSDK 1.1

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

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