include/alp/postal_imps_contact.h File Reference


Detailed Description

Postal IMPS contact management APIs.

#include <alp/postal_types.h>
#include <alp/postal_imps_types.h>
#include <alp/postal_property.h>

Go to the source code of this file.

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.


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.