com.compoze.collab.yahoo
Interface IYahooSession

All Superinterfaces:

IImSession, ISession, java.io.Serializable

public interface IYahooSession

extends IImSession

Extends the IM schema's ImSession with additional instant messaging specific functionality.

Fields inherited from interface com.compoze.collab.im.IImSession

PROP_IM_PASSWORD, PROP_IM_PORT, PROP_IM_PROTOCOL, PROP_IM_SERVER, PROP_IM_USERNAME

Fields inherited from interface com.compoze.collab.ISession

PROP_ADMIN_LOCALE, PROP_AUTO_FETCH, PROP_LOCALE, PROP_LOG_LEVEL, PROP_PROGRAMMER_LOCALE, PROP_PROVIDER, PROP_SCHEMA, PROPVALUE_REMOVE, STATE_AUTHENTICATED, STATE_INITIALIZED, STATE_OPEN, STATE_UNINITIALIZED

Method Summary

void	setBackgroundPoll(boolean bBackgroundPoll) Sets the background poll option.
void	setCustomStatusBusy(boolean bBusy) Sets whether or not the custom status message represents a busy status.
void	setCustomStatusMessage(java.lang.String sMessage) Sets a custom status message for the user.

Methods inherited from interface com.compoze.collab.im.IImSession

addImListener, removeImListener, setPresence, setTypingStatus, setTypingStatus

Methods inherited from interface com.compoze.collab.ISession

addLogListener, close, endProfile, endTimer, endTimer, getAdminLocale, getAttribute, getDefaultRootContainer, getLocale, getLogLevel, getOption, getOptions, getProgrammerLocale, getProperty, getProvider, getState, isCapabilitySupported, log, login, login, logout, open, open, removeAttribute, setAdminLocale, setAttribute, setLocale, setLogLevel, setOption, setOptions, setProgrammerLocale, startProfile, startProfile, startTimer, startTimer

Method Detail

setBackgroundPoll

public void setBackgroundPoll(boolean bBackgroundPoll)
                       throws CollaborationException

Sets the background poll option. If background poll is true (the default), the API uses a background thread to continuously poll the Yahoo service for new messages and presence events. Otherwise, that poll happens for new messages when IContainer.getItems() is called on the messages container and for presence changes when it's called on the friends container.

Parameters:

bBackgroundPoll - if true, enable background polling

setCustomStatusMessage

public void setCustomStatusMessage(java.lang.String sMessage)
                            throws CollaborationException

Sets a custom status message for the user. Custom statuses are provider specific and defined in corresponding provider extensions to this FriendStatusEnum. The presence information is not actually updated in the IM system until IImSession.setPresence(com.compoze.collab.im.FriendStatus) is called.

Parameters:

sMessage - the custom status message (not null)

setCustomStatusBusy

public void setCustomStatusBusy(boolean bBusy)
                         throws CollaborationException

Sets whether or not the custom status message represents a busy status. Custom statuses are provider specific and defined in corresponding provider extensions to this FriendStatusEnum. The presence information is not actually updated in the IM system until IImSession.setPresence(com.compoze.collab.im.FriendStatus) is called.

Parameters:

bBusy - if true, then the custom message represents a busy status