blueme.messenger.interfaces
Interface iKernel_GUI

All Known Implementing Classes:

Kernel

public interface iKernel_GUI

Method Summary

boolean	addUser(iUserList userList) Notify Kernel that the defined user is to be added to the buddy list.
boolean	changeUnread(iMSG msg, boolean flag) Changes the read / unread flag of defined message.
boolean	deleteAllMessages(iUserList userList) Deletes all messages associated with the defined iUserList object.
boolean	deleteMessage(iMSG msg) Will delete defined message.
boolean	deleteUser(iUserList userList) Deletes the user associated with the iUserList object.
iConfig	getConfig() Used to get last saved configuration data.
iMSG[]	getMessages(iUserList userList) Used to get all messages associated with defined iUserList object.
iUserData	getUserData() Used to get last saved user data.
iUserList[]	getUserList() Used to get last saved buddy list.
int	sendNewMessage(iMSG msg) Used for sending new messages.
boolean	setConfig(iConfig config) Used to store the configuration data defined in the argument.
boolean	setUserData(iUserData userData) Used to store the user data defined in the argument.

Method Detail

setUserData

boolean setUserData(iUserData userData)

Used to store the user data defined in the argument. Returns “true” if the data was saved, “false” otherwise.

getUserData

iUserData getUserData()

Used to get last saved user data. Returns a fresh iUserData object if there are no user data available.

setConfig

boolean setConfig(iConfig config)

Used to store the configuration data defined in the argument. Returns "true" if the data was saved, "false" otherwise.

getConfig

iConfig getConfig()

Used to get last saved configuration data. Returns a fresh iConfig object if there are no configuration data available.

getUserList

iUserList[] getUserList()

Used to get last saved buddy list. Returns an array of iUserList objects. No sorting order defined, and if there are no users on the list, an array of length 0 is returns.

getMessages

iMSG[] getMessages(iUserList userList)

Used to get all messages associated with defined iUserList object. If no messages are associated with that user, an array of length 0 is returned. If more than one message is returned, messages are sorted by oldest first.

sendNewMessage

int sendNewMessage(iMSG msg)

Used for sending new messages. Method will return a integer defining how the method preformed. The number returned may be one of the following: 0: Messages sent successfully 1: Message could not be sent due to communication problems or problems at the server side 2: Message could not be sent due to access restrictions. This will happen if for instance the sender is out of free messages

deleteAllMessages

boolean deleteAllMessages(iUserList userList)

Deletes all messages associated with the defined iUserList object. Returns “true” if all messages was deleted. It will also return “true” even if there were no messages to delete. Will return “false” if there were some internal problems.

deleteMessage

boolean deleteMessage(iMSG msg)

Will delete defined message. Returns "true" if defined message was deleted, "false" if defined message could not be found or there were some internal problems.

addUser

boolean addUser(iUserList userList)

Notify Kernel that the defined user is to be added to the buddy list. Returns “true” if the user could be added, “false” otherwise. Will also return “true” is the user is already present on the buddy list.

deleteUser

boolean deleteUser(iUserList userList)

Deletes the user associated with the iUserList object. Returns “true” of the user was removed, “false” otherwise. This method will also delete all other information associated with this user, like for instance messages and matching profiles.

changeUnread

boolean changeUnread(iMSG msg,
                     boolean flag)

Changes the read / unread flag of defined message. Method will return “true” of the flag could be changed, “false” otherwise.