Contact List
[IMPS]

Detailed Description

Postal IMPS contact_list management APIs.


Defines

#define ALP_POSTAL_IMPS_PROPERTY_CONTACT_LIST_DEFAULT   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_CONTACT_LIST, ALP_POSTAL_PROPERTY_TYPE_BOOLEAN, 3)
 list default.
#define ALP_POSTAL_IMPS_PROPERTY_CONTACT_LIST_ID   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_CONTACT_LIST, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 1)
 listId.
#define ALP_POSTAL_IMPS_PROPERTY_CONTACT_LIST_NAME   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_CONTACT_LIST, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 2)
 list name.

Typedefs

typedef alp_postal_object_id_t alp_postal_imps_contact_list_id_t
 Contact List identifier type.
typedef void(* AlpPostalImpsContactListCreateAsyncReplyCallback )(alp_postal_session_id_t iSessionId, AlpPostalImpsContactList *iContactListP, alp_status_t iRequestResult)
 Postal Imps Async CreateList Callback.
typedef void(* AlpPostalImpsContactListDeleteAsyncReplyCallback )(alp_postal_session_id_t iSessionId, alp_postal_imps_contact_list_char_t iContactListWVId, alp_status_t iRequestResult)
 Postal Imps Async DeleteList Callback.
typedef void(* AlpPostalImpsContactListUpdateAsyncReplyCallback )(alp_postal_session_id_t iSessionId, AlpPostalImpsContactList *iContactListP, alp_status_t iRequestResult)
 Postal Imps Async UpdateList Callback.

Functions

alp_status_t alp_postal_imps_contact_list_cancel_create (alp_postal_session_id_t iSessionId)
 Cancel the create_contact_list request.
alp_status_t alp_postal_imps_contact_list_cancel_delete (alp_postal_session_id_t iSessionId)
 Cancel the delete_contact_list request.
alp_status_t alp_postal_imps_contact_list_cancel_update (alp_postal_session_id_t iSessionId)
 Cancel the update_contact_list request.
alp_status_t alp_postal_imps_contact_list_create (alp_postal_session_id_t iSessionId, AlpPostalImpsContactList *iContactListP, AlpPostalImpsNickList *iNickList, AlpPostalImpsContactListCreateAsyncReplyCallback iCallbackFuncP)
 Create a new contactList in the indicated session.
alp_status_t alp_postal_imps_contact_list_delete (alp_postal_session_id_t iSessionId, alp_postal_imps_contact_list_char_t iContactListID, AlpPostalImpsContactListDeleteAsyncReplyCallback iCallbackFuncP)
 Delete a contactList in the indicated session.
alp_status_t alp_postal_imps_contact_list_free (AlpPostalImpsContactList *iContactListP)
 Free a ContactList.
alp_status_t alp_postal_imps_contact_list_free_property (AlpPostalProperty *iImpsContactListPropertyP)
 Free a retrieved contactList property.
alp_status_t alp_postal_imps_contact_list_get (alp_postal_account_id_t iAccountId, alp_postal_imps_contact_list_char_t iContactListWvId, AlpPostalImpsContactList *oImpsContactListP)
 Get a stored contactList.
alp_status_t alp_postal_imps_contact_list_get_property (AlpPostalImpsContactList *iImpsContactListP, alp_postal_property_id_t iPropertyId, AlpPostalProperty **oImpsContactListPropertyP)
 Get a property from a contactList.
alp_status_t alp_postal_imps_contact_list_init (AlpPostalImpsContactList *iImpsContactListP)
 Initialize an ImpsContactList. MUST be called before used.
alp_status_t alp_postal_imps_contact_list_set_property (AlpPostalImpsContactList *ioImpsContactListP, alp_postal_property_id_t iImpsContactListPropertyId, alp_postal_property_const_value_t iImpsContactListPropertyDataP, uint16_t iImpsContactListPropertyDataSize)
 Set a property to a Postal ImpsContactList.
alp_status_t alp_postal_imps_contact_list_update (alp_postal_session_id_t iSessionId, AlpPostalImpsContactList *iContactListP, AlpPostalImpsContactListUpdateAsyncReplyCallback iCallbackFuncP)
 Update a contactList in the indicated session.

Define Documentation

#define ALP_POSTAL_IMPS_PROPERTY_CONTACT_LIST_DEFAULT   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_CONTACT_LIST, ALP_POSTAL_PROPERTY_TYPE_BOOLEAN, 3)
 

list default.

#define ALP_POSTAL_IMPS_PROPERTY_CONTACT_LIST_ID   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_CONTACT_LIST, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 1)
 

listId.

#define ALP_POSTAL_IMPS_PROPERTY_CONTACT_LIST_NAME   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_CONTACT_LIST, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 2)
 

list name.

Typedef Documentation

typedef alp_postal_object_id_t alp_postal_imps_contact_list_id_t
 

Contact List identifier type.

typedef void(* AlpPostalImpsContactListCreateAsyncReplyCallback)(alp_postal_session_id_t iSessionId, AlpPostalImpsContactList *iContactListP, alp_status_t iRequestResult)
 

Postal Imps Async CreateList Callback.

typedef void(* AlpPostalImpsContactListDeleteAsyncReplyCallback)(alp_postal_session_id_t iSessionId, alp_postal_imps_contact_list_char_t iContactListWVId, alp_status_t iRequestResult)
 

Postal Imps Async DeleteList Callback.

typedef void(* AlpPostalImpsContactListUpdateAsyncReplyCallback)(alp_postal_session_id_t iSessionId, AlpPostalImpsContactList *iContactListP, alp_status_t iRequestResult)
 

Postal Imps Async UpdateList Callback.

Function Documentation

alp_status_t alp_postal_imps_contact_list_cancel_create (  alp_postal_session_id_t  iSessionId  ) 
 

Cancel the create_contact_list request.

Parameters:
[in] iSessionId The session Id on which the request must be cancelled.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_contact_list_cancel_delete (  alp_postal_session_id_t  iSessionId  ) 
 

Cancel the delete_contact_list request.

Parameters:
[in] iSessionId The session Id on which the request must be cancelled.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_contact_list_cancel_update (  alp_postal_session_id_t  iSessionId  ) 
 

Cancel the update_contact_list request.

Parameters:
[in] iSessionId The session Id on which the request must be cancelled.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_contact_list_create (  alp_postal_session_id_t  iSessionId,
AlpPostalImpsContactList *  iContactListP,
AlpPostalImpsNickList *  iNickList,
AlpPostalImpsContactListCreateAsyncReplyCallback  iCallbackFuncP
) 
 

Create a new contactList in the indicated session.

Parameters:
[in] iSessionId The session Id to work on.
[in] iContactListP A contactList filled with its informations. MUST contains CONTACT_LIST_NAME.
[in] iNickList A list of contact that will be add to the new contact list. May be NULL.
[in] iCallbackFuncP The call back function to be called when process will terminate.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_contact_list_delete (  alp_postal_session_id_t  iSessionId,
alp_postal_imps_contact_list_char_t  iContactListID,
AlpPostalImpsContactListDeleteAsyncReplyCallback  iCallbackFuncP
) 
 

Delete a contactList in the indicated session.

Parameters:
[in] iSessionId The session Id to work on.
[in] iContactListID The WV contact list identifier.
[in] iCallbackFuncP The call back function to be called when process will terminate.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_contact_list_free (  AlpPostalImpsContactList *  iContactListP  ) 
 

Free a ContactList.

Parameters:
[in] iContactListP A contact list structure.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_contact_list_free_property (  AlpPostalProperty *  iImpsContactListPropertyP  ) 
 

Free a retrieved contactList property.

Parameters:
[in] iImpsContactListPropertyP a pointer on a retrieved contactList property to be freed.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_contact_list_get (  alp_postal_account_id_t  iAccountId,
alp_postal_imps_contact_list_char_t  iContactListWvId,
AlpPostalImpsContactList *  oImpsContactListP
) 
 

Get a stored contactList.

Parameters:
[in] iAccountId 
[in] iContactListWvId The WV unique contactList identifer.
[out] oImpsContactListP The contactList properties to be retrieved.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_contact_list_get_property (  AlpPostalImpsContactList *  iImpsContactListP,
alp_postal_property_id_t  iPropertyId,
AlpPostalProperty **  oImpsContactListPropertyP
) 
 

Get a property from a contactList.

Parameters:
[in] iImpsContactListP A contactList Ptr.
[in] iPropertyId A Property ID.
[in,out] oImpsContactListPropertyP A contactList property to retrieve.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_contact_list_init (  AlpPostalImpsContactList *  iImpsContactListP  ) 
 

Initialize an ImpsContactList. MUST be called before used.

Parameters:
[in] iImpsContactListP A contactList to initialize.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_contact_list_set_property (  AlpPostalImpsContactList *  ioImpsContactListP,
alp_postal_property_id_t  iImpsContactListPropertyId,
alp_postal_property_const_value_t  iImpsContactListPropertyDataP,
uint16_t  iImpsContactListPropertyDataSize
) 
 

Set a property to a Postal ImpsContactList.

Parameters:
[in,out] ioImpsContactListP The Postal ImpsContactList in which a property must be set.
[in] iImpsContactListPropertyId The Id of the property to be created.
[in] iImpsContactListPropertyDataP The value of the property to be created.
[in] iImpsContactListPropertyDataSize the size of the data, strlen+1 if it's a string
Returns:
Returns an error code.

alp_status_t alp_postal_imps_contact_list_update (  alp_postal_session_id_t  iSessionId,
AlpPostalImpsContactList *  iContactListP,
AlpPostalImpsContactListUpdateAsyncReplyCallback  iCallbackFuncP
) 
 

Update a contactList in the indicated session.

Parameters:
[in] iSessionId The session Id to work on.
[in] iContactListP A contactList filled with its informations. MUST at least contains CONTACT_LIST_ID.
[in] iCallbackFuncP The call back function to be called when process will terminate.
Returns:
Returns an error code.

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

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