JML

net.sf.jml
Interface MsnContactList

All Known Implementing Classes:
MsnContactListImpl

public interface MsnContactList

Contact list. See http://www.hypothetic.org/docs/msn/notification/get_details.php "Background information" section.

Author:
Roger Chen

Method Summary
 MsnContact getContactByEmail(Email email)
          Get the contact in the contact list.
 MsnContact getContactById(String id)
          Get the contact in the contact list.
 MsnContact[] getContacts()
          Get the contacts in the contact list.
 MsnContact[] getContactsInList(MsnList list)
          Get the contacts in the MsnList.
 MsnGroup getDefaultGroup()
          Get the default group.
 MsnGroup getGroup(String groupId)
          Get the group in the contact list.
 MsnGroup[] getGroups()
          Get the groups in the contact list.
 MsnMessenger getMessenger()
          Get the MsnMessenger the contact list belongs to.
 String getVersion()
          Contact list version number.
 

Method Detail

getMessenger

MsnMessenger getMessenger()
Get the MsnMessenger the contact list belongs to.

Returns:
MsnMessenger

getVersion

String getVersion()
Contact list version number. If the version is the same as msn server contact list version, OutgoingSYN will not return the whole contact list.

Returns:
contact list version

getGroups

MsnGroup[] getGroups()
Get the groups in the contact list.

Returns:
groups in the contact list

getGroup

MsnGroup getGroup(String groupId)
Get the group in the contact list.

Parameters:
groupId - group id
Returns:
MsnGroup

getDefaultGroup

MsnGroup getDefaultGroup()
Get the default group.

Returns:
default group

getContacts

MsnContact[] getContacts()
Get the contacts in the contact list.

Returns:
the contacts in the contact list

getContactById

MsnContact getContactById(String id)
Get the contact in the contact list.

Parameters:
id - contact's id
Returns:
MsnContact

getContactByEmail

MsnContact getContactByEmail(Email email)
Get the contact in the contact list.

Parameters:
email - contact's email
Returns:
MsnContact

getContactsInList

MsnContact[] getContactsInList(MsnList list)
Get the contacts in the MsnList.

Parameters:
list - MsnList
Returns:
the contacts in the MsnList

JML