Contact
[IMPS]

Detailed Description

Postal IMPS contact management APIs.


Defines

#define ALP_POSTAL_IMPS_PROPERTY_CONTACT_NICKNAME   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_CONTACT, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 2)
 nickName.
#define ALP_POSTAL_IMPS_PROPERTY_CONTACT_SCREENNAME   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_CONTACT, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 3)
 alias.
#define ALP_POSTAL_IMPS_PROPERTY_CONTACT_SERVICE   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_CONTACT, ALP_POSTAL_PROPERTY_TYPE_INT, 4)
 service (aol, msn, etc...) this information can not be provided by the the server but might be processed by the plugin.
#define ALP_POSTAL_IMPS_PROPERTY_CONTACT_USERID   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_CONTACT, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 1)
 userId.

Typedefs

typedef void(* AlpPostalImpsContactManageAsyncReplyCallback )(alp_postal_session_id_t iSessionId, alp_status_t iRequestResult)
 Postal Imps Async ManageContact Callback.
typedef void(* AlpPostalImpsContactMoveAsyncReplyCallback )(alp_postal_session_id_t iSessionId, alp_status_t iRequestResult)
 Postal Imps Async MoveContact Callback.

Functions

alp_status_t alp_postal_imps_contact_add_to_list (AlpPostalImpsNickList *iNickList, AlpPostalImpsContact *iContact)
 Add a contact to a NickList.
alp_status_t alp_postal_imps_contact_cancel_manage (alp_postal_session_id_t iSessionId)
 Cancel the manage_contact request.
alp_status_t alp_postal_imps_contact_cancel_move (alp_postal_session_id_t iSessionId)
 Cancel the contact_move request.
alp_status_t alp_postal_imps_contact_free (AlpPostalImpsContact *iContactP)
 Free a Contact.
alp_status_t alp_postal_imps_contact_free_nick_list (AlpPostalImpsNickList *iImpsNickList)
 Free a NickList. Also free the contacts that belong to it.
alp_status_t alp_postal_imps_contact_free_property (AlpPostalProperty *iImpsContactPropertyP)
 Free a retrieved contact property.
alp_status_t alp_postal_imps_contact_get_property (AlpPostalImpsContact *iImpsContactP, alp_postal_property_id_t iPropertyId, AlpPostalProperty **oImpsContactPropertyP)
 Get a property from a Contact.
alp_status_t alp_postal_imps_contact_init (AlpPostalImpsContact *iImpsContactP)
 Initialize an ImpsContact. MUST be called before used.
alp_status_t alp_postal_imps_contact_init_nick_list (AlpPostalImpsNickList *iImpsNickList)
 Initialize a NickList. MUST be called before used.
alp_status_t alp_postal_imps_contact_manage (alp_postal_session_id_t iSessionId, alp_postal_imps_contact_list_char_t iContactListID, AlpPostalImpsNickList *iNickList, alp_postal_imps_contact_manage_op_t iOperationType, AlpPostalImpsContactManageAsyncReplyCallback iCallbackFuncP)
 Manage (add/remove) contact in the indicated session.
alp_status_t alp_postal_imps_contact_move (alp_postal_session_id_t iSessionId, char *iFromContactListID, char *iToContactListID, char *iUserID, char *iNickName, AlpPostalImpsContactMoveAsyncReplyCallback iCallbackFuncP)
 Move a contact from a contact list to another in the indicated session.
alp_status_t alp_postal_imps_contact_set_property (AlpPostalImpsContact *ioImpsContactP, alp_postal_property_id_t iImpsContactPropertyId, alp_postal_property_const_value_t iImpsContactPropertyDataP, uint16_t iImpsContactPropertyDataSize)
 Set a property to a Postal ImpsContact.

Define Documentation

#define ALP_POSTAL_IMPS_PROPERTY_CONTACT_NICKNAME   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_CONTACT, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 2)
 

nickName.

#define ALP_POSTAL_IMPS_PROPERTY_CONTACT_SCREENNAME   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_CONTACT, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 3)
 

alias.

#define ALP_POSTAL_IMPS_PROPERTY_CONTACT_SERVICE   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_CONTACT, ALP_POSTAL_PROPERTY_TYPE_INT, 4)
 

service (aol, msn, etc...) this information can not be provided by the the server but might be processed by the plugin.

#define ALP_POSTAL_IMPS_PROPERTY_CONTACT_USERID   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_CONTACT, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 1)
 

userId.

Typedef Documentation

typedef void(* AlpPostalImpsContactManageAsyncReplyCallback)(alp_postal_session_id_t iSessionId, alp_status_t iRequestResult)
 

Postal Imps Async ManageContact Callback.

typedef void(* AlpPostalImpsContactMoveAsyncReplyCallback)(alp_postal_session_id_t iSessionId, alp_status_t iRequestResult)
 

Postal Imps Async MoveContact Callback.

Function Documentation

alp_status_t alp_postal_imps_contact_add_to_list (  AlpPostalImpsNickList *  iNickList,
AlpPostalImpsContact *  iContact
) 
 

Add a contact to a NickList.

Parameters:
[in] iNickList A NickList to complete.
[in] iContact A Contact.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_contact_cancel_manage (  alp_postal_session_id_t  iSessionId  ) 
 

Cancel the manage_contact 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_cancel_move (  alp_postal_session_id_t  iSessionId  ) 
 

Cancel the contact_move 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_free (  AlpPostalImpsContact *  iContactP  ) 
 

Free a Contact.

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

alp_status_t alp_postal_imps_contact_free_nick_list (  AlpPostalImpsNickList *  iImpsNickList  ) 
 

Free a NickList. Also free the contacts that belong to it.

Parameters:
[in] iImpsNickList A NickList to free.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_contact_free_property (  AlpPostalProperty *  iImpsContactPropertyP  ) 
 

Free a retrieved contact property.

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

alp_status_t alp_postal_imps_contact_get_property (  AlpPostalImpsContact *  iImpsContactP,
alp_postal_property_id_t  iPropertyId,
AlpPostalProperty **  oImpsContactPropertyP
) 
 

Get a property from a Contact.

Parameters:
[in] iImpsContactP A contact Ptr.
[in] iPropertyId A Property ID.
[out] oImpsContactPropertyP A contact property to retrieve.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_contact_init (  AlpPostalImpsContact *  iImpsContactP  ) 
 

Initialize an ImpsContact. MUST be called before used.

Parameters:
[in] iImpsContactP A contact to initialize.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_contact_init_nick_list (  AlpPostalImpsNickList *  iImpsNickList  ) 
 

Initialize a NickList. MUST be called before used.

Parameters:
[in] iImpsNickList A NickList to initialize.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_contact_manage (  alp_postal_session_id_t  iSessionId,
alp_postal_imps_contact_list_char_t  iContactListID,
AlpPostalImpsNickList *  iNickList,
alp_postal_imps_contact_manage_op_t  iOperationType,
AlpPostalImpsContactManageAsyncReplyCallback  iCallbackFuncP
) 
 

Manage (add/remove) contact in the indicated session.

Parameters:
[in] iSessionId The session Id to work on.
[in] iContactListID the WV contactList ID to work on.
[in] iNickList a list of contact to add or remove depending to iOperationType.
[in] iOperationType add (IMPS_CONTACT_MANAGE_ADD) or remove (IMPS_CONTACT_MANAGE_REMOVE) the iNickList.
[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_move (  alp_postal_session_id_t  iSessionId,
char *  iFromContactListID,
char *  iToContactListID,
char *  iUserID,
char *  iNickName,
AlpPostalImpsContactMoveAsyncReplyCallback  iCallbackFuncP
) 
 

Move a contact from a contact list to another in the indicated session.

Parameters:
[in] iSessionId The session Id to work on.
[in] iFromContactListID the WV contactList ID where iUserID belong.
[in] iToContactListID the WV contactList ID where iUserID will belong after opearation.
[in] iUserID the user id to move.
[in] iNickName the nickName that will be associated with this userId.
[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_set_property (  AlpPostalImpsContact *  ioImpsContactP,
alp_postal_property_id_t  iImpsContactPropertyId,
alp_postal_property_const_value_t  iImpsContactPropertyDataP,
uint16_t  iImpsContactPropertyDataSize
) 
 

Set a property to a Postal ImpsContact.

Parameters:
[in,out] ioImpsContactP The Postal ImpsContact in which a property must be set.
[in] iImpsContactPropertyId The Id of the property to be created.
[in] iImpsContactPropertyDataP The value of the property to be created.
[in] iImpsContactPropertyDataSize the size of the data, strlen+1 if it's a string
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.