Buddy
[IMPS]

Detailed Description

Buddy APIs.


Functions

alp_status_t alp_postal_imps_buddy_free (AlpPostalImpsBuddy *iBuddyP)
 Free a Buddy.
alp_status_t alp_postal_imps_buddy_get (alp_postal_imps_buddy_id_t iBuddyId, AlpPostalImpsBuddy *oBuddy)
 Return the buddy according to its DB id.
alp_status_t alp_postal_imps_buddy_get_contact (AlpPostalImpsBuddy *iBuddyP, AlpPostalImpsContact *ioContactP)
 Return a reference to the contact associate to a buddy object.
alp_status_t alp_postal_imps_buddy_get_contact_list (AlpPostalImpsBuddy *iBuddyP, AlpPostalImpsContactList *ioContactListP)
 Return a reference to the contact_list associate to a buddy object.
alp_status_t alp_postal_imps_buddy_get_presence (AlpPostalImpsBuddy *iBuddyP, AlpPostalImpsPresence *ioPresenceP)
 Return a reference to the presence associate to a buddy object.

Function Documentation

alp_status_t alp_postal_imps_buddy_free (  AlpPostalImpsBuddy *  iBuddyP  ) 
 

Free a Buddy.

Parameters:
[in] iBuddyP A buddy structure.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_buddy_get (  alp_postal_imps_buddy_id_t  iBuddyId,
AlpPostalImpsBuddy *  oBuddy
) 
 

Return the buddy according to its DB id.

Parameters:
[in] iBuddyId buddy db id.
[out] oBuddy a buddy object. If the buddy belong to multiple contactList, the buddy contains no impsContactList info. If presenceInfo are not yet available, impsPresence is empty.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_buddy_get_contact (  AlpPostalImpsBuddy *  iBuddyP,
AlpPostalImpsContact *  ioContactP
) 
 

Return a reference to the contact associate to a buddy object.

Parameters:
[in] iBuddyP A buddy object.
[in,out] ioContactP a pointer to a valid non initialized impsContact object. If POSTAL_STATUS_OK is returned, iContactP will be a reference into iBuddyP but not a copy, so it MUST not be freed.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_buddy_get_contact_list (  AlpPostalImpsBuddy *  iBuddyP,
AlpPostalImpsContactList *  ioContactListP
) 
 

Return a reference to the contact_list associate to a buddy object.

Parameters:
[in] iBuddyP a buddy object.
[in,out] ioContactListP a pointer to a valid non initialized impsContactList object. This object MUST not be freed, it will be when the buddy will.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_buddy_get_presence (  AlpPostalImpsBuddy *  iBuddyP,
AlpPostalImpsPresence *  ioPresenceP
) 
 

Return a reference to the presence associate to a buddy object.

Parameters:
[in] iBuddyP a buddy object.
[in,out] ioPresenceP a pointer to a valid non initialized presence object. This object MUST not be freed, it will be when the buddy will.
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.